public inbox for gdb-cvs@sourceware.org
help / color / mirror / Atom feed
From: Maciej W. Rozycki <macro@sourceware.org>
To: gdb-cvs@sourceware.org
Subject: [binutils-gdb] GDB: Add missing inline documentation for `add_setshow_cmd_full'
Date: Wed, 18 Jan 2023 23:24:11 +0000 (GMT)	[thread overview]
Message-ID: <20230118232411.8A6573858C62@sourceware.org> (raw)

https://sourceware.org/git/gitweb.cgi?p=binutils-gdb.git;h=439ee793446b911989defb21902829519a2a1908

commit 439ee793446b911989defb21902829519a2a1908
Author: Maciej W. Rozycki <macro@embecosm.com>
Date:   Wed Jan 18 23:23:00 2023 +0000

    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:
---
 gdb/cli/cli-decode.c | 12 ++++++++++++
 1 file changed, 12 insertions(+)

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,

                 reply	other threads:[~2023-01-18 23:24 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230118232411.8A6573858C62@sourceware.org \
    --to=macro@sourceware.org \
    --cc=gdb-cvs@sourceware.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).