From 5b9f1c114119cbf38400603778a07aeebbce70ff Mon Sep 17 00:00:00 2001 From: Roman Ivanov Date: Sat, 14 Jun 2014 21:44:11 -0700 Subject: [PATCH] Java doc was extended for Docklets to explain their role in project --- .../puppycrawl/tools/checkstyle/doclets/CheckDocsDoclet.java | 4 ++++ .../tools/checkstyle/doclets/TokenTypesDoclet.java | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/doclets/CheckDocsDoclet.java b/src/main/java/com/puppycrawl/tools/checkstyle/doclets/CheckDocsDoclet.java index 0d7cf9c0d..cd6157b6f 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/doclets/CheckDocsDoclet.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/doclets/CheckDocsDoclet.java @@ -32,6 +32,10 @@ import com.sun.javadoc.Tag; * Doclet which is used to extract Anakia input files from the * Javadoc of Check implementations, so the Check's docs are * autogenerated. + * + * Attention: this is incomplete autogenerator of Check's documentation + * from the Check's javadoc. It is not used now, and should be removed from + * master branch till completed. * * @author lkuehne */ diff --git a/src/main/java/com/puppycrawl/tools/checkstyle/doclets/TokenTypesDoclet.java b/src/main/java/com/puppycrawl/tools/checkstyle/doclets/TokenTypesDoclet.java index c7ac1b38a..5a49d2854 100644 --- a/src/main/java/com/puppycrawl/tools/checkstyle/doclets/TokenTypesDoclet.java +++ b/src/main/java/com/puppycrawl/tools/checkstyle/doclets/TokenTypesDoclet.java @@ -30,6 +30,11 @@ import com.sun.javadoc.RootDoc; /** * Doclet which is used to write property file with short descriptions * (first sentences) of TokenTypes' constants. + * + * Request: 724871 + * For ide plugins (like the eclipse plugin) it would be useful to have + * programmatic access to the first sentence of the TokenType constants, + * so they can use them in their configuration gui. * * @author o_sukhodolsky */