Package | Description |
---|---|
com.whitestein.lsps.lang.doc |
This package contains classes for parsing the documentation comments.
|
Modifier and Type | Method and Description |
---|---|
DocText |
DocParam.getDescription()
Gets the parameter description.
|
DocText |
DocError.getDescription()
Gets the description of the error.
|
DocText |
Doc.getDescription()
Gets the description of the documented element.
|
DocText |
Doc.getReturnDoc()
Returns a description of return value.
|
Constructor and Description |
---|
Doc(DocText description,
List<DocParam> params,
List<DocError> errors,
DocText returnDoc)
Creates a structured documentation for a source code element.
|
DocError(String errorName,
DocText description)
Creates a new error description
|
DocParam(String name,
DocText description)
Creates a new parameter description.
|
Copyright © 2007-2020 Whitestein Technologies. All Rights Reserved.