From 5da6474587b75dbeee6ce489b5355f855993f9ca Mon Sep 17 00:00:00 2001 From: Roman Ivanov Date: Mon, 18 Jul 2016 21:20:26 -0700 Subject: [PATCH] minor: fix for intelijidea violation of tab usage --- src/xdocs/writingjavadocchecks.xml.vm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/xdocs/writingjavadocchecks.xml.vm b/src/xdocs/writingjavadocchecks.xml.vm index f808117cb..1dc772ef3 100644 --- a/src/xdocs/writingjavadocchecks.xml.vm +++ b/src/xdocs/writingjavadocchecks.xml.vm @@ -42,7 +42,7 @@ public class MyClass {

Attention that java comment starts with /*, following with Identificator of comment type. Javadoc Identificator is *. All symbols after Javadoc Identificator till */ are part of javadoc comment.

Please not that javadoc-like comment inside a method is not a javadoc comment and skiped by - Sun/Oracle javadoc tool and by our parser. + Sun/Oracle javadoc tool and by our parser.

In internet you can find different types of documentation generation tools similar to javadoc. Such tools rely on specific Identificator: "!", "#", "$".