Add comment on has_symbol

NathanJPhillips · NathanJPhillips · commit 3e42a8d6bcd2 · 2017-11-15T10:31:40.000Z
diff --git a/src/util/symbol_table_base.h b/src/util/symbol_table_base.h
@@ -55,6 +55,9 @@ class symbol_table_baset
   }
   virtual const symbol_tablet &get_symbol_table() const = 0;
 
+  /// Check whether a symbol exists in the symbol table
+  /// \param name: The name of the symbol to look for
+  /// \return true if the symbol exists
   bool has_symbol(const irep_idt &name) const
   {
     return symbols.find(name) != symbols.end();

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,9 @@ class symbol_table_baset`
`55`	`55`	`}`
`56`	`56`	`virtual const symbol_tablet &get_symbol_table() const = 0;`
`57`	`57`
	`58`	`+ /// Check whether a symbol exists in the symbol table`
	`59`	`+ /// \param name: The name of the symbol to look for`
	`60`	`+ /// \return true if the symbol exists`
`58`	`61`	`bool has_symbol(const irep_idt &name) const`
`59`	`62`	`{`
`60`	`63`	`return symbols.find(name) != symbols.end();`