From d3cd6a25087369bcddae4ac633c807ff0fae2d7d Mon Sep 17 00:00:00 2001 From: Roman Ivanov Date: Fri, 6 May 2016 06:44:45 -0700 Subject: [PATCH] Issue #410: fix for formatting at writingjavadocchecks.xml.vm --- src/xdocs/writingjavadocchecks.xml.vm | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/xdocs/writingjavadocchecks.xml.vm b/src/xdocs/writingjavadocchecks.xml.vm index 0cb862a91..b89783cb3 100644 --- a/src/xdocs/writingjavadocchecks.xml.vm +++ b/src/xdocs/writingjavadocchecks.xml.vm @@ -40,9 +40,9 @@ public class MyClass { * @see AbstractClass ]]>

- Attention that java comment is start with /*, following with Identificator of comment type. Javadoc Identificator is *. All symbols after Javadoc Identificator till */ are part of javadoc comment. In internet you can find different types of documentation + Attention that java comment is start with /*, following with Identificator of comment type. Javadoc Identificator is *. All symbols after Javadoc Identificator till */ are part of javadoc comment. In internet you can find different types of documentation generation tools similar to javadoc. Such tools reply on different Identificators: "!", "#", "$". - Comments looks like "/*! some comment */" , "/*# some comment */" , "/*$ some comment */". Such multiline comments are not a javadoc. + Comments looks like "/*! some comment */" , "/*# some comment */" , "/*$ some comment */". Such multiline comments are not a javadoc.