docs: add javadoc conventions to README.md

tom-weelborg · tom-weelborg · commit 2e0e5a45707b · 2025-04-20T22:45:56.000+02:00
diff --git a/README.md b/README.md
@@ -111,4 +111,12 @@ The following are lists of conventions that either *should* be followed or *must
             }
         }
     }
-    ```
+    ```
+- Javadoc:
+  - Must be added to: 
+    - `public` methods and functions of classes, excluding getters, setters and constructors
+  - Should be added to:
+    - all `private` members of which the purpose is not obvious or the logic is difficult to comprehend
+  - May be added to:
+    - `public static` constants
+    - other `private` members

Original file line number	Diff line number	Diff line change
`@@ -111,4 +111,12 @@ The following are lists of conventions that either should be followed or *must`
`111`	`111`	`}`
`112`	`112`	`}`
`113`	`113`	`}`
`114`		- ```
	`114`	+ ```
	`115`	`+- Javadoc:`
	`116`	`+ - Must be added to:`
	`117`	+ - `public` methods and functions of classes, excluding getters, setters and constructors
	`118`	`+ - Should be added to:`
	`119`	+ - all `private` members of which the purpose is not obvious or the logic is difficult to comprehend
	`120`	`+ - May be added to:`
	`121`	+ - `public static` constants
	`122`	+ - other `private` members