Fix apidoc of dwarf_reader::get_soname_of_elf_file
authorDodji Seketeli <dodji@redhat.com>
Fri, 31 Aug 2018 07:31:41 +0000 (09:31 +0200)
committerDodji Seketeli <dodji@redhat.com>
Fri, 31 Aug 2018 07:31:41 +0000 (09:31 +0200)
It turned out the first parameter of
abigail::dwarf_reader::get_soname_of_elf_file was not documented.
Fixed thus.

* src/abg-dwarf-reader.cc (get_soname_of_elf_file): Document the
first parameter.  Remove bogus documentation of the previous 'elf'
parameter.

Signed-off-by: Dodji Seketeli <dodji@redhat.com>
src/abg-dwarf-reader.cc

index 890ac10..cef9c5a 100644 (file)
@@ -16237,7 +16237,7 @@ has_alt_debug_info(const string&        elf_path,
 
 /// Fetch the SONAME ELF property from an ELF binary file.
 ///
-/// @param elf The handler of an ELF binary file.
+/// @param path The path to the elf file to consider.
 ///
 /// @param soname out parameter. Set to the SONAME property of the
 /// binary file, if it present in the ELF file.