From 501d5ab50253ce7e2ee14fbcd15477d275f7c589 Mon Sep 17 00:00:00 2001 From: Dodji Seketeli Date: Fri, 12 Dec 2014 11:08:30 +0100 Subject: [PATCH] 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 --- src/abg-ir.cc | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/src/abg-ir.cc b/src/abg-ir.cc index a19e8ecd..d2e90676 100644 --- 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 -- 2.43.5