-
Notifications
You must be signed in to change notification settings - Fork 276
Fix a few typos in function comments #1628
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
Merged
smowton
merged 1 commit into
diffblue:develop
from
owen-mc-diffblue:owen-jones-diffblue/doc/fix-typos-in-vsa-docs
Nov 27, 2017
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -22,7 +22,7 @@ Author: Daniel Kroening, [email protected] | |
|
||
class namespacet; | ||
|
||
/// State type in value_set_domaint, used is value-set analysis and goto-symex. | ||
/// State type in value_set_domaint, used in value-set analysis and goto-symex. | ||
/// Represents a mapping from expressions to the addresses that may be stored | ||
/// there; for example, a global that is either null or points to a | ||
/// heap-allocated object, which itself has two fields, one pointing to another | ||
|
@@ -163,7 +163,7 @@ class value_sett | |
}; | ||
|
||
/// Converts an `object_map_dt` entry `object_number -> offset` into an | ||
/// `object_descriptor_offsett` with | ||
/// `object_descriptor_exprt` with | ||
/// `.object() == object_numbering.at(object_number)` and | ||
/// `.offset() == offset`. | ||
exprt to_expr(const object_map_dt::value_type &it) const; | ||
|
@@ -303,7 +303,7 @@ class value_sett | |
/// .object_map = ... | ||
/// } | ||
/// | ||
/// The components of the ID are thus duplicates in the `valuest` key and in | ||
/// The components of the ID are thus duplicated in the `valuest` key and in | ||
/// `entryt` fields. | ||
#ifdef USE_DSTRING | ||
typedef std::map<idt, entryt> valuest; | ||
|
@@ -439,7 +439,7 @@ class value_sett | |
/// been run, in which case returns are explicitly passed via global | ||
/// variables named `function_name#return_value` and are handled via the usual | ||
/// `apply_code` path. | ||
/// \param lhs: expression that recieves the return value | ||
/// \param lhs: expression that receives the return value | ||
/// \param ns: global namespace | ||
void do_end_function( | ||
const exprt &lhs, | ||
|
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.
Uh oh!
There was an error while loading. Please reload this page.
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.
If you are fixing up this comment, is there any milage in converting it to proper doxygen format (with
\param
notation) at the same time? Won't hold it against you if you don't want to though :-)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.
I deliberately skipped
\param it: thing being converted; \return converted thing
cos I didn't think it added anything, but don't object if it helps the formatted docs? (I've never seen our actual Doxy output, so I'm flying blind a bit when writing this format)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.
I've not actually seen them either, so equally blind :-) But I think it should help with the formatting and hyperlinking. But I really don't have a strong opinion here either.