Skip to content

Commit 76eaf86

Browse files
Doxygen comment on get_writeable_symbol
Also removed unused parameter that was originally intended to be used as a safety check
1 parent 6fd77f4 commit 76eaf86

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/util/symbol_table_base.h

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -181,7 +181,15 @@ class symbol_table_baset
181181
return &**this;
182182
}
183183

184-
symbolt &get_writeable_symbol(const irep_idt &identifier)
184+
/// Whereas the dereference operator gives a constant reference to the
185+
/// current symbol, this method allows users to get a writeable reference
186+
/// to the symbol
187+
/// \remarks
188+
/// This method calls the on_get_writeable method first to give derived
189+
/// symbol table classes the opportunity to note that this symbol is being
190+
/// written to before it is accessed.
191+
/// \returns a non-const reference to the current symbol
192+
symbolt &get_writeable_symbol()
185193
{
186194
if(on_get_writeable)
187195
on_get_writeable((*this)->first);

0 commit comments

Comments
 (0)