Changes between Version 14 and Version 15 of DevelopersGuide/StyleGuide

Timestamp:

2012-08-09T18:17:10+02:00 (14 years ago)

Author:

Don-vip

Comment:

javadoc style guide

DevelopersGuide/StyleGuide

@@ -8 +8 @@
  * JOSM uses 4 characters indentation and no tab stops
  * Document your code '''thoroughly'''. Many people will thank you :)
+
+== How your javadoc should look like ==
+ * The [http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html#styleguide Oracle Javadoc style guide] is used as the base guide
+ * {{{@since}}} is used for public classes and methods (visible to plugin developers) with the JOSM revision that introduced the element. Example: {{{@since 5408}}}
+   * {{{@since}}} is updated when a public method signature changes or if a class is renamed
+ * {{{@throws}}} is preffered to {{{@exception}}}
 
 === Configuring Eclipse ===