public inbox for gcc-bugs@sourceware.org
help / color / mirror / Atom feed
From: "giecrilj at stegny dot 2a.pl" <gcc-bugzilla@gcc.gnu.org>
To: gcc-bugs@gcc.gnu.org
Subject: [Bug libstdc++/97001] API documentation should mention the minimum dialect
Date: Sat, 03 Jul 2021 15:55:13 +0000	[thread overview]
Message-ID: <bug-97001-4-1KZAa0M137@http.gcc.gnu.org/bugzilla/> (raw)
In-Reply-To: <bug-97001-4@http.gcc.gnu.org/bugzilla/>

https://gcc.gnu.org/bugzilla/show_bug.cgi?id=97001

--- Comment #3 from Christopher Yeleighton <giecrilj at stegny dot 2a.pl> ---
The problem with a module-level @since is that std:: symbols are easiest to
locate in the std namespace (which provides a huge index of everything).  Items
that are undocumented (there is a lot of them) in the namespace index are not
attributed to any module and the definition line is not available for them
either, so the reader needs a priori knowledge of which symbols belong to which
module.  While it is possible to guess the matching module with some
experience, just adding dummy documentation to those symbols (as a few of other
symbols have) would help navigating the API (also because the definition
sometimes is readable enough to be used instead of documentation).  Of course,
the fact that Doxygen bugs prevent some of the symbols from appearing in the
corresponding modules only adds to the general feeling of helplessness.

  parent reply	other threads:[~2021-07-03 15:55 UTC|newest]

Thread overview: 6+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-09-09 15:20 [Bug libstdc++/97001] New: API documentation should have a " giecrilj at stegny dot 2a.pl
2020-09-09 15:39 ` [Bug libstdc++/97001] API documentation should mention the " redi at gcc dot gnu.org
2021-07-01 18:24 ` cvs-commit at gcc dot gnu.org
2021-07-03 15:55 ` giecrilj at stegny dot 2a.pl [this message]
2021-07-03 19:44 ` redi at gcc dot gnu.org
2021-08-11 15:42 ` cvs-commit at gcc dot gnu.org

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=bug-97001-4-1KZAa0M137@http.gcc.gnu.org/bugzilla/ \
    --to=gcc-bugzilla@gcc.gnu.org \
    --cc=gcc-bugs@gcc.gnu.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).