summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Fisher <rao@gnu.org>1998-08-10 08:37:26 +0000
committerPaul Fisher <rao@gnu.org>1998-08-10 08:37:26 +0000
commitdfe3de8e6e74257f21d47db0d8be9500cffc021f (patch)
tree115e2003cdc593e3af3f7bed904d2ae1c9441942 /doc
parent9216b0174acb7b9b61565eb092123afccda8868d (diff)
downloadclasspath-dfe3de8e6e74257f21d47db0d8be9500cffc021f.tar.gz
Add doc comment coding standards.
Diffstat (limited to 'doc')
-rw-r--r--doc/jcl-hacking.texinfo6
1 files changed, 5 insertions, 1 deletions
diff --git a/doc/jcl-hacking.texinfo b/doc/jcl-hacking.texinfo
index 487973fab..f7208726c 100644
--- a/doc/jcl-hacking.texinfo
+++ b/doc/jcl-hacking.texinfo
@@ -320,7 +320,11 @@ install directory structure. These should be followed if possible.
For Java code, please follow the
@uref{http://java.sun.com/docs/codeconv/html/CodeConventionsTOC.doc.html,Sun programming standards}.
As an exception, do not feel obligated to following their bracket and
-indentation style if you consider it wrong as I do.
+indentation style if you consider it to be wrong.
+
+For documentation comments, please follow
+@uref{http://java.sun.com/products/jdk/javadoc/writingdoccomments.html,How
+to Write Doc Comments for Javadoc}.
@node Programming Goals, Portability, Programming Standards, Top
@comment node-name, next, previous, up