Last active
August 29, 2015 14:04
-
-
Save baratali/fd38aa70664e327770d3 to your computer and use it in GitHub Desktop.
Parse trees for javadoc comments (use JSON viewer to build a tree)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| * @see MyClass | |
| { | |
| "JAVADOC": { | |
| "ASTERISK": "·*", | |
| "TEXT": "·", | |
| "JAVADOC_TAG_SECTION": { | |
| "JAVADOC_TAG": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "JAVADOC_TAG_ARGUMENT": { | |
| "TEXT": "·MyClass" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT": "·", | |
| "JAVADOC_TAG": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "REFERENCE": { | |
| "PACKAGE": " ", | |
| "CLASSNAME": "MyClass" | |
| } | |
| } | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "LEADING_ASTERISK": "·*", | |
| "text": "·", | |
| "javadocTagSee": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "reference": { | |
| "CLASS": "MyClass" | |
| } | |
| } | |
| } | |
| } | |
| ------------------------------------------------------------------------ | |
| * @see MyClass | |
| * @deprecated description | |
| { | |
| "JAVADOC": { | |
| "ASTERISK": "·*", | |
| "TEXT": "·", | |
| "JAVADOC_TAG_SECTION": { | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "JAVADOC_TAG_ARGUMENT": { | |
| "TEXT 1": "·MyClass", | |
| "NEWLINE": "\n", | |
| "ASTERISK": "·*", | |
| "TEXT 2": "·" | |
| } | |
| }, | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_DEPRECATED": "@deprecated", | |
| "JAVADOC_TAG_ARGUMENT": "·description" | |
| } | |
| } | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "ASTERISK": "·*", | |
| "TEXT": "·", | |
| "JAVADOC_TAG_SECTION": { | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "JAVADOC_TAG_ARGUMENT": { | |
| "TEXT 1": "·MyClass", | |
| "NEWLINE": "\n" | |
| } | |
| }, | |
| "ASTERISK_PREFIX": "·*·", | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_DEPRECATED": "@deprecated", | |
| "JAVADOC_TAG_ARGUMENT": "·description" | |
| } | |
| } | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·", | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "JAVADOC_TAG_ARGUMENT": { | |
| "TEXT 1": "·MyClass" | |
| } | |
| }, | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·", | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_DEPRECATED": "@deprecated", | |
| "JAVADOC_TAG_ARGUMENT": "·description" | |
| } | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·", | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "REFERENCE": { | |
| "PACKAGE": " ", | |
| "CLASSNAME": "MyClass" | |
| } | |
| }, | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·", | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_DEPRECATED": "@deprecated", | |
| "DESCRIPTION": "·description" | |
| } | |
| } | |
| } | |
| { | |
| "javadoc": { | |
| "LEADING_ASTERISK 1": "·*", | |
| "text 1": "·", | |
| "javadocTagSee": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "WS": "·", | |
| "reference": { | |
| "CLASS": "MyClass" | |
| }, | |
| "NEWLINE": "\n" | |
| }, | |
| "LEADING_ASTERISK 2": "·*", | |
| "text 2": "·", | |
| "javadocTagDeprecated": { | |
| "JAVADOC_TAG_DEPRECATED": "@deprecated", | |
| "WS": "·", | |
| "deprectaedText": { | |
| "text": "·description", | |
| "NEWLINE": "\n" | |
| } | |
| } | |
| } | |
| } | |
| ------------------------------------------------------------------------ | |
| * Use the {@link #getComponentAt(int, int) getComponentAt} method. | |
| { | |
| "JAVADOC": { | |
| "ASTERISK_PREFIX": "·*·", | |
| "TEXT 1": "Use·the·", | |
| "JAVADOC_INLINE_TAG_START '{'": { | |
| "JAVADOC_INLINE_TAG_LINK": "@link", | |
| "JAVADOC_INLINE_TAG_ARGUMENTS": { | |
| "JAVADOC_INLINE_TAG_ARGUMENT 1": "#getComponentAt(int, int)", | |
| "JAVADOC_INLINE_TAG_ARGUMENT 2": "getComponentAt", | |
| "JAVADOC_INLINE_TAG_END": "}" | |
| } | |
| }, | |
| "TEXT 2": "·method." | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT 1": "·Use·the·", | |
| "JAVADOC_INLINE_TAG_START '{'": { | |
| "JAVADOC_INLINE_TAG_LINK": "@link", | |
| "REFERENCE": { | |
| "PACKAGE": " ", | |
| "CLASS_NAME": " ", | |
| "HASH": "#", | |
| "CLASS_MEMBER": { | |
| "NAME": "getComponentAt", | |
| "PARAMETERS": { | |
| "PARAMETER 1": "int", | |
| "COMMA": ",", | |
| "PARAMETER 2": "int" | |
| } | |
| } | |
| }, | |
| "LABEL": { | |
| "TEXT": "getComponentAt" | |
| }, | |
| "JAVADOC_INLINE_TAG_END": "}" | |
| }, | |
| "TEXT 2": "·method." | |
| } | |
| } | |
| { | |
| "javadoc": { | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT 1": "·Use·the·", | |
| "javadocInlineTagLink": { | |
| "JAVADOC_INLINE_TAG_START": "{", | |
| "JAVADOC_INLINE_TAG_LINK": "@link", | |
| "reference": { | |
| "HASH": "#", | |
| "CLASS_MEMBER": "getComponentAt", | |
| "parameters": { | |
| "LEFT_BRACE": "(", | |
| "PARAMETER 1": "int", | |
| "COMMA": ",", | |
| "WS": "·", | |
| "PARAMETER 2": "int", | |
| "RIGHT_BRACE": ")" | |
| } | |
| }, | |
| "label": { | |
| "TEXT": "getComponentAt" | |
| }, | |
| "JAVADOC_INLINE_TAG_END": "}" | |
| }, | |
| "TEXT 2": "·method." | |
| } | |
| } | |
| ------------------------------------------------------------------------ | |
| @see com.company.OuterClass.NestedClass.AnotherNested#getSomething(int, String) | |
| { | |
| "javadocTagSee": { | |
| "JAVADOC_TAG_SEE": "@see", | |
| "reference": { | |
| "PACKAGE": "com.company", | |
| "DOT 1": ".", | |
| "CLASS 1": "OuterClass", | |
| "DOT 2": ".", | |
| "CLASS 2": "NestedClass", | |
| "DOT 3": ".", | |
| "CLASS 4": "AnotherNested", | |
| "HASH": "#", | |
| "MEMBER": "getSomething", | |
| "parameters": { | |
| "LEFT_BRACE": "(", | |
| "ARGUMENT 1": "int", | |
| "COMMA": ",", | |
| "WS": "·", | |
| "ARGUMENT 2": "String", | |
| "RIGHT_BRACE": ")" | |
| } | |
| } | |
| } | |
| } | |
| ------------------------------------------------------------------------ | |
| * @throws IOException If an input or output | |
| * exception occurred | |
| { | |
| "JAVADOC": { | |
| "ASTERISK_PREFIX": "·*·", | |
| "JAVADOC_TAG_SECTION": { | |
| "JAVADOC_TAG": { | |
| "JAVADOC_TAG_THROWS": "@throws", | |
| "JAVADOC_TAG_ARGUMENTS": { | |
| "JAVADOC_TAG_ARGUMENT 1": { | |
| "TEXT": "IOException" | |
| }, | |
| "JAVADOC_TAG_ARGUMENT 2": { | |
| "TEXT 1": "·If an input or output", | |
| "NEWLINE": "\n", | |
| "ASTERISK_PREFIX": "·*·", | |
| "TEXT 2": "·····················exception occurred" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT": "·", | |
| "JAVADOC_TAG": { | |
| "JAVADOC_TAG_THROWS": "@throws", | |
| "JAVADOC_TAG_ARGUMENTS": { | |
| "JAVADOC_TAG_ARGUMENT 1": { | |
| "TEXT": "IOException" | |
| }, | |
| "JAVADOC_TAG_ARGUMENT 2": { | |
| "TEXT 1": "·If an input or output", | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT 2": "······················exception occurred" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT": "·", | |
| "JAVADOC_TAG": { | |
| "JAVADOC_TAG_THROWS": "@throws", | |
| "JAVADOC_TAG_ARGUMENTS": { | |
| "CLASS_NAME": "IOException", | |
| "DESCRIPTION": { | |
| "TEXT 1": "·If an input or output", | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT 2": "······················exception occurred" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT": "·", | |
| "JAVADOC_TAG": { | |
| "JAVADOC_TAG_THROWS": "@throws", | |
| "CLASS_NAME": "IOException", | |
| "DESCRIPTION": { | |
| "TEXT 1": "·If an input or output", | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT 2": "······················exception occurred" | |
| } | |
| } | |
| } | |
| } | |
| { | |
| "javadoc": { | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT": "·", | |
| "javadocTagThrows": { | |
| "JAVADOC_TAG_THROWS": "@throws", | |
| "CLASS_NAME": "IOException", | |
| "WS": "··", | |
| "description": { | |
| "TEXT 1": "·If an input or output", | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT 2": "······················exception occurred" | |
| } | |
| } | |
| } | |
| } | |
| ------------------------------------------------------------------------ | |
| /** | |
| * <p>Checks that if a class defines a covariant method equals, | |
| * then it defines method equals(java.lang.Object). | |
| * Inspired by findbugs, | |
| * http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf | |
| * </p> | |
| * <p> | |
| * An example of how to configure the check is: | |
| * </p> | |
| * <pre> | |
| * <module name="CovariantEquals"/> | |
| * </pre> | |
| * @author Rick Giles | |
| * @version 1.0 | |
| */ | |
| { | |
| "JAVADOC": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·", | |
| "XML_TAG_OPEN 1 'p'": { | |
| "XML_TAG_CONTENT": { | |
| "TEXT 1": "Checks that if a class defines a covariant method equals,", | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 2": "·then it defines method equals(java.lang.Object).", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·Inspired by findbugs,", | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 4": "·http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf", | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 5": "·" | |
| }, | |
| "XML_TAG_CLOSE": "p" | |
| }, | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·", | |
| "XML_TAG_OPEN 2 'p'": { | |
| "XML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": " An example of how to configure the check is:", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·" | |
| }, | |
| "XML_TAG_CLOSE": "p" | |
| }, | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 3": "·", | |
| "XML_TAG_OPEN 3 'pre'": { | |
| "XML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·", | |
| "HTML_ENTITY 1": "<", | |
| "TEXT 2": "module name=\"CovariantEquals\"/", | |
| "HTML_ENTITY 2": ">", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·" | |
| }, | |
| "XML_TAG_CLOSE": "pre" | |
| }, | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 4": "·", | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_AUTHOR": "@author", | |
| "JAVADOC_TAG_ARGUMENTS": { | |
| "JAVADOC_TAG_ARGUMENT": { | |
| "TEXT": "Rick Giles" | |
| } | |
| } | |
| }, | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_VERSION": "@version", | |
| "JAVADOC_TAG_ARGUMENTS": { | |
| "JAVADOC_TAG_ARGUMENT": { | |
| "TEXT": "1.0" | |
| } | |
| } | |
| }, | |
| "NEWLINE 5": "\n", | |
| "TEXT 5": "·" | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·", | |
| "XML_TAG_OPEN 1 'p'": { | |
| "XML_TAG_CONTENT": { | |
| "TEXT 1": "Checks that if a class defines a covariant method equals,", | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 2": "·then it defines method equals(java.lang.Object).", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·Inspired by findbugs,", | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 4": "·http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf", | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 5": "·" | |
| }, | |
| "XML_TAG_CLOSE": "p" | |
| }, | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·", | |
| "XML_TAG_OPEN 2 'p'": { | |
| "XML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": " An example of how to configure the check is:", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·" | |
| }, | |
| "XML_TAG_CLOSE": "p" | |
| }, | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 3": "·", | |
| "XML_TAG_OPEN 3 'pre'": { | |
| "XML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·<module name=\"CovariantEquals\"/>", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·" | |
| }, | |
| "XML_TAG_CLOSE": "pre" | |
| }, | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 4": "·", | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_AUTHOR": "@author", | |
| "JAVADOC_TAG_ARGUMENTS": { | |
| "JAVADOC_TAG_ARGUMENT": { | |
| "TEXT": "Rick Giles" | |
| } | |
| } | |
| }, | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_VERSION": "@version", | |
| "JAVADOC_TAG_ARGUMENTS": { | |
| "JAVADOC_TAG_ARGUMENT": { | |
| "TEXT": "1.0" | |
| } | |
| } | |
| }, | |
| "NEWLINE 5": "\n", | |
| "TEXT 5": "·" | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·", | |
| "XML_TAG_OPEN 1 'p'": { | |
| "XML_TAG_CONTENT": { | |
| "TEXT 1": "Checks that if a class defines a covariant method equals,", | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 2": "·then it defines method equals(java.lang.Object).", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·Inspired by findbugs,", | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 4": "·http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf", | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 5": "·" | |
| }, | |
| "XML_TAG_CLOSE": "p" | |
| }, | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·", | |
| "XML_TAG_OPEN 2 'p'": { | |
| "XML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": " An example of how to configure the check is:", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·" | |
| }, | |
| "XML_TAG_CLOSE": "p" | |
| }, | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 3": "·", | |
| "XML_TAG_OPEN 3 'pre'": { | |
| "XML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·<module name=\"CovariantEquals\"/>", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·" | |
| }, | |
| "XML_TAG_CLOSE": "pre" | |
| }, | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 4": "·", | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_AUTHOR": "@author", | |
| "NAME_TEXT": { | |
| "TEXT": "Rick Giles" | |
| } | |
| }, | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_VERSION": "@version", | |
| "VERSION_TEXT": { | |
| "TEXT": "1.0" | |
| } | |
| }, | |
| "NEWLINE 5": "\n", | |
| "TEXT 5": "·" | |
| } | |
| } | |
| ------------------------------------------------------------------------ | |
| /** | |
| <div style="color: red;" align="center"> | |
| This is new method | |
| </div> | |
| */ | |
| { | |
| "JAVADOC": { | |
| "NEWLINE 1": "\n", | |
| "XML_TAG_OPEN 1 'div'": { | |
| "XML_TAG_ATTRIBUTES": { | |
| "XML_TAG_ATTRIBUTE 1": { | |
| "ATTRIBUTE_NAME": "style", | |
| "ATTRIBUTE_VALUE": "color: red;" | |
| }, | |
| "XML_TAG_ATTRIBUTE 2": { | |
| "ATTRIBUTE_NAME": "align", | |
| "ATTRIBUTE_VALUE": "center" | |
| } | |
| }, | |
| "XML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "TEXT 1": "This is new method", | |
| "NEWLINE 2": "\n" | |
| }, | |
| "XML_TAG_CLOSE": "div" | |
| }, | |
| "NEWLINE 2": "\n" | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "htmlElement 1": { | |
| "htmlTagOpen": { | |
| "OPEN": "<", | |
| "NAME": "div", | |
| "attribute 0": { | |
| "NAME": "style", | |
| "EQUALS": "=", | |
| "attributeValue": { | |
| "ATT_VALUE": "\"color:red;\"" | |
| } | |
| }, | |
| "attribute 1": { | |
| "NAME": "align", | |
| "EQUALS": "=", | |
| "attributeValue": { | |
| "NAME": "center" | |
| } | |
| }, | |
| "CLOSE": ">" | |
| }, | |
| "NEWLINE 1": "\n", | |
| "TEXT 1": "This is new method", | |
| "NEWLINE 2": "\n", | |
| "htmlTagClose": { | |
| "OPEN_SLASH": "</", | |
| "NAME": "div", | |
| "CLOSE": ">" | |
| } | |
| } | |
| } | |
| } | |
| ------------------------------------------------------------------------ | |
| /** | |
| * <p>Checks that if a class defines a covariant method equals, | |
| * then it defines method equals(java.lang.Object). | |
| * Inspired by findbugs, <br> | |
| * http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf | |
| * <p> | |
| * An example of how to configure the check is: | |
| * </p> | |
| * <p> | |
| * <pre> | |
| * <module name="CovariantEquals"/> | |
| * </pre> | |
| * @author Rick Giles | |
| * @version 1.0 | |
| */ | |
| { | |
| "JAVADOC": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·", | |
| "P_TAG_OPEN 1 'p'": { | |
| "P_TAG_CONTENT": { | |
| "TEXT 1": "Checks that if a class defines a covariant method equals,", | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 2": "·then it defines method equals(java.lang.Object).", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·Inspired by findbugs,", | |
| "BR_TAG": "<br>", | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 4": "·http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf", | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 5": "·" | |
| } | |
| }, | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·", | |
| "P_TAG_OPEN 2 'p'": { | |
| "P_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": " An example of how to configure the check is:", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·" | |
| }, | |
| "P_TAG_CLOSE": "p" | |
| }, | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 3": "·", | |
| "P_TAG_OPEN 3 'p'": { | |
| "HTML_TAG_OPEN 3 'pre'": { | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK": "·*", | |
| "HTML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·<module name=\"CovariantEquals\"/>", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·" | |
| }, | |
| "HTML_TAG_CLOSE": "pre" | |
| } | |
| }, | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 4": "·", | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_AUTHOR": "@author", | |
| "NAME_TEXT": { | |
| "TEXT": "Rick Giles" | |
| } | |
| }, | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_VERSION": "@version", | |
| "VERSION_TEXT": { | |
| "TEXT": "1.0" | |
| } | |
| }, | |
| "NEWLINE 5": "\n", | |
| "TEXT 5": "·" | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "NEWLINE 0": "\n", | |
| "LEADING_ASTERISK 0": "·*", | |
| "TEXT 0": "·", | |
| "P_TAG_OPEN 1": "p", | |
| "TEXT 1": "Checks that if a class defines a covariant method equals,", | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 2": "·then it defines method equals(java.lang.Object).", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·Inspired by findbugs,", | |
| "BR_TAG": "<br>", | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 4": "·http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf", | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "TEXT 5": "·", | |
| "NEWLINE 5": "\n", | |
| "LEADING_ASTERISK 5": "·*", | |
| "TEXT 6": "·", | |
| "P_TAG_OPEN 2 'p'": { | |
| "P_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": " An example of how to configure the check is:", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 2": "·" | |
| }, | |
| "P_TAG_CLOSE": "p" | |
| }, | |
| "NEWLINE 6": "\n", | |
| "LEADING_ASTERISK 6": "·*", | |
| "TEXT 7": "·", | |
| "P_TAG_OPEN 3 'p'": { | |
| "HTML_TAG_OPEN 3 'pre'": { | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK": "·*", | |
| "HTML_TAG_CONTENT": { | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": "·<module name=\"CovariantEquals\"/>", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·" | |
| }, | |
| "HTML_TAG_CLOSE": "pre" | |
| } | |
| }, | |
| "NEWLINE 7": "\n", | |
| "LEADING_ASTERISK 7": "·*", | |
| "TEXT 8": "·", | |
| "JAVADOC_TAG 1": { | |
| "JAVADOC_TAG_AUTHOR": "@author", | |
| "NAME_TEXT": { | |
| "TEXT": "Rick Giles" | |
| } | |
| }, | |
| "JAVADOC_TAG 2": { | |
| "JAVADOC_TAG_VERSION": "@version", | |
| "VERSION_TEXT": { | |
| "TEXT": "1.0" | |
| } | |
| }, | |
| "NEWLINE 8": "\n", | |
| "TEXT 9": "·" | |
| } | |
| } | |
| { | |
| "JAVADOC": { | |
| "NEWLINE 0": "\n", | |
| "LEADING_ASTERISK 0": "·*", | |
| "WS 0": "·", | |
| "htmlElement 1": { | |
| "pTagOpen": { | |
| "OPEN": "<", | |
| "P_NAME": "p", | |
| "CLOSE": ">" | |
| } | |
| }, | |
| "TEXT 1": "Checks that if a class defines a covariant method equals,", | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 2": "·then it defines method equals(java.lang.Object).", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "TEXT 3": "·Inspired by findbugs,", | |
| "htmlElement 2": { | |
| "singletonTag": { | |
| "brTag": { | |
| "OPEN": "<", | |
| "BR_NAME": "br", | |
| "CLOSE": ">" | |
| } | |
| } | |
| }, | |
| "NEWLINE 3": "\n", | |
| "LEADING_ASTERISK 3": "·*", | |
| "TEXT 4": "·http://www.cs.umd.edu/~pugh/java/bugs/docs/findbugsPaper.pdf", | |
| "NEWLINE 4": "\n", | |
| "LEADING_ASTERISK 4": "·*", | |
| "WS 1": "·", | |
| "NEWLINE 5": "\n", | |
| "LEADING_ASTERISK 5": "·*", | |
| "TEXT 6": "·", | |
| "htmlElement": { | |
| "paragraph": { | |
| "pTagOpen": { | |
| "OPEN": "<", | |
| "P_NAME": "p", | |
| "CLOSE": ">" | |
| }, | |
| "NEWLINE 1": "\n", | |
| "LEADING_ASTERISK 1": "·*", | |
| "TEXT 1": " An example of how to configure the check is:", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "WS": "·", | |
| "pTagClose": { | |
| "OPEN_SLASH": "</", | |
| "P_NAME": "p", | |
| "CLOSE": ">" | |
| } | |
| } | |
| }, | |
| "NEWLINE 6": "\n", | |
| "LEADING_ASTERISK 6": "·*", | |
| "WS 3": "·", | |
| "htmlElement 3": { | |
| "pTagOpen": { | |
| "OPEN": "<", | |
| "P_NAME": "p", | |
| "CLOSE": ">" | |
| } | |
| }, | |
| "htmlElement 4": { | |
| "htmlTagOpen": { | |
| "OPEN": "<", | |
| "NAME": "pre", | |
| "CLOSE": ">" | |
| }, | |
| "NEWLINE": "\n", | |
| "LEADING_ASTERISK": "·*", | |
| "TEXT 1": "·<module name=\"CovariantEquals\"/>", | |
| "NEWLINE 2": "\n", | |
| "LEADING_ASTERISK 2": "·*", | |
| "WS 4": "·", | |
| "htmlTagClose": { | |
| "OPEN_SLASH": "</", | |
| "NAME": "pre", | |
| "CLOSE": ">" | |
| } | |
| }, | |
| "NEWLINE 7": "\n", | |
| "LEADING_ASTERISK 7": "·*", | |
| "WS 5": "·", | |
| "javadocTagAuthor": { | |
| "JAVADOC_TAG_AUTHOR": "@author", | |
| "WS": "·", | |
| "nameText": { | |
| "TEXT": "Rick Giles", | |
| "NEWLINE": "\n" | |
| } | |
| }, | |
| "LEADING_ASTERISK 8": "·*", | |
| "WS 6": "·", | |
| "javadocTagVersion": { | |
| "JAVADOC_TAG_VERSION": "@version", | |
| "WS": "·", | |
| "versionText": { | |
| "TEXT": "1.0" | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment