gdb: Improve documentation comment on language_defn::print_type

Improves the comment at the declaration of language_defn::print_type.

There should be no user visible changes after this commit.

gdb/ChangeLog:

	* language.h (language_defn::print_type): Add variable names in
	declaration, and update header comment.

diff --git a/gdb/ChangeLog b/gdb/ChangeLog
index 1a4a03cd34c156484179b71d2ceddb12cff4f3cf..6b870f56e64762a359b04e41227fb41b1f0b0827 100644 (file)
--- a/gdb/ChangeLog
+++ b/gdb/ChangeLog
@@ -1,3 +1,8 @@
+2020-10-23  Andrew Burgess  <andrew.burgess@embecosm.com>
+
+       * language.h (language_defn::print_type): Add variable names in
+       declaration, and update header comment.
+
 2020-10-23  Andrew Burgess  <andrew.burgess@embecosm.com>
 
        * ada-lang.c (ada_language::demangle): Rename to...

diff --git a/gdb/language.h b/gdb/language.h
index 106d7667527874115aeb0ed8b52b596211794b6c..951343fd9a303d98d2df98d24531e8a8e9c1ceb7 100644 (file)
--- a/gdb/language.h
+++ b/gdb/language.h
@@ -333,10 +333,14 @@ struct language_defn
     return nullptr;
   }
 
-  /* Print a type using syntax appropriate for this language.  */
-
-  virtual void print_type (struct type *, const char *, struct ui_file *, int,
-                          int, const struct type_print_options *) const = 0;
+  /* Print TYPE to STREAM using syntax appropriate for this language.
+     LEVEL is the depth to indent lines by.  VARSTRING, if not NULL or the
+     empty string, is the name of a variable and TYPE should be printed in
+     the form of a declaration of a variable named VARSTRING.  */
+
+  virtual void print_type (struct type *type, const char *varstring,
+                          struct ui_file *stream, int show, int level,
+                          const struct type_print_options *flags) const = 0;
 
   /* PC is possibly an unknown languages trampoline.
      If that PC falls in a trampoline belonging to this language, return