From 76eaf8667600902d069d2f4a62827c34b510d517 Mon Sep 17 00:00:00 2001 From: Nathan Phillips Date: Thu, 28 Jun 2018 15:37:55 +0100 Subject: [PATCH] Doxygen comment on get_writeable_symbol Also removed unused parameter that was originally intended to be used as a safety check --- src/util/symbol_table_base.h | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/src/util/symbol_table_base.h b/src/util/symbol_table_base.h index 013649b173f..7fdc84c0add 100644 --- a/src/util/symbol_table_base.h +++ b/src/util/symbol_table_base.h @@ -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);