What do the errors mean?
- Possible use of vmodl name
- In description text a word matched a VMODL name or had a '.' in it.
- Possible un-linked wsdl name
- In description text a word matched a WSDL name and was not a link.
- Item: <package.ClassName> is undocumented
- There is no general description for a type
- Enum value: <package.EnumName.value> is undocumented
- An enum value is not documented
- Property: <package.ClassName..property> is undocumented
- A property is undocumented
- <package.ClassName.method()> @task is undocumented
- The method returns a Task and the details about the task are not documented.
- Method: <package.ClassName.method()>, Parameter <parameterName> is undocumented
- A parameter of the method is not documented
- <package.ClassName.method()> return is undocumented
- The return value for the method is not documented
- <package.ClassName.method()>, Fault: <package.ClassName> is undocumented
- A fault that the method throws is not documented
- <package.ClassName> Link (@see): <SomeText> not found
- A @see link is broken
- <package.ClassName> Link {@link}: <SomeText> not found
- A @link is broken
- Possible unused javadoc tag: '@see'
- The text '@see' is output instead of a link
- Possible unused javadoc tag: '@link'
- The text '@link' is output instead of a link
- <package.ClassName.method()>, unused exception "<ExceptionName>" documentation
- This could mean four things:
- "<ExceptionName>" is NOT derived from an exception declared on the method
- "<ExceptionName>" is listed twice and the descriptions need to be combined
- "<ExceptionName>" is a base class of an exception declared on the method
- "<ExceptionName>" is not a valid type