summaryrefslogtreecommitdiffhomepage
path: root/java.html.markdown
diff options
context:
space:
mode:
authorHarry <thedankdesetude@gmail.com>2016-06-26 13:45:20 +0100
committerven <vendethiel@hotmail.fr>2016-06-26 14:45:20 +0200
commitebd74da99a73d9cbdba23285afc745a740a87e28 (patch)
tree0ee0277be5c4cdcd477e6a63b1881e8a3b01a24c /java.html.markdown
parentefec1d63ee081781e3009286b3df24b1dbea0ac6 (diff)
Added main attributes of javadocs. (#1850)
Diffstat (limited to 'java.html.markdown')
-rw-r--r--java.html.markdown13
1 files changed, 11 insertions, 2 deletions
diff --git a/java.html.markdown b/java.html.markdown
index a025bbba..fb0913f1 100644
--- a/java.html.markdown
+++ b/java.html.markdown
@@ -23,8 +23,17 @@ Multi-line comments look like this.
*/
/**
-JavaDoc comments look like this. Used to describe the Class or various
-attributes of a Class.
+ * JavaDoc comments look like this. Used to describe the Class or various
+ * attributes of a Class.
+ * Main attributes:
+ *
+ * @author Name (and contact information such as email) of author(s).
+ * @version Current version of the program.
+ * @since When this part of the program was first added.
+ * @param For describing the different parameters for a method.
+ * @return For describing what the method returns.
+ * @deprecated For showing the code is outdated or shouldn't be used.
+ * @see Links to another part of documentation.
*/
// Import ArrayList class inside of the java.util package