Improve the doc string for the elf_symbol::get_id_string() method

	* src/abg-ir.cc (elf_symbol::get_id_string): Improve doc string.
	Talk about the content of the id string of an elf symbol.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>

diff --git a/src/abg-ir.cc b/src/abg-ir.cc
index a19e8ecdb482a88bbf07ea82cfd35fd32d2069a0..d2e906767ecab604f7b97ca949cc3147f694b8e1 100644 (file)
--- a/src/abg-ir.cc
+++ b/src/abg-ir.cc
@@ -582,6 +582,14 @@ elf_symbol::add_alias(elf_symbol* alias)
 
 /// Get a string that is representative of a given elf_symbol.
 ///
+/// If the symbol has a version, then the ID string is the
+/// concatenation of the name of the symbol, the '@' character, and
+/// the version of the symbol.  If the version is the default version
+/// of the symbol then the '@' character is replaced by a "@@" string.
+///
+/// Otherwise, if the symbol does not have any version, this function
+/// returns the name of the symbol.
+///
 /// @return a the ID string.
 const string&
 elf_symbol::get_id_string() const