unofficial mirror of bug-gnu-emacs@gnu.org 
 help / color / mirror / code / Atom feed
From: Alan Mackenzie <acm@muc.de>
To: Stefan Kangas <stefankangas@gmail.com>
Cc: "Jostein Kjønigsen" <jostein@kjonigsen.net>,
	59601@debbugs.gnu.org, "Theodor Thornhill" <theo@thornhill.no>,
	acm@muc.de
Subject: bug#59601: 29.0.50; csharp-mode variables missing prefix
Date: Sun, 10 Sep 2023 20:53:33 +0000	[thread overview]
Message-ID: <ZP4szViIuntf42zE@ACM> (raw)
In-Reply-To: <CADwFkmkayt7MXDZJkoOaw5hkE9ygRdj4tDhe2g4D-PjeO8FRzQ@mail.gmail.com>

Hello, Theodor and Stefan.

On Sun, Sep 10, 2023 at 12:30:06 -0700, Stefan Kangas wrote:
> Theodor Thornhill <theo@thornhill.no> writes:

> > Stefan Kangas <stefankangas@gmail.com> writes:

> >> Severity: wishlist

> >> Should these variables have the prefix `csharp-'?

> >>     `codedoc-font-lock-doc-comments'
> >>     `codedoc-font-lock-keywords'

> >> I also see that `codedoc-font-lock-keywords' seems to be unused?

> > I believe they need to be like this, for some CC Mode magic reason. See
> > `javadoc-font-lock-keywords' and friends.  I believe CC Mode picks them
> > up and that they should follow that naming convention.  I've CC'd Alan
> > just to confirm.  If you agree Alan then they could be part of
> > cc-fonts.el now that csharp-mode is in core.  What do you think?

> Ping.  Alan, do you have any comments?

Sorry I missed your (Theodor's) post ~10 months ago.

The codedoc variables should _not_ have a csharp- prefix.  Conceptually,
codedoc is not part of csharp-mode, and could start being used by any CC
Mode mode, just as gtkdoc is used by both C and C++ modes.

Also, "codedoc" (like "gtkdoc", etc.) is prefixed to
"-font-lock-doc-comments" and the result interned to get the function to
fontify the doc comments.  Thus codedoc-font-lock-doc-comments _will_ be
getting used.

So, yes, the naming convention is essential to the working of CC Mode's
doc comments.

Whether it would be the Right Thing to add codedoc to CC Mode itself,
I'm not sure.  doxygen was added quite recently, but that is genuinely a
language independent format.  I'm a little worried about getting some
coupling between, say, csharp-mode and CC Mode where there wasn't any
before.

-- 
Alan Mackenzie (Nuremberg, Germany).





  reply	other threads:[~2023-09-10 20:53 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2022-11-26  8:03 bug#59601: 29.0.50; csharp-mode variables missing prefix Stefan Kangas
2022-11-26 19:16 ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
2023-09-10 19:30   ` Stefan Kangas
2023-09-10 20:53     ` Alan Mackenzie [this message]
2023-09-10 21:30       ` Stefan Kangas

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

  List information: https://www.gnu.org/software/emacs/

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

  git send-email \
    --in-reply-to=ZP4szViIuntf42zE@ACM \
    --to=acm@muc.de \
    --cc=59601@debbugs.gnu.org \
    --cc=jostein@kjonigsen.net \
    --cc=stefankangas@gmail.com \
    --cc=theo@thornhill.no \
    /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.
Code repositories for project(s) associated with this public inbox

	https://git.savannah.gnu.org/cgit/emacs.git

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).