Skip to content

Doxygen comment on get_writeable_symbol #2492

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
Jul 2, 2018
Merged

Doxygen comment on get_writeable_symbol #2492

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
10 changes: 9 additions & 1 deletion src/util/symbol_table_base.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -181,7 +181,15 @@ class symbol_table_baset
return &**this;
}

symbolt &get_writeable_symbol(const irep_idt &identifier)
/// Whereas the dereference operator gives a constant reference to the
/// current symbol, this method allows users to get a writeable reference
/// to the symbol
/// \remarks
/// This method calls the on_get_writeable method first to give derived
/// symbol table classes the opportunity to note that this symbol is being
/// written to before it is accessed.
/// \returns a non-const reference to the current symbol
symbolt &get_writeable_symbol()
{
if(on_get_writeable)
on_get_writeable((*this)->first);
Expand Down