WIP: Add minimal description for missing Scaladoc tags

janekdb · janekdb · commit a6b688c73042 · 2016-05-02T22:08:30.000+01:00
Added a minimal description for, - @contentDiagram - @documentable
diff --git a/overviews/scaladoc/for-library-authors.md b/overviews/scaladoc/for-library-authors.md
@@ -89,6 +89,22 @@ include:
   definition is too complex or noisy. An example is (in the collections API),
   providing documentation for methods that omit the implicit `canBuildFrom`.
 
+
+### Member grouping tags
+- `@group` - TODO
+- `@groupname` - TODO
+- `@groupdesc` - TODO
+- `@groupprio` - TODO
+
+
+### Diagram tags
+- `@contentDiagram` - use with traits and classes to include a content hierarchy diagram showing included types.
+   The diagram content can be fine tuned with additional specifiers taken from `hideNodes`, `hideOutgoingImplicits`,
+   `hideSubclasses`, `hideEdges`, `hideIncomingImplicits`, `hideSuperclasses` and `hideInheritedNode`.
+   `hideDiagram` can be supplied to prevent a diagram from being created if it would be created by default. Packages
+   and objects have content diagrams by default.
+- `@inheritanceDiagram` - TODO
+
 ### Other tags
 - `@author` provide author information for the following entity
 - `@version` the version of the system or API that this entity is a part of.
@@ -103,6 +119,7 @@ include:
   ahead of deprecation. Same fields as `@deprecated`.
 - `@inheritdoc` take comments from a superclass as defaults if comments are not
   provided locally.
+- `@documentable` Expand a type alias and abstract type into a full template page. - TODO: Test the "abstract type" claim - no examples of this in the Scala code base
 
 
 ### Macros
@@ -111,6 +128,10 @@ include:
   `<definition>`.
 
 
+### 2.12 tags - TODO: Move these into the above groups with a 2.12 note
+- `@shortDescription` ???
+- `@hideImplicitConversion` ???
+
 ## Comment Inheritance
 
 ### Implicit
