* bug#59601: 29.0.50; csharp-mode variables missing prefix
@ 2022-11-26 8:03 Stefan Kangas
2022-11-26 19:16 ` Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors
0 siblings, 1 reply; 5+ messages in thread
From: Stefan Kangas @ 2022-11-26 8:03 UTC (permalink / raw)
To: 59601; +Cc: Theodor Thornhill, Jostein Kjønigsen
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?
^ permalink raw reply [flat|nested] 5+ messages in thread* bug#59601: 29.0.50; csharp-mode variables missing prefix 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 0 siblings, 1 reply; 5+ messages in thread From: Theodor Thornhill via Bug reports for GNU Emacs, the Swiss army knife of text editors @ 2022-11-26 19:16 UTC (permalink / raw) To: Stefan Kangas, 59601; +Cc: acm, Jostein Kjønigsen 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? Theo ^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#59601: 29.0.50; csharp-mode variables missing prefix 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 0 siblings, 1 reply; 5+ messages in thread From: Stefan Kangas @ 2023-09-10 19:30 UTC (permalink / raw) To: Theodor Thornhill; +Cc: acm, 59601, Jostein Kjønigsen 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? ^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#59601: 29.0.50; csharp-mode variables missing prefix 2023-09-10 19:30 ` Stefan Kangas @ 2023-09-10 20:53 ` Alan Mackenzie 2023-09-10 21:30 ` Stefan Kangas 0 siblings, 1 reply; 5+ messages in thread From: Alan Mackenzie @ 2023-09-10 20:53 UTC (permalink / raw) To: Stefan Kangas; +Cc: Jostein Kjønigsen, 59601, Theodor Thornhill, acm 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). ^ permalink raw reply [flat|nested] 5+ messages in thread
* bug#59601: 29.0.50; csharp-mode variables missing prefix 2023-09-10 20:53 ` Alan Mackenzie @ 2023-09-10 21:30 ` Stefan Kangas 0 siblings, 0 replies; 5+ messages in thread From: Stefan Kangas @ 2023-09-10 21:30 UTC (permalink / raw) To: Alan Mackenzie; +Cc: Jostein Kjønigsen, 59601-done, Theodor Thornhill Alan Mackenzie <acm@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. ^ permalink raw reply [flat|nested] 5+ messages in thread
end of thread, other threads:[~2023-09-10 21:30 UTC | newest] Thread overview: 5+ messages (download: mbox.gz / follow: Atom feed) -- links below jump to the message on this page -- 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 2023-09-10 21:30 ` Stefan Kangas
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).