public class Doc
extends java.lang.Object
Constructor and Description |
---|
Doc(DocText description,
java.util.List<DocParam> params,
java.util.List<DocError> errors,
DocText returnDoc)
Creates a structured documentation for a source code element.
|
Modifier and Type | Method and Description |
---|---|
DocText |
getDescription()
Gets the description of the documented element.
|
java.util.List<DocError> |
getErrors()
Gets the description of the errors this element can produce.
|
java.util.List<DocParam> |
getParams()
Gets the descriptions of the element's parameters.
|
DocText |
getReturnDoc()
Returns a description of return value.
|
java.lang.String |
toString() |
public Doc(DocText description, java.util.List<DocParam> params, java.util.List<DocError> errors, DocText returnDoc)
description
- the description of the documented elementparams
- the description of element's parameterserrors
- the description of element's errorsreturnDoc
- the description of the element's return valuepublic DocText getDescription()
public java.util.List<DocParam> getParams()
public java.util.List<DocError> getErrors()
public DocText getReturnDoc()
public java.lang.String toString()
toString
in class java.lang.Object
Copyright © 2007-2020 Whitestein Technologies. All Rights Reserved.