| 021685a606bcb5dca28685f6f6004805482cf657 |
|
23-Apr-2017 |
Jeff Sharkey <jsharkey@android.com> |
New "lint" errors, split Android-specific logic.
We really encounter three classes of trouble: errors, warnings, and
lints. See added docs about the differences between them. Colorize
trouble output to make it easier to triage.
Since both auxiliary tags and linting are project-specific, factor
out the Android-specific versions of these, and only put them into
place when the "-android" argument is requested.
Add linting logic to identify possible docs trouble, such as
missing or misleading annotations.
Test: make -j32 offline-sdk-docs
Bug: 37526420
Change-Id: Id8b5b4e143f206e959ecde4655e877ee7723e3cd
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| 46fcac9c47b14e2199465960aab9f2f47e5e9737 |
|
21-Apr-2017 |
Jeff Sharkey <jsharkey@android.com> |
Look for SuppressAutoDoc in more places.
It can appear on parameters, members, or classes.
Test: builds
Bug: 37526420
Change-Id: Ib390fb2af3cfdf2904c140b6aa69f0453230bea3
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| d85b5c88af45b60592e816029c316ec29a3af43d |
|
20-Apr-2017 |
Jeff Sharkey <jsharkey@android.com> |
Auto-generate docs based on annotations.
We have a handful of annotations that we've been sprinkling across
the platform APIs, such as @Nullable, @NonNull, @IntDef, etc. It
would be really helpful to surface these contracts to developers
through the SDK docs.
This change allows annotations like those mentioned above to declare
the following new javadoc fields:
@memberDoc: docs to append to a field or method definition.
@paramDoc: docs to append to a @param definition.
@returnDoc: docs to append to a @return definition.
This change also builds a docstring to describe the list of all
constants listed in an @IntDef annotation. Sadly AnnotationDesc
only passes along raw constant values, so we need the help of the
new "prefix" annotation argument to help find the field names.
Test: builds
Bug: 37526420
Change-Id: I2268f045decd5b131e25517debf96859a856b247
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| d894e7de44cda4d042358f10681d2d170c021ec4 |
|
24-Nov-2016 |
Przemyslaw Szczepaniak <pszczepaniak@google.com> |
Suppress deprecation warning for classes from jar files
Classes from jar files that had their comments stripped
may erroneously trigger the deprecation warning because
of missing "@deprecated" doc tag. This change
makes the deprecation warning require that containing
class be in "included" set (this implies not originating
from a classpath jar file).
Test: make -j docs, tested it works with a synthetic
@deprecated javadoc/annotation mismatch
Bug: 32651845
Change-Id: I5db5c509d4c0015ee950a4f093af03c384baed4b
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| a7e5c7e9b5250e738ff36521c03f6a3b76bc1c08 |
|
08-May-2015 |
C. Sean Young <csyoung@google.com> |
Make CheckApi error messages more consisent and informative.
Make CheckApi error messages involving methods print out signature rather than just qualified name.
Previously, only constructor related additions and removals did this.
This made it difficult to tell which overload of a method had an API change.
Updates constructor related messages to use the fully qualified name of the class.
Also makes deprecation status change messages consistent (fields and classes now show before and after,
in addition to methods).
Change-Id: I83f06e96bf20e234fcc432ebec8d0b8ae04a22d2
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| 4e67d82e0697805122796afec21f46e544eb309c |
|
11-Sep-2014 |
Jeff Arneson <jarneson@google.com> |
Export showAnnotations on fields to HDF
Change-Id: I6cb0f02b6b1ff61aa845d1cb1a8d040a7ddea191
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| 43d2ac8017a651b5678c8a9753248663d8bfe9a7 |
|
01-Apr-2013 |
Jeff Brown <jeffbrown@google.com> |
apicheck: Allow safe addition and removal of final qualifier.
Split the CHANGED_FINAL error into ADDED_FINAL,
ADDED_FINAL_UNINSTANTIABLE and REMOVED_FINAL so that the
API check scripts can more precisely target policy around
changes to the final qualifier.
ADDED_FINAL_UNINSTANTIABLE covers the case of a class
that has become final but that was previously not
instantiable. This change is safe since applications could
not have declared subclasses of their own.
Change-Id: I36a143bdbcffd04379788a55ff996b47398ba4fe
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| 40ad14799644f497483efe6d1350c856d46bc4da |
|
25-Oct-2012 |
Scott Main <smain@google.com> |
cherrypick Change-Id: Ic7cc0864518fef95b106ab3d392c47eb225404bf
Add HDF meta-data for the version in which an API was deprecated
Change-Id: Iadaceb6d61d2fbc75d219295da2d8d7b52bd2eeb
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| d6eaacbb9eb56763d38a3815fc509b92ed98a585 |
|
20-May-2011 |
Andrew Sapperstein <asapperstein@google.com> |
Modified old doclava to use LinkedLists instead of arrays
Functioning java parsing as well. Needs to be wired up into doclava proper.
Change-Id: Ifa38ca7312e6c23a8f663a9d0638afb9a29bf19d
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| 040992567205c3b6e4ee01bfb2893bceb915357c |
|
09-Mar-2011 |
Joe Onorato <joeo@google.com> |
Add support for new API file format.
Change-Id: I7db4d1559d24906365f447652d28c4b04a20805d
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| 62aaca829e5b443a3c1345c54c44293587929dd4 |
|
29-Nov-2010 |
Dan Bornstein <danfuzz@android.com> |
(static && final) isn't necessarily constant.
Change doclava to only recognize constants when they have a
constant value. See the comment in the change in re the possible
ambiguity.
Change-Id: I7453cadddd4ad72b28b71f06147658a41fe6abc3
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| f22ba05c19de46e546ce9ae4783ac43e220e0425 |
|
12-Aug-2010 |
Ben Dodson <bjdodson@google.com> |
Canonicalize floating points to work around JVM issues
Change-Id: I4ac2ebd2ccd98b6bd00439c3f40016a15fdc6573
/external/doclava/src/com/google/doclava/FieldInfo.java
|
| 920dbbbaca6aa578f3b26d89e99d12754c26ed60 |
|
05-Aug-2010 |
Ben Dodson <bjdodson@google.com> |
Initial import of Doclava project
Change-Id: Ia5ae56f1700fce98e0ae6954fa2df617ec0537bb
/external/doclava/src/com/google/doclava/FieldInfo.java
|