Document ada_remove_trailing_digits more

gdb/ChangeLog:

        * ada-lang.c (ada_remove_trailing_digits): Expand documentation.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index d10df1c..3c8f30d 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,7 @@
+2011-07-01  Joel Brobecker  <brobecker@adacore.com>
+
+       * ada-lang.c (ada_remove_trailing_digits): Expand documentation.
+
 2011-06-30  Tom Tromey  <tromey@redhat.com>
 
        * varobj.c (varobj_create): Call do_cleanups on early exit path.

diff --git a/gdb/ada-lang.c b/gdb/ada-lang.c
index a3234fb..4f6e161 100644 (file)
--- a/gdb/ada-lang.c
+++ b/gdb/ada-lang.c
@@ -900,11 +900,14 @@ is_lower_alphanum (const char c)
   return (isdigit (c) || (isalpha (c) && islower (c)));
 }
 
-/* Remove either of these suffixes:
+/* ENCODED is the linkage name of a symbol and LEN contains its length.
+   This function saves in LEN the length of that same symbol name but
+   without either of these suffixes:
      . .{DIGIT}+
      . ${DIGIT}+
      . ___{DIGIT}+
      . __{DIGIT}+.
+
    These are suffixes introduced by the compiler for entities such as
    nested subprogram for instance, in order to avoid name clashes.
    They do not serve any purpose for the debugger.  */