opendev/gerrit
Code Issues Proposed changes

Document that public classes/methods should have Javadoc

Browse Source 
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
This commit is contained in:
Edwin Kempin 2019-11-19 12:24:51 +01:00
parent c7c1086b4c
commit 6f3879d27b
1 changed files with 7 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Documentation/dev-crafting-changes.txt
View File

@ -230,6 +230,13 @@ when coding:
* 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