Constructor
new CppCommentsCursor(comments)
constructor
Parameters:
| Name | Type | Description |
|---|---|---|
comments |
CppComments | C/C++ comments per file |
- Source:
Methods
move_after_column(col) → {boolean}
Move after (preprocessed input) column
Parameters:
| Name | Type | Description |
|---|---|---|
col |
Number | column number |
- Source:
Returns:
true=success,false=line has no comments after column
- Type
- boolean
move_before_column(col) → {boolean}
Move before (preprocessed input) column
Parameters:
| Name | Type | Description |
|---|---|---|
col |
Number | column number |
- Source:
Returns:
true=success,false=line has no comments before column
- Type
- boolean
move_just_after(line, col) → {boolean}
Move cursor just after a line and column
Parameters:
| Name | Type | Description |
|---|---|---|
line |
Number | line number |
col |
Number | col number |
- Source:
Returns:
true=success,false=no comments just after
- Type
- boolean
move_just_before(line, col) → {boolean}
Move cursor just before a line and column
Parameters:
| Name | Type | Description |
|---|---|---|
line |
Number | line number |
col |
Number | col number |
- Source:
Returns:
true=success,false=no comments just before
- Type
- boolean
move_to_column(col) → {boolean}
Move to (preprocessed input) column
Parameters:
| Name | Type | Description |
|---|---|---|
col |
Number | column number |
- Source:
Returns:
true=success,false=column has no comments
- Type
- boolean
move_to_file(file) → {boolean}
Move to file
Parameters:
| Name | Type | Description |
|---|---|---|
file |
string | filename |
- Source:
Returns:
true=success,false=file has no comments
- Type
- boolean
move_to_line(line) → {boolean}
Move to line
Parameters:
| Name | Type | Description |
|---|---|---|
line |
Number | line number |
- Source:
Returns:
true=success,false=line has no comments
- Type
- boolean
next_same_line() → {boolean}
Move to next (rightward) comment
- Source:
Returns:
true=success,false=no more comments at current the line
- Type
- boolean
prev_same_line() → {boolean}
Move to previous (leftward) comment
- Source:
Returns:
true=success,false=no more comments at current the line
- Type
- boolean