Document that public classes/methods should have Javadoc
Often public methods/classes in the Gerrit source code are not
sufficiently documented, making it hard for readers to understand the
purpose of methods/classes and understand how classes work together.
Bug: Issue 11954
Signed-off-by: Edwin Kempin <ekempin@google.com>
Change-Id: I055da6f5362a42466c34668d96f4bd050f44fe2e
diff --git a/Documentation/dev-crafting-changes.txt b/Documentation/dev-crafting-changes.txt
index bf4453c..eb9dee4 100644
--- a/Documentation/dev-crafting-changes.txt
+++ b/Documentation/dev-crafting-changes.txt
@@ -230,6 +230,13 @@
* Tests for new code will greatly help your change get approved.
+[[javadoc]]
+== Javadoc
+
+ * Javadocs for new code (especially public classes and
+ public/protected methods) will greatly help your change get
+ approved.
+
[[change-size]]
== Change Size/Number of Files Touched
