Merge pull request #3687 from AdiChat/javaDoc

New JavaDoc cheat sheet

share/goodie/cheat_sheets/json/javadoc.json

@@ -0,0 +1,93 @@
+
+{
+    "id": "javadoc_cheat_sheet",
+    "name": "JavaDoc",
+    "description": "A set of javaDoc tags",
+    "metadata": {
+        "sourceName": "Oracle",
+        "sourceUrl": "http://www.oracle.com/technetwork/articles/java/index-137868.html"
+    },
+    "template_type": "terminal",
+    "section_order": [  "Global tags",
+                        "Package tags",
+                        "Class and Interface Tags",
+                        "Field Tags",
+                        "Constructor and Method Tags"
+                     ],
+    "sections": {
+        "Global tags" : [
+            {
+                "key" : "@author",
+                "val" : "Describes an author"
+            },
+            {
+                "key" : "@version",
+                "val" : "Provides software version entry"
+            },
+            {
+                "key" : "@see",
+                "val" : "Text entry that points to a reference"
+            },
+            {
+                "key" : "@since",
+                "val" : "Describes when this functionality has first existed"
+            },
+            {
+                "key" : "@docRoot",
+                "val" : "Represents the relative path to the generated document's root directory from any generated page"
+            },
+            {
+                "key" : "@inheritDoc",
+                "val" : "Inherits a comment from the nearest inheritable class or interface"
+            },
+            {
+                "key" : "@link",
+                "val" : "Inserts an in-line link with the visible text label that points to the documentation"
+            },
+            {
+                "key" : "@linkplain",
+                "val" : "the link's label is displayed in plain text"
+            }
+        ],
+        "Package tags": [
+            {
+                "key" : "@serial",
+                "val" : "Used in the doc comment for a default serializable field"
+            }
+        ],
+        "Class and Interface Tags": [
+            {
+                "key" : "@deprecated",
+                "val" : "Adds a comment indicating that this API should no longer be used"
+            }
+        ],
+        "Field Tags": [
+            {
+                "key" : "@serialField",
+                "val" : "Documents an ObjectStreamField component"
+            },
+            {
+                "key" : "@value",
+                "val" : "Used in the doc comment of a static field"
+            }
+        ],
+        "Constructor and Method Tags": [
+            {
+                "key" : "@return",
+                "val" : "Adds a Returns section with the description text"
+            },
+            {
+                "key" : "@exception",
+                "val" : "Adds a Throws subheading to the generated documentation, with the classname and description text"
+            },
+            {
+                "key" : "@throws",
+                "val" : "The @throws and @exception tags are synonyms."
+            },
+            {
+                "key" : "@serialData",
+                "val" : "Documents the data written by the writeObject() or writeExternal() methods"
+            }
+        ]
+    }
+}