| 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/Comment.java
|
| 46df1b7bd92a1debbbc670450f17967f74c92d13 |
|
17-Nov-2016 |
Scott Main <smain@google.com> |
Add support for MathJax in javadocs
bug: 32935028
Change-Id: I675939677192231200408c4f2379536cae0af4ad
/external/doclava/src/com/google/doclava/Comment.java
|
| 9ae975bee1e3c1669ccddc55be76daf3f355addd |
|
16-Aug-2016 |
Dirk Dougherty <ddougherty@google.com> |
Support new static-only docs build which ignores @link resolution.
Change-Id: I86da80d8d901d0c860a86d30ea171f04406a2d1e
/external/doclava/src/com/google/doclava/Comment.java
|
| 7d039da9a6719a70b2529a92bc89561b92f9588f |
|
02-Mar-2016 |
Neil Fuller <nfuller@google.com> |
Add support for @implSpec and @implNote
Bug: 26814204
Change-Id: I04e7c5845b65427e1c6a5183e73e42a4b654bf36
/external/doclava/src/com/google/doclava/Comment.java
|
| e9e7bffbffc045104401076d2b3cf2fdef606f89 |
|
19-Jan-2016 |
Neil Fuller <nfuller@google.com> |
Support for @apiNote
This could also be used to add support for various other
missing block tags found in OpenJDK code.
e.g.
@since, @revised, @serialData, @author, @spec, @jls
Bug: 26624532
Change-Id: I0bb0896fcba176cbc2bdf469981ce0a80ba4e348
/external/doclava/src/com/google/doclava/Comment.java
|
| c90e5c8e016075c3d1b8b0994aa315d2ce958016 |
|
27-Nov-2015 |
Neil Fuller <nfuller@google.com> |
Keep track of braces {} in @code comments
This makes doclava more compatible with javadoc, though
it retains some differences around escaping for the moment.
This is related to a change in Javadoc behavior in JDK 5, most
likely http://bugs.java.com/bugdatabase/view_bug.do?bug_id=4965490
Bug: 25757239
Change-Id: I2b4ba4dbad520a1a3e00f394e1fac4b8d67b3fbf
/external/doclava/src/com/google/doclava/Comment.java
|
| 59aecf8bd971934daca691d9951f338835f6c993 |
|
06-Jun-2015 |
Svetoslav <svetoslavganov@google.com> |
Fix broken handling of @removed tag
Change-Id: I735dcc97ea6c0a5ee14cd8e94a1776197876881a
/external/doclava/src/com/google/doclava/Comment.java
|
| da4b2e21af0d8efcfe73ff060839c97a2d4b8b03 |
|
18-May-2015 |
C. Sean Young <csyoung@google.com> |
Save memory by re-using empty TagInfo (and subclasses) arrays.
Arrays of TagInfo (and subclasses) often tend to be empty, as many
members simply won't have any of the relevant tags.
Re-using empty arrays saves potentially a dozen or more megabytes
for large projects.
Also some minor performance tweaks the Javadoc comment parsing.
Change-Id: Iffaddd3b59a4f8183f11efd6e2680aad95633ade
/external/doclava/src/com/google/doclava/Comment.java
|
| 92393f10b7c1922425d8c4c77df5dd35a6d145ed |
|
05-Jan-2015 |
Jeff Arneson <jarneson@google.com> |
Render @linkplain links in regular font rather than code font
BUG: 18499941
Change-Id: Ic53fc04ddfff2a5fbf83bc8eb68b423f9e68eded
/external/doclava/src/com/google/doclava/Comment.java
|
| 5118ffe3bf77ec4efa070f36a7a62fd5d1bf16bf |
|
18-Feb-2014 |
Hui Shu <hush@google.com> |
Add support for @removed tag.
@removed tags can be applied to packages, classes, methods, fields
that were once public API, but later removed. Things annotated by
@removed cannot be used by outside developers. But applications compiled
against the old API where the @removed API were still public should
continue to work and we must not delete the @removed APIs from the
source. This fix makes sure of that.
BUG: b/11293324
Change-Id: Iab3a8bdcaa0cb0742501c33e29b8121bc169bf1b
/external/doclava/src/com/google/doclava/Comment.java
|
| 4ec568b934dab55eca62a72e4b1ed48924f87460 |
|
01-Dec-2012 |
Scott Main <smain@google.com> |
more fixing for tags: provide proper links for @value tags.
Change-Id: I5f90baf6f774b1c297e4833c98633cc6f675de30
/external/doclava/src/com/google/doclava/Comment.java
|
| f19066f11fc29bb0c6f3b3044c7ecf21fc47f62d |
|
01-Dec-2012 |
Scott Main <smain@google.com> |
fix build
Change-Id: Ie236aaf6236ca2e5b8ed9c6756d3e95c8e8e9060
/external/doclava/src/com/google/doclava/Comment.java
|
| 99e4ebe5b938186f02d1deb0d46ac0e72db2e0b2 |
|
01-Dec-2012 |
Scott Main <smain@google.com> |
further support for @value tag to print fully qualified name
Change-Id: If8561cd174b89eacf8928c3bd0665b6502c29e5b
/external/doclava/src/com/google/doclava/Comment.java
|
| e94aecfe57368dd3df62be49d08d6a5684cf929f |
|
01-Dec-2012 |
Scott Main <smain@google.com> |
add support for @value tag
Change-Id: Ie2f747dff3642e22b12b9d68439d2a262fc159c7
/external/doclava/src/com/google/doclava/Comment.java
|
| f959ed158599686910af990654d6c84d262868ff |
|
23-Jun-2011 |
Andrew Sapperstein <asapperstein@google.com> |
Rewrote comment parsing to be much faster.
Now uses plain string parsing rather than regex to parse
the comments. Timing is both more accurate and lower
by about 40 percent on my machine.
Change-Id: I73a0bac3c49571dcb71b499b738966cde27c1c29
/external/doclava/src/com/google/doclava/Comment.java
|
| 7a6456cec94b5d3107f36b61e9c9f303c68e9392 |
|
16-Sep-2010 |
Joe Onorato <joeo@google.com> |
Add a -knowntags option to doclava.
Change-Id: I1d2dae84d26084d92ca297eb2c0fc0b3d8afa76a
/external/doclava/src/com/google/doclava/Comment.java
|
| 9ccd9e3a9df835dc134e7edd2e4236220aed401e |
|
07-Aug-2010 |
Ben Dodson <bjdodson@google.com> |
Added script to sync from svn
Change-Id: I23f41841e853764523dc414996128d65b16eefb6
/external/doclava/src/com/google/doclava/Comment.java
|
| 920dbbbaca6aa578f3b26d89e99d12754c26ed60 |
|
05-Aug-2010 |
Ben Dodson <bjdodson@google.com> |
Initial import of Doclava project
Change-Id: Ia5ae56f1700fce98e0ae6954fa2df617ec0537bb
/external/doclava/src/com/google/doclava/Comment.java
|