Constructor
new CommentsBinder(comments)
constructor
Parameters:
| Name | Type | Description |
|---|---|---|
comments |
CppComments | C/C++ comments |
- Source:
Methods
at(line, col)
When reaching a specific location, try to resolve pending comment bindings
Parameters:
| Name | Type | Description |
|---|---|---|
line |
Number | line number |
col |
Number | column number |
- Source:
finalize()
Finalize bindings processing the remaining pending comment bindings
- Source:
visit(document, path, kind)
Visit a clang document and bind C/C++ comment
Parameters:
| Name | Type | Description |
|---|---|---|
document |
Object | a Clang document |
path |
string | abtract path |
kind |
string | undefined | kind of visited document (either 'function', 'variable', 'enum', 'typedef', 'struct', 'union', 'class', 'field', 'method', or undefined) |
- Source: