Project Report: fawkez

Packagesummary org.jcoderz.phoenix.report.ftf

org.jcoderz.phoenix.report.ftf.javadoc.xml

LineHitsNoteSource
1  <?xml version="1.0" encoding="UTF-8"?>
2  <findingTypeFormatDescription xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../../../../xml/schema/finding-type-format-description.xsd">
3    <staticTypeInfo>
4      <name>JavaDoc</name>
5      <version>1.0</version>
6      <findingReportFilenamePattern>javadoc.log</findingReportFilenamePattern>
7    </staticTypeInfo>
8    <rootType>
9      <symbol>javadoc-warning</symbol>
10      <pattern>^((.:)?[^:\n]*):(([0-9]*):)? (warning|error) - (.*)$</pattern>
11      <severity>code-style</severity>
12      <!-- severity for broken doc: design,
13                     for missing stuff: code-style -->
14      <textPos>6</textPos>
15      <filenamePos>1</filenamePos>
16      <lineStartPos>4</lineStartPos>
17    </rootType>
18    <findingType>
19      <symbol>JavaDocWarning</symbol>
20      <shortDescription>JavaDoc warning.</shortDescription>
21      <description>A generic warning from the JavaDoc tool.</description>
22      <pattern>(.*)</pattern>
23      <priority>-99</priority>
24      <severity>code-style</severity>
25    </findingType>
26    <findingType>
27      <symbol>JavaDocNoInheritedDoc</symbol>
28      <shortDescription>(@inheritDoc) used but the element does not override or implement any method.</shortDescription>
29      <description>
30          The {@inheritDoc} tag can only be used when there exists some inherited
31          element. Please remember that constructors are not inherited.  
32      </description>
33      <pattern>(@inheritDoc) used but (.*) does not override or implement any method\.</pattern>
34      <severity>design</severity>
35      <sourceTextPos>1</sourceTextPos>
36    </findingType>
37    <findingType>
38      <symbol>JavaDocNoReturn</symbol>
39      <shortDescription>@return tag cannot be used in method with void return type.</shortDescription>
40      <description>
41          The method does not return any value, so there is no use of a @return
42          tag.
43      </description>
44      <pattern>(@return) tag cannot be used in method with void return type\.</pattern>
45      <severity>code-style</severity>
46      <sourceTextPos>1</sourceTextPos>
47    </findingType>
48    <findingType>
49      <symbol>JavaDocNoParameter</symbol>
50      <shortDescription>The parameter described with the @param tag does not exist.</shortDescription>
51      <pattern>@param argument "(.*)" is not a parameter name\.</pattern>
52      <severity>design</severity>
53      <sourceTextPos>1</sourceTextPos>
54    </findingType>
55    <findingType>
56      <symbol>JavaDocLinkReferenceNotFound</symbol>
57      <shortDescription>Referred target was not found.</shortDescription>
58      <description>
59          The tag points to a reference that could not be found.
60          It might be caused by a typo in the target or also in a missing class
61          on the classpath while generating javadoc.
62      </description>
63      <pattern>Tag (@link|@see): reference not found: (.*)</pattern>
64      <severity>design</severity>
65      <sourceTextPos>1</sourceTextPos>
66    </findingType>
67    <findingType>
68      <symbol>JavaDocUnknownTag</symbol>
69      <shortDescription>The used tag is not known.</shortDescription>
70      <description>
71          The tag used is not known to java doc. Might be a doclet definition is 
72          missing or a typo in the tag name?
73      </description>
74      <pattern>(.*) is an unknown tag\.</pattern>
75      <severity>design</severity>
76      <sourceTextPos>1</sourceTextPos>
77    </findingType>
78    <findingType>
79      <symbol>JavaDocTagMisuse</symbol>
80      <shortDescription>The used tag is not suitable in this context.</shortDescription>
81      <description>
82          The use of the tag is limited to the listed places.
83      </description>
84      <pattern>Tag (.*) cannot be used in (.*) documentation\. ?It can only be used in the following types of documentation: (.*)\.</pattern>
85      <severity>design</severity>
86      <sourceTextPos>1</sourceTextPos>
87    </findingType>
88    <findingType>
89      <symbol>JavaDocCanNotFindMember</symbol>
90      <shortDescription>The local target of the tag can not be found.</shortDescription>
91      <pattern>Tag (.*): can't find (.*) ?in (.*)</pattern>
92      <severity>design</severity>
93      <sourceTextPos>1</sourceTextPos>
94    </findingType>
95    <findingType>
96      <symbol>JavaDocTagWithNoArgument</symbol>
97      <shortDescription>The tag is expected to get at least one argument.</shortDescription>
98      <description>
99          Intention of the tag is to mark what is documented, it looks
100          like the documentation itself is missing.
101      </description>
102      <pattern>(@return) tag has no arguments\.</pattern>
103      <severity>design</severity>
104      <sourceTextPos>1</sourceTextPos>
105    </findingType>
106    <findingType>
107      <symbol>JavaDocTagUnknownCase</symbol>
108      <shortDescription>The tag is not known - with the current casing.</shortDescription>
109      <description>
110          The tag is not known, but a tag exists that only differs
111          in casing.
112      </description>
113      <pattern>(.*) is an unknown tag -- same as a known tag except for case\.</pattern>
114      <severity>design</severity>
115      <sourceTextPos>1</sourceTextPos>
116    </findingType>
117    <findingType>
118      <symbol>JavaDocMissingClosingCurlyBracket</symbol>
119      <shortDescription>A closing curly bracket is missing.</shortDescription>
120      <description>
121          The curly bracket used for the inline tag are not closed..
122      </description>
123      <pattern>Missing closing '}' character for inline tag: "(.*)"</pattern>
124      <severity>design</severity>
125      <sourceTextPos>1</sourceTextPos>
126    </findingType>
127    <findingType>
128      <symbol>JavaDocErrorFetchingUrl</symbol>
129      <shortDescription>Data on the given Url could not be loaded.</shortDescription>
130      <description>
131          Data on the given Url could not be loaded. Might be because the
132          network is temporarily not available or the resource does not 
133          exist.
134      </description>
135      <global>true</global>
136      <pattern>Error fetching URL: (.*)</pattern>
137      <severity>design</severity>
138      <sourceTextPos>1</sourceTextPos>
139    </findingType>
140  </findingTypeFormatDescription>

Findings in this File