From 44ad7ce30a46b07c97512b9903ef049ce2b04413 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Thu, 2 Apr 2015 14:51:59 +0200 Subject: [PATCH] Update doc on using @api annotation --- config/jsdoc/api/readme.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/config/jsdoc/api/readme.md b/config/jsdoc/api/readme.md index 96bedc768b..a7e34c7763 100644 --- a/config/jsdoc/api/readme.md +++ b/config/jsdoc/api/readme.md @@ -24,6 +24,8 @@ The second line tells the Closure compiler the type of the argument. The third line (`@api`) marks the method as part of the api and thus exportable. The stability can be added as value, e.g. `@api stable`. Without such an api annotation, the method will not be documented in the generated API documentation. Symbols without an api annotation will also not be exportable (unless they are explicitly exported with a `goog.exportProperty` call). +The `@api` annotation can be used in conjunciton with the `@inheritDoc` annotation to export a symbol that is documented on a parent class (where the method may be abstract). In general, `@api` annotations should never be used on abstract methods (only on their implementations). + ### Events Events are documented using `@fires` and `@event` annotations: