diff options
author | Android Partner Docs <noreply@android.com> | 2018-05-22 12:01:47 -0700 |
---|---|---|
committer | Clay Murphy <claym@google.com> | 2018-05-22 15:00:17 -0700 |
commit | 4d251019ee1b9845580c3d916655c93400222be7 (patch) | |
tree | e4bd67b07d48efad341ecb4dc83a7223184a2c98 /en/devices/architecture | |
parent | 3c0356087cc57a0a4090de49b27374655b64fe7a (diff) | |
download | source.android.com-4d251019ee1b9845580c3d916655c93400222be7.tar.gz |
Docs: Changes to source.android.com
- 197600621 Devsite localized content from translation request 873033... by Android Partner Docs <noreply@android.com>
- 197596066 Update Support Library -> AndroidX (Support Library) by Christina Nguyen <cqn@google.com>
- 197586819 HIDL: clarify documentation about documentation comments by Android Partner Docs <noreply@android.com>
- 197579595 Devsite localized content from translation request 415584... by Android Partner Docs <noreply@android.com>
- 197576890 Publish April and May Security/ Pixel bulletins by Danielle Roberts <daroberts@google.com>
- 197559095 Update camera doc content by Kenneth Lau <kennethlau@google.com>
- 197559031 Revise content to refer to HIDL interface by Kenneth Lau <kennethlau@google.com>
- 197558968 Update camera images by Kenneth Lau <kennethlau@google.com>
- 197492822 Devsite localized content from translation request 3347f0... by Android Partner Docs <noreply@android.com>
- 197423991 Devsite localized content from translation request 35d612... by Android Partner Docs <noreply@android.com>
- 197423968 Devsite localized content from translation request 845f73... by Android Partner Docs <noreply@android.com>
- 197423953 Devsite localized content from translation request 415584... by Android Partner Docs <noreply@android.com>
- 197423874 Devsite localized content from translation request 0a49fc... by Android Partner Docs <noreply@android.com>
- 197423857 Devsite localized content from translation request c007e9... by Android Partner Docs <noreply@android.com>
- 197423850 Devsite localized content from translation request 99ab33... by Android Partner Docs <noreply@android.com>
- 197198470 Added CVE-2017-0740 to the Acknowledgements page. by Android Partner Docs <noreply@android.com>
- 197180447 Replace KMSG with ramoops by Clay Murphy <claym@google.com>
- 197056364 Improve readability of content by Kenneth Lau <kennethlau@google.com>
- 197029559 Devsite localized content from translation request e1b1c4... by Android Partner Docs <noreply@android.com>
- 197029538 Devsite localized content from translation request 697929... by Android Partner Docs <noreply@android.com>
- 196891796 Add Nokia to the bulletin index page by Danielle Roberts <daroberts@google.com>
- 196847852 Update CTS/CTS-Verifier downloads for CTS-May-2018 Releases by Android Partner Docs <noreply@android.com>
- 196763369 Fix silly image path error by Clay Murphy <claym@google.com>
- 196737640 Add blogs list to community page by Danielle Roberts <daroberts@google.com>
- 196728891 Remove all non-test _freeze.yaml files. These are no long... by Android Partner Docs <noreply@android.com>
- 196702405 Add initial bootloader docs by Clay Murphy <claym@google.com>
- 196680338 Devsite localized content from translation request 54cf9d... by Android Partner Docs <noreply@android.com>
PiperOrigin-RevId: 197600621
Change-Id: Ie86e9b753b488ba9af0f78fd6fcc577425ab3b94
Diffstat (limited to 'en/devices/architecture')
-rw-r--r-- | en/devices/architecture/hidl/code-style.html | 19 | ||||
-rw-r--r-- | en/devices/architecture/hidl/index.html | 3 |
2 files changed, 15 insertions, 7 deletions
diff --git a/en/devices/architecture/hidl/code-style.html b/en/devices/architecture/hidl/code-style.html index 0746ff36..5f787d71 100644 --- a/en/devices/architecture/hidl/code-style.html +++ b/en/devices/architecture/hidl/code-style.html @@ -374,14 +374,21 @@ fine.</p> <li>TODOs</li> </ul> </li> -<li>Use <code>/** */</code> mainly for Function documents/"docstrings" used for -generated documentation. Example: +<li>Use <code>/** */</code> for generated documentation. These can be applied +only to type, method, field, and enum value declarations. Example: <pre class="prettyprint"> /** Replied status */ -enum FooStatus { - OK = 0, // no error - ERR_TRANSPORT = 1, // transport level error - ERR_ARG = 2 // invalid args +enum TeleportStatus { + /** Object entirely teleported. */ + OK = 0, + /** Methods return this if teleportation is not completed. */ + ERROR_TELEPORT = 1, + /** + * Teleportation could not be completed due to an object + * obstructing the path. + */ + ERROR_OBJECT = 2, + ... } </pre> <li>Multi-line comments should start a new line with <code>/**</code>, use diff --git a/en/devices/architecture/hidl/index.html b/en/devices/architecture/hidl/index.html index 5790b78c..35b166dd 100644 --- a/en/devices/architecture/hidl/index.html +++ b/en/devices/architecture/hidl/index.html @@ -135,7 +135,8 @@ of <code>=</code> and <code>|</code>) is part of the grammar.</p> <a href="code-style.html">Code Style Guide</a>.</p> <ul> -<li><code>/** */</code> indicates a documentation comment.</li> +<li><code>/** */</code> indicates a documentation comment. These can be applied +only to type, method, field, and enum value declarations.</li> <li><code>/* */</code> indicates a multiline comment.</li> <li><code>//</code> indicates a comment to end of line. Aside from <code>//</code>, newlines are the same as any other whitespace. </li> |