C++: QLDoc for BasicBlock, ControlFlowGraph and Dataflow #3582
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jbj
reviewed
May 28, 2020
| @@ -1,3 +1,8 @@ | |||
| /** | |||
| * Provides a library for reasoning about control-flow at the granularity of basic blocks. | |||
There was a problem hiding this comment.
Suggested change
| * Provides a library for reasoning about control-flow at the granularity of basic blocks. | |
| * Provides a library for reasoning about control flow at the granularity of basic blocks. |
https://wiki.semmle.com/display/SSG/Hyphenation
Hyphenation in English compound phrases is like placing parentheses in code. Right associativity is the default, and hyphens bind stronger than spaces. Example "The control-flow library describes control flow".
There was a problem hiding this comment.
That's an explanation I've never heard before, but it makes complete sense!
| ControlFlowNode getNode(int pos) { basic_block_member(result, this, pos) } | ||
|
|
||
| /** Gets all `ControlFlowNode`s in this basic block. */ |
There was a problem hiding this comment.
Suggested change
| /** Gets all `ControlFlowNode`s in this basic block. */ | |
| /** Gets a `ControlFlowNode` in this basic block. */ |
See https://wiki.semmle.com/pages/viewpage.action?pageId=74613282#QLDocStyleGuide-QLDocforpredicates.
Also in the two predicates below.
| @@ -1,3 +1,8 @@ | |||
| /** | |||
| * Provides a library for reasoning about control-flow at the granularity of | |||
There was a problem hiding this comment.
Suggested change
| * Provides a library for reasoning about control-flow at the granularity of | |
| * Provides a library for reasoning about control flow at the granularity of |
But the hyphen in the next line is correct.
jbj
approved these changes
May 28, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Part of https://github.com/github/codeql-c-analysis-team/issues/40.