GDB: Add missing inline documentation for `add_setshow_cmd_full'
authorMaciej W. Rozycki <macro@embecosm.com>
Wed, 18 Jan 2023 23:23:00 +0000 (23:23 +0000)
committerMaciej W. Rozycki <macro@embecosm.com>
Wed, 18 Jan 2023 23:23:00 +0000 (23:23 +0000)
Complement commit 1d7fe7f01b93 ("gdb: Introduce setting construct
within cmd_list_element") and add missing description for
`add_setshow_cmd_full'.

gdb/cli/cli-decode.c

index c8a3b2e0ecf14943e653280aed2e1c4298188d42..72b1f31b0a6033da186a6c5251a2bda1410d14c0 100644 (file)
@@ -580,6 +580,18 @@ add_setshow_cmd_full_erased (const char *name,
   return {set, show};
 }
 
+/* Add element named NAME to both command lists SET_LIST and SHOW_LIST.
+   THECLASS is as in add_cmd.  VAR_TYPE is the kind of thing we are
+   setting.  VAR is address of the variable being controlled by this
+   command.  If nullptr is given as VAR, then both SET_SETTING_FUNC and
+   GET_SETTING_FUNC must be provided.  SET_SETTING_FUNC and GET_SETTING_FUNC
+   are callbacks used to access and modify the underlying property,
+   whatever its storage is.  SET_FUNC and SHOW_FUNC are the callback
+   functions (if non-NULL).  SET_DOC, SHOW_DOC and HELP_DOC are the
+   documentation strings.
+
+   Return the newly created set and show commands.  */
+
 template<typename T>
 static set_show_commands
 add_setshow_cmd_full (const char *name,