-
Notifications
You must be signed in to change notification settings - Fork 1.8k
C++: Add QLDocs for Initializer.qll-Macro.qll and model classes #3766
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great, I appreciate the examples you've provided in FunctionInputsAndOutputs.qll
.
@@ -1,3 +1,7 @@ | |||
/** | |||
* Proivdes the `LinkTarget` class representing linker invocations at compile time. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Super nit-picky suggestion: "compile time" -> "build time" or "during the build process", for consistency with the QLDoc below and because strictly speaking linking is usually done after compiling.
/** | ||
* Gets a function that includes an expression that is affected by this macro | ||
* invocation. If the macro expansion includes the end of one function and | ||
* the beginning of another, this predicate will get both. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Helpful explanation. 👍
@@ -1,3 +1,8 @@ | |||
/** | |||
* Provides implementation classes modelling `strcat` and various similar functions. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There's an accidental double space here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, merging.
No description provided.