-
-
Notifications
You must be signed in to change notification settings - Fork 3.8k
Description
Same as #14516 but for javadoc
https://checkstyle.org/apidocs/com/puppycrawl/tools/checkstyle/api/JavadocTokenTypes.html
https://checkstyle.org/cmdline.html , see -j or -J .
SteLeo@DESKTOP-11C7U5R MINGW64 ~/exception_literal test
$ cat Test.java
* @exception SQLException if query is not correct
SteLeo@DESKTOP-11C7U5R MINGW64 ~/exception_literal test
$ java -jar checkstyle-10.16.0-all.jar -j Test.java | sed "s/\[[0-9]\+:[0-9]\+\]//g"
JAVADOC -> JAVADOC
|--LEADING_ASTERISK -> *
|--WS ->
|--JAVADOC_TAG -> JAVADOC_TAG
| |--EXCEPTION_LITERAL -> @exception
| |--WS ->
| |--CLASS_NAME -> SQLException
| |--WS ->
| `--DESCRIPTION -> DESCRIPTION
| `--TEXT -> if query is not correct
`--EOF -> <EOF>
Good example on how update should looks like is at #14862
To generate AST, use cmd : java -jar checkstyle-10.13.0-all.jar -J Test.java | sed "s/\[[0-9]\+:[0-9]\+\]//g"
The sed command removes the line:column numbers for our documentation.
Each token update should be in its own Pull Request.
Share whole cli output for javadoc chunk in PR description.
ATTENTION: do not forget to escape >
to >
. And also escape <
if appeared.
Watch videos on how to do new PR and do exactly this update , link to youtube video is at this page https://checkstyle.org/beginning_development.html#Starting_Development
Good example of update: #14632 please provide all details as provided in description of this PR
One more good example of code changes: https://github.com/checkstyle/checkstyle/pull/16086/files
Documentation should be improved for:
- AREA_HTML_TAG_NAME
- AREA_TAG
- ARGUMENT
- ATTR_VALUE
- ATTRIBUTE
- AUTHOR_LITERAL
- BASE_HTML_TAG_NAME
- BASE_TAG
- BASEFONT_HTML_TAG_NAME
- BASEFONT_TAG
- BODY
- BODY_HTML_TAG_NAME
- BODY_TAG_END
- BODY_TAG_START
- BR_HTML_TAG_NAME
- BR_TAG
- CHAR
- CLASS_NAME
- CODE_LITERAL
- COL_HTML_TAG_NAME
- COL_TAG
- COLGROUP
- COLGROUP_HTML_TAG_NAME
- COLGROUP_TAG_END
- COLGROUP_TAG_START
- COMMA
- CUSTOM_NAME
- DD
- DD_HTML_TAG_NAME
- DD_TAG_END
- DD_TAG_START
- DEPRECATED_LITERAL
- DESCRIPTION
- DOC_ROOT_LITERAL
- DT
- DT_HTML_TAG_NAME
- DT_TAG_END
- DT_TAG_START
- EMBED_HTML_TAG_NAME
- EMBED_TAG
- HTML
- EMPTY_TAG
- END
- EOF
- EQUALS
- EXCEPTION_LITERAL
- FIELD_NAME
- FIELD_TYPE
- FRAME_HTML_TAG_NAME
- FRAME_TAG
- HASH
- HEAD
- HEAD_HTML_TAG_NAME
- HEAD_TAG_END
- HEAD_TAG_START
- HR_HTML_TAG_NAME
- HR_TAG
- HTML
- HTML_COMMENT
- HTML_COMMENT_END
- HTML
- HTML_COMMENT_START
- HTML
- HTML_ELEMENT
- HTML_ELEMENT_END
- HTML_ELEMENT_START
- HTML_HTML_TAG_NAME
- HTML_TAG
- HTML_TAG_END
- HTML_TAG_NAME
- HTML_TAG_START
- IMG_HTML_TAG_NAME
- IMG_TAG
- INHERIT_DOC_LITERAL
- INPUT_HTML_TAG_NAME
- INPUT_TAG
- ISINDEX_HTML_TAG_NAME
- ISINDEX_TAG
- JAVADOC
- JAVADOC_INLINE_TAG
- JAVADOC_INLINE_TAG_END
- JAVADOC_INLINE_TAG_START
- JAVADOC_TAG
- KEYGEN_HTML_TAG_NAME
- KEYGEN_TAG
- HTML
- LEADING_ASTERISK
- LEFT_BRACE
- LI
- LI_HTML_TAG_NAME
- LI_TAG_END
- LI_TAG_START
- LINK_HTML_TAG_NAME
- LINK_LITERAL
- LINK_TAG
- LINKPLAIN_LITERAL
- LITERAL_EXCLUDE
- LITERAL_INCLUDE
- LITERAL_LITERAL
- MEMBER
- A
- META_HTML_TAG_NAME
- META_TAG
- NEWLINE
- OPTGROUP
- OPTGROUP_HTML_TAG_NAME
- OPTGROUP_TAG_END
- OPTGROUP_TAG_START
- OPTION
- OPTION_HTML_TAG_NAME
- OPTION_TAG_END
- OPTION_TAG_START
- P_HTML_TAG_NAME
- P_TAG_END
- P_TAG_START
- PACKAGE_CLASS
- PACKAGE_CLASS
- PARAGRAPH
- PARAM_HTML_TAG_NAME
- PARAM_LITERAL
- PARAM_TAG
- PARAMETER_NAME
- PARAMETERS
- RB
- RB_HTML_TAG_NAME
- RB_TAG_END
- RB_TAG_START
- REFERENCE
- RETURN_LITERAL
- RIGHT_BRACE
- RP
- RP_HTML_TAG_NAME
- RP_TAG_END
- RP_TAG_START
- RT
- RT_HTML_TAG_NAME
- RT_TAG_END
- RT_TAG_START
- RTC
- RTC_HTML_TAG_NAME
- RTC_TAG_END
- RTC_TAG_START
- SEE_LITERAL
- SERIAL_DATA_LITERAL
- SERIAL_FIELD_LITERAL
- SERIAL_LITERAL
- SINCE_LITERAL
- SINGLETON_ELEMENT
- SLASH
- SLASH_END
- SOURCE_HTML_TAG_NAME
- SOURCE_TAG
- HTML
- START
- STRING
- TBODY
- TBODY_HTML_TAG_NAME
- TBODY_TAG_END
- TBODY_TAG_START
- TD
- TD_HTML_TAG_NAME
- TD_TAG_END
- TD_TAG_START
- TEXT
- CHAR
- TFOOT
- TFOOT_HTML_TAG_NAME
- TFOOT_TAG_END
- TFOOT_TAG_START
- TH
- TH_HTML_TAG_NAME
- TH_TAG_END
- TH_TAG_START
- THEAD
- THEAD_HTML_TAG_NAME
- THEAD_TAG_END
- THEAD_TAG_START
- THROWS_LITERAL
- TR
- TR_HTML_TAG_NAME
- TR_TAG_END
- TR_TAG_START
- TRACK_HTML_TAG_NAME
- TRACK_TAG
- HTML
- VALUE_LITERAL
- VERSION_LITERAL
- WBR_HTML_TAG_NAME
- WBR_TAG
- HTML
- WS