DocumentationBuilder |
DocumentationBuilder.asyncThrows(String exceptionClass,
String exceptionDoc) |
|
DocumentationBuilder |
DocumentationBuilder.asyncThrows(List<Pair<String,String>> exceptions) |
Adds multiple async throws to the Javadoc for each exception name / exception doc pair.
|
DocumentationBuilder |
DocumentationBuilder.asyncThrows(Pair<String,String>... exceptions) |
Adds multiple async throws to the Javadoc for each exception name / exception doc pair.
|
DocumentationBuilder |
DocumentationBuilder.description(String docs) |
Description of javaodc comment.
|
DocumentationBuilder |
DocumentationBuilder.param(String paramName,
String paramDocs) |
Adds a new param to the Javadoc.
|
DocumentationBuilder |
DocumentationBuilder.param(String paramName,
String paramDocs,
Object... formatArgs) |
Adds a new param to the Javadoc.
|
DocumentationBuilder |
DocumentationBuilder.returns(String returnsDoc) |
Adds documentation for return value.
|
DocumentationBuilder |
DocumentationBuilder.returns(String returnsDoc,
Object... formatArgs) |
Adds documentation for return value.
|
DocumentationBuilder |
DocumentationBuilder.see(String seeLink) |
Adds a @see reference to the Javadocs.
|
DocumentationBuilder |
DocumentationBuilder.see(String seeLink,
Object... formatArgs) |
Adds a @see reference to the Javadocs.
|
DocumentationBuilder |
DocumentationBuilder.syncThrows(String exceptionClass,
String exceptionDoc) |
Adds a throws tag to the Javadoc.
|
DocumentationBuilder |
DocumentationBuilder.syncThrows(List<Pair<String,String>> exceptions) |
Adds multiple throws tag to the Javadoc for each exception name / exception doc pair.
|
DocumentationBuilder |
DocumentationBuilder.syncThrows(Pair<String,String>... exceptions) |
Adds multiple throws tag to the Javadoc for each exception name / exception doc pair.
|
DocumentationBuilder |
DocumentationBuilder.tag(String tagName,
String... tagValues) |
Adds an arbitrary tag with values to the Javadoc.
|