Skip to content

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.

Sign up for GitHub

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
merged 1 commit into from
Nov 27, 2017
Merged

Fix a few typos in function comments #1628

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions src/pointer-analysis/value_set.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Copy link
Contributor

@chrisr-diffblue chrisr-diffblue Nov 27, 2017 •
edited
Loading

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 :-)

Copy link
Contributor

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)

Copy link
Contributor

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.

/// `.offset() == offset`.
exprt to_expr(const object_map_dt::value_type &it) const;
Expand Down Expand Up @@ -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;
Expand Down Expand Up @@ -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,
Expand Down