Methods
cursor(type) → {CppCommentsCursor}
Create a comments navigation cursor
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | type of C/C++ comment (one of CppComment::Types) |
- Source:
Returns:
a cursor
- Type
- CppCommentsCursor
export(type) → {Array.<CppCommentsDocument>}
Export C/C++ comments to C/C++ comments/annotations documents
Parameters:
| Name | Type | Description |
|---|---|---|
type |
string | type of C/C++ comment (one of CppComment::Types) |
- Source:
Returns:
an array of comments
- Type
- Array.<CppCommentsDocument>
insert(comment)
Insert comment
Parameters:
| Name | Type | Description |
|---|---|---|
comment |
CppComment | a C/C++ comment |
- Source:
optimize()
Optimize for locality and navigation
- Source: