From: Maciej W. Rozycki <macro@embecosm.com>
Date: Wed, 18 Jan 2023 23:23:00 +0000 (+0000)
Subject: GDB: Add missing inline documentation for `add_setshow_cmd_full'
X-Git-Url: https://git.libre-soc.org/?a=commitdiff_plain;h=439ee793446b911989defb21902829519a2a1908;p=binutils-gdb.git

GDB: Add missing inline documentation for `add_setshow_cmd_full'

Complement commit 1d7fe7f01b93 ("gdb: Introduce setting construct
within cmd_list_element") and add missing description for
`add_setshow_cmd_full'.
---

diff --git a/gdb/cli/cli-decode.c b/gdb/cli/cli-decode.c
index c8a3b2e0ecf..72b1f31b0a6 100644
--- a/gdb/cli/cli-decode.c
+++ b/gdb/cli/cli-decode.c
@@ -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,