GNU bug report logs - #59601
29.0.50; csharp-mode variables missing prefix

Previous Next

To add a comment to this bug, you must first unarchive it, by sending
a message to control AT debbugs.gnu.org, with unarchive 59601 in the body.
You can then email your comments to 59601 AT debbugs.gnu.org in the normal way.

Toggle the display of automated, internal messages from the tracker.

Message #5 received at submit <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: 29.0.50; csharp-mode variables missing prefix
Date: Sat, 26 Nov 2022 00:03:45 -0800

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?

Message #8 received at 59601 <at> debbugs.gnu.org (full text, mbox):

From: Theodor Thornhill <theo <at> thornhill.no>
To: Stefan Kangas <stefankangas <at> gmail.com>, 59601 <at> debbugs.gnu.org
Cc: acm <at> muc.de, Jostein Kjønigsen <jostein <at> kjonigsen.net>
Subject: Re: bug#59601: 29.0.50; csharp-mode variables missing prefix
Date: Sat, 26 Nov 2022 20:16:59 +0100

Stefan Kangas <stefankangas <at> 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?

Theo

Message #11 received at 59601 <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Theodor Thornhill <theo <at> thornhill.no>
Cc: acm <at> muc.de, 59601 <at> debbugs.gnu.org,
 Jostein Kjønigsen <jostein <at> kjonigsen.net>
Subject: Re: bug#59601: 29.0.50; csharp-mode variables missing prefix
Date: Sun, 10 Sep 2023 12:30:06 -0700

Theodor Thornhill <theo <at> thornhill.no> writes:

> Stefan Kangas <stefankangas <at> 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?

Message #14 received at 59601 <at> debbugs.gnu.org (full text, mbox):

From: Alan Mackenzie <acm <at> muc.de>
To: Stefan Kangas <stefankangas <at> gmail.com>
Cc: Jostein Kjønigsen <jostein <at> kjonigsen.net>,
 59601 <at> debbugs.gnu.org, Theodor Thornhill <theo <at> thornhill.no>, acm <at> muc.de
Subject: Re: bug#59601: 29.0.50; csharp-mode variables missing prefix
Date: Sun, 10 Sep 2023 20:53:33 +0000

Hello, Theodor and Stefan.

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

> > Stefan Kangas <stefankangas <at> 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).

Message #19 received at 59601-done <at> debbugs.gnu.org (full text, mbox):

From: Stefan Kangas <stefankangas <at> gmail.com>
To: Alan Mackenzie <acm <at> muc.de>
Cc: Jostein Kjønigsen <jostein <at> kjonigsen.net>,
 59601-done <at> debbugs.gnu.org, Theodor Thornhill <theo <at> thornhill.no>
Subject: Re: bug#59601: 29.0.50; csharp-mode variables missing prefix
Date: Sun, 10 Sep 2023 14:30:26 -0700

Alan Mackenzie <acm <at> muc.de> writes:

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

Thank you, that clears things up.  I agree that we should not do any
changes here, and we certainly want to avoid any coupling if we don't
need it.  Thank you for taking the time to explain.

I opened this bug, so I hope that it will be fine if I close it.
I'm therefore doing that with this email.

Previous Next

GNU bug tracking system
Copyright (C) 1999 Darren O. Benham, 1997,2003 nCipher Corporation Ltd, 1994-97 Ian Jackson.