GNU bug report logs - #11865
doxygen syntax not enabled in c++-mode & /** single line comments */

Previous Next

Packages: emacs, cc-mode;

Reported by: Toon Claes <toon <at> tonotdo.com>

Date: Thu, 5 Jul 2012 11:52:02 UTC

Severity: minor

Tags: fixed, patch

Found in versions 25.2, 24.1.50

Fixed in version 27.1

Done: "Basil L. Contovounesios" <contovob <at> tcd.ie>

Bug is archived. No further changes may be made.

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

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

View this report as an mbox folder, status mbox, maintainer mbox


Report forwarded to bug-gnu-emacs <at> gnu.org:
bug#11865; Package emacs. (Thu, 05 Jul 2012 11:52:02 GMT) Full text and rfc822 format available.

Acknowledgement sent to Toon Claes <toon <at> tonotdo.com>:
New bug report received and forwarded. Copy sent to bug-gnu-emacs <at> gnu.org. (Thu, 05 Jul 2012 11:52:02 GMT) Full text and rfc822 format available.

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

From: Toon Claes <toon <at> tonotdo.com>
To: <bug-gnu-emacs <at> gnu.org>
Cc: toon <at> tonotdo.com
Subject: 24.1.50; doxygen comments not highlighted in c++-mode
Date: Thu, 05 Jul 2012 13:46:42 +0200
[Message part 1 (text/plain, inline)]
 

I am using doxygen.org to comment code (and generate
documentation
from it). This requires a dedicated commenting style,
e.g.:

 /**
 * This is a doxygen comment
 * @param par this is a
parameter for this function
 * @return this is what is returned by the
function
 */
 bool my_function(int par);

When this snippet is viewed
with major mode 'c-mode', the @-keywords are
highlighted. When you set
the major mode to 'c++-mode', this is not the
case.

So for some reason
this additional highlighting is not enabled for
c++. I am not sure if
this is a bug, or disabled on purpose. Anyhow,
using doxygen for c++ is
valid.

Also it seems the doxygen highlighting does not work when you
type
comments on the same line as the '/**', e.g. like this:
 /** This
comment is not doxygen-highlighted
 */

Regards,
Toon

In GNU Emacs
24.1.50.1 (i686-suse-linux-gnu, X toolkit)
 of 2012-06-20 on
suse12-tcl
Bzr revision: 108664
eggert <at> cs.ucla.edu-20120619185739-mile4zpnjrqz5e8e
Windowing system
distributor `The X.Org Foundation', version 11.0.11004000
Configured
using:
 `configure '--without-toolkit-scroll-bars''

Important
settings:
 value of $LC_CTYPE: en_US.UTF-8
 value of $LANG: en_US.UTF-8

value of $XMODIFIERS: @im=local
 locale-coding-system: utf-8-unix

default enable-multibyte-characters: t

Major mode: C++/l

Minor modes
in effect:
 tooltip-mode: t
 mouse-wheel-mode: t
 tool-bar-mode: t

menu-bar-mode: t
 file-name-shadow-mode: t
 global-font-lock-mode: t

font-lock-mode: t
 blink-cursor-mode: t
 auto-composition-mode: t

auto-encryption-mode: t
 auto-compression-mode: t
 line-number-mode: t

transient-mark-mode: t
 abbrev-mode: t

Recent input:
C-x C-f <up> / t o
k <tab> s <tab> 2 <tab> T o <tab> 
C o m <tab> O b <tab> O b <tab> S
<tab> m <tab> S <tab> 
S r <backspace> <tab> <return> C-s r e b o o t
C-a 
C-n C-n C-n M-x c + + m <backspace> - m o d e <return> 
M-x f u
<backspace> <backspace> <help-echo> M-x r e 
p o r t - <tab>
<return>

Recent messages:
For information about GNU Emacs and the GNU
system, type C-h C-a.
user-error: Beginning of history; no preceding
item
Making completion list...
Note: file is write protected
Loading
cc-langs...done
Mark saved where search started
completing-read-default:
Command attempted to use minibuffer while in minibuffer

Load-path
shadows:
None found.

Features:
(shadow sort gnus-util mail-extr
emacsbug message cl-macs format-spec
rfc822 mml mml-sec mm-decode
mm-bodies mm-encode mail-parse rfc2231
mailabbrev gmm-utils mailheader
sendmail rfc2047 rfc2045 ietf-drums
mm-util mail-prsvr mail-utils
multi-isearch cc-langs cl macroexp cl-lib
cc-mode cc-fonts cc-guess
cc-menus cc-cmds cc-styles cc-align cc-engine
cc-vars cc-defs help-mode
easymenu view time-date tooltip ediff-hook
vc-hooks lisp-float-type
mwheel x-win x-dnd tool-bar dnd fontset image
regexp-opt fringe
tabulated-list newcomment lisp-mode register page
menu-bar rfn-eshadow
timer select scroll-bar mouse jit-lock font-lock
syntax facemenu
font-core frame cham georgian utf-8-lang misc-lang
vietnamese tibetan
thai tai-viet lao korean japanese hebrew greek
romanian slovak czech
european ethiopic indian cyrillic chinese
case-table epa-hook
jka-cmpr-hook help simple abbrev minibuffer loaddefs
button faces
cus-face files text-properties overlay sha1 md5 base64
format env
code-pages mule custom widget hashtable-print-readable
backquote
make-network-process dbusbind dynamic-setting
system-font-setting
font-render-setting x-toolkit x multi-tty emacs)

 
[Message part 2 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Fri, 06 Jul 2012 14:06:01 GMT) Full text and rfc822 format available.

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

From: Toon Claes <toon <at> tonotdo.com>
To: <11865 <at> debbugs.gnu.org>
Subject: 24.1.50; doxygen comments not highlighted in c++-mode
Date: Fri, 06 Jul 2012 16:00:17 +0200
[Message part 1 (text/plain, inline)]
 

I think I've found the solution. Please consider this patch: 

===
modified file 'lisp/ChangeLog'
--- lisp/ChangeLog 2012-07-06 13:50:37
+0000
+++ lisp/ChangeLog 2012-07-06 07:08:10 +0000
@@ -1,11 +1,3
@@
-2012-07-06 Toon Claes <toon <at> tonotdo.com>
-
- * progmodes/cc-fonts.el
(gtkdoc-font-lock-keywords):
- Less restrictive checking for gtkdoc.
-
-
* progmodes/cc-vars.el: For c++-mode set gtkdoc the default
-
c-doc-comment-style.
-
 2012-07-06 Glenn Morris <rgm <at> gnu.org>

 *
Makefile.in (compile-one-process): Rename from "recompile".

===
modified file 'lisp/progmodes/cc-fonts.el'
---
lisp/progmodes/cc-fonts.el 2012-07-06 13:50:37 +0000
+++
lisp/progmodes/cc-fonts.el 2012-01-19 07:21:25 +0000
@@ -2572,7 +2572,7
@@

 (defconst gtkdoc-font-lock-keywords
 `((,(lambda (limit)
-
(c-font-lock-doc-comments "/\*\*\([^\*/].*\)?$" limit
+
(c-font-lock-doc-comments "/\*\*$" limit

gtkdoc-font-lock-doc-comments)
 (c-font-lock-doc-comments "/\*< " limit

gtkdoc-font-lock-doc-protection)

=== modified file
'lisp/progmodes/cc-vars.el'
--- lisp/progmodes/cc-vars.el 2012-07-06
13:50:37 +0000
+++ lisp/progmodes/cc-vars.el 2012-02-11 22:13:29
+0000
@@ -552,8 +552,7 @@
 (defcustom-c-stylevar c-doc-comment-style

'((java-mode . javadoc)
 (pike-mode . autodoc)
- (c-mode . gtkdoc)
-
(c++-mode . gtkdoc))
+ (c-mode . gtkdoc))
 "*Specifies documentation
comment style(s) to recognize.
 This is primarily used to fontify doc
comments and the markup within
 them, e.g. Javadoc comments.
@@ -563,7
+562,7 @@

 javadoc -- Javadoc style for "/** ... */" comments (default
in Java mode).
 autodoc -- Pike autodoc style for "//! ..." comments
(default in Pike mode).
- gtkdoc -- GtkDoc style for "/** ... **/"
comments (default in C/C++ mode).
+ gtkdoc -- GtkDoc style for "/** ...
**/" comments (default in C mode).

 The value may also be a list of doc
comment styles, in which case all
 of them are recognized simultaneously
(presumably with markup cues

 
[Message part 2 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Tue, 10 Jul 2012 07:05:02 GMT) Full text and rfc822 format available.

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

From: Toon Claes <toon <at> tonotdo.com>
To: <11865 <at> debbugs.gnu.org>
Cc: toon <at> tonotdo.com
Subject: Re: 24.1.50; doxygen comments not highlighted in c++-mode
Date: Tue, 10 Jul 2012 08:59:24 +0200
Excuse me, previous patch was incorrect. This one should be better

---

=== modified file 'lisp/ChangeLog'
--- lisp/ChangeLog 2012-07-06 07:08:10 +0000
+++ lisp/ChangeLog 2012-07-06 13:48:51 +0000
@@ -1,3 +1,11 @@
+2012-07-06 Toon Claes <toon <at> tonotdo.com>
+
+ * progmodes/cc-fonts.el (gtkdoc-font-lock-keywords):
+ Less restrictive checking for gtkdoc.
+
+ * progmodes/cc-vars.el: For c++-mode set gtkdoc the default
+ c-doc-comment-style.
+
 2012-07-06 Glenn Morris <rgm <at> gnu.org>

 * Makefile.in (compile-one-process): Rename from "recompile".

=== modified file 'lisp/progmodes/cc-fonts.el'
--- lisp/progmodes/cc-fonts.el 2012-01-19 07:21:25 +0000
+++ lisp/progmodes/cc-fonts.el 2012-07-06 13:49:00 +0000
@@ -2572,7 +2572,7 @@

 (defconst gtkdoc-font-lock-keywords
 `((,(lambda (limit)
- (c-font-lock-doc-comments "/\*\*$" limit
+ (c-font-lock-doc-comments "/\*\*\([^\*/].*\)?$" limit
 gtkdoc-font-lock-doc-comments)
 (c-font-lock-doc-comments "/\*< " limit
 gtkdoc-font-lock-doc-protection)

=== modified file 'lisp/progmodes/cc-vars.el'
--- lisp/progmodes/cc-vars.el 2012-02-11 22:13:29 +0000
+++ lisp/progmodes/cc-vars.el 2012-07-06 13:48:46 +0000
@@ -552,7 +552,8 @@
 (defcustom-c-stylevar c-doc-comment-style
 '((java-mode . javadoc)
 (pike-mode . autodoc)
- (c-mode . gtkdoc))
+ (c-mode . gtkdoc)
+ (c++-mode . gtkdoc))
 "*Specifies documentation comment style(s) to recognize.
 This is primarily used to fontify doc comments and the markup within
 them, e.g. Javadoc comments.
@@ -562,7 +563,7 @@

 javadoc -- Javadoc style for "/** ... */" comments (default in Java 
mode).
 autodoc -- Pike autodoc style for "//! ..." comments (default in Pike
mode).
- gtkdoc -- GtkDoc style for "/** ... **/" comments (default in C 
mode).
+ gtkdoc -- GtkDoc style for "/** ... **/" comments (default in C/C++
mode).

 The value may also be a list of doc comment styles, in which case all
 of them are recognized simultaneously (presumably with markup cues




Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Wed, 05 Jun 2013 08:28:01 GMT) Full text and rfc822 format available.

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

From: Toon Claes <toon <at> tonotdo.com>
To: <11865 <at> debbugs.gnu.org>
Subject: Fwd: Re: 24.1.50; doxygen comments not highlighted in c++-mode
Date: Wed, 05 Jun 2013 10:24:56 +0200
Tags: patch

Resubmitting my patch (with correct "Tags: patch" this time) in hope it 
finally gets merged.

---

=== modified file 'lisp/ChangeLog'
--- lisp/ChangeLog 2012-07-06 07:08:10 +0000
+++ lisp/ChangeLog 2012-07-06 13:48:51 +0000
@@ -1,3 +1,11 @@
+2012-07-06 Toon Claes <toon <at> tonotdo.com>
+
+	* progmodes/cc-fonts.el (gtkdoc-font-lock-keywords): Better gtkdoc
+	parsing.
+
+	* progmodes/cc-vars.el (c-doc-comment-style): Use gtkdoc as default
+	for C++.
+
 2012-07-06 Glenn Morris <rgm <at> gnu.org>

 	* Makefile.in (compile-one-process): Rename from "recompile".

=== modified file 'lisp/progmodes/cc-fonts.el'
--- lisp/progmodes/cc-fonts.el 2012-01-19 07:21:25 +0000
+++ lisp/progmodes/cc-fonts.el 2012-07-06 13:49:00 +0000
@@ -2572,7 +2572,7 @@

 (defconst gtkdoc-font-lock-keywords
 `((,(lambda (limit)
- (c-font-lock-doc-comments "/**$" limit
+ (c-font-lock-doc-comments "/**([^*/].*)?$" limit
 gtkdoc-font-lock-doc-comments)
 (c-font-lock-doc-comments "/*< " limit
 gtkdoc-font-lock-doc-protection)

=== modified file 'lisp/progmodes/cc-vars.el'
--- lisp/progmodes/cc-vars.el 2012-02-11 22:13:29 +0000
+++ lisp/progmodes/cc-vars.el 2012-07-06 13:48:46 +0000
@@ -552,7 +552,8 @@
 (defcustom-c-stylevar c-doc-comment-style
 '((java-mode . javadoc)
 (pike-mode . autodoc)
- (c-mode . gtkdoc))
+ (c-mode . gtkdoc)
+ (c++-mode . gtkdoc))
 "*Specifies documentation comment style(s) to recognize.
 This is primarily used to fontify doc comments and the markup within
 them, e.g. Javadoc comments.
@@ -562,7 +563,7 @@

 javadoc -- Javadoc style for "/** ... */" comments (default in Java
mode).
 autodoc -- Pike autodoc style for "//! ..." comments (default in Pike
mode).
- gtkdoc -- GtkDoc style for "/** ... **/" comments (default in C
mode).
+ gtkdoc -- GtkDoc style for "/** ... **/" comments (default in C/C++
mode).

 The value may also be a list of doc comment styles, in which case all
 of them are recognized simultaneously (presumably with markup cues




Added tag(s) patch. Request was from Toon Claes <toon <at> tonotdo.com> to control <at> debbugs.gnu.org. (Wed, 05 Jun 2013 09:19:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Wed, 24 Feb 2016 06:31:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Toon Claes <toon <at> tonotdo.com>
Cc: 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: 24.1.50; doxygen comments not highlighted in c++-mode
Date: Wed, 24 Feb 2016 17:29:32 +1100
Toon Claes <toon <at> tonotdo.com> writes:

> +2012-07-06 Toon Claes <toon <at> tonotdo.com>
> +
> + * progmodes/cc-fonts.el (gtkdoc-font-lock-keywords):
> + Less restrictive checking for gtkdoc.
> +
> + * progmodes/cc-vars.el: For c++-mode set gtkdoc the default
> + c-doc-comment-style.
> +

[...]

I am completely unfamiliar with the gtkdoc format, so I can't really
judge whether this makes sense or not.  Anybody?

> === modified file 'lisp/progmodes/cc-fonts.el'
> --- lisp/progmodes/cc-fonts.el 2012-01-19 07:21:25 +0000
> +++ lisp/progmodes/cc-fonts.el 2012-07-06 13:49:00 +0000
> @@ -2572,7 +2572,7 @@
>
>  (defconst gtkdoc-font-lock-keywords
>  `((,(lambda (limit)
> - (c-font-lock-doc-comments "/\*\*$" limit
> + (c-font-lock-doc-comments "/\*\*\([^\*/].*\)?$" limit
>  gtkdoc-font-lock-doc-comments)
>  (c-font-lock-doc-comments "/\*< " limit
>  gtkdoc-font-lock-doc-protection)
>
> === modified file 'lisp/progmodes/cc-vars.el'
> --- lisp/progmodes/cc-vars.el 2012-02-11 22:13:29 +0000
> +++ lisp/progmodes/cc-vars.el 2012-07-06 13:48:46 +0000
> @@ -552,7 +552,8 @@
>  (defcustom-c-stylevar c-doc-comment-style
>  '((java-mode . javadoc)
>  (pike-mode . autodoc)
> - (c-mode . gtkdoc))
> + (c-mode . gtkdoc)
> + (c++-mode . gtkdoc))
>  "*Specifies documentation comment style(s) to recognize.
>  This is primarily used to fontify doc comments and the markup within
>  them, e.g. Javadoc comments.
> @@ -562,7 +563,7 @@
>
>  javadoc -- Javadoc style for "/** ... */" comments (default in Java
> mode).
>  autodoc -- Pike autodoc style for "//! ..." comments (default in Pike
> mode).
> - gtkdoc -- GtkDoc style for "/** ... **/" comments (default in C
> mode).
> + gtkdoc -- GtkDoc style for "/** ... **/" comments (default in C/C++
> mode).
>
>  The value may also be a list of doc comment styles, in which case all
>  of them are recognized simultaneously (presumably with markup cues
>
>
>
>

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Thu, 25 Feb 2016 06:02:01 GMT) Full text and rfc822 format available.

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

From: Anders Lindgren <andlind <at> gmail.com>
To: 11865 <at> debbugs.gnu.org, Lars Ingebrigtsen <larsi <at> gnus.org>
Subject: Re: 24.1.50; doxygen comments not highlighted in c++-mode
Date: Thu, 25 Feb 2016 07:01:54 +0100
[Message part 1 (text/plain, inline)]
The changes looks OK. However, the "gtk" format is only a subset of the
Doxygen format.

For example, doxygen can use "\command" as well as "@command". Also, "//!"
or "/*!" can start a doxygen comment.

(As I side note, I have a back burner project implementing highlighting for
doxygen comments. However, it's been stalled due to problems with
installing custom c-doc packages.)

    -- Anders
[Message part 2 (text/html, inline)]

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Fri, 26 Feb 2016 03:38:02 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Toon Claes <toon <at> tonotdo.com>
Cc: 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50;
 doxygen comments not highlighted in c++-mode
Date: Fri, 26 Feb 2016 14:07:05 +1030
Toon Claes <toon <at> tonotdo.com> writes:

>  (defconst gtkdoc-font-lock-keywords
>  `((,(lambda (limit)
> - (c-font-lock-doc-comments "/**$" limit
> + (c-font-lock-doc-comments "/**([^*/].*)?$" limit

Can this be correct, though?  It would mean that /** foo / **/ wouldn't
be a comment...  and anyway, the /** is invalid as a regexp, anyway.

The current code looks like

(defconst gtkdoc-font-lock-keywords
  `((,(lambda (limit)
	(c-font-lock-doc-comments "/\\*\\*$" limit
	  gtkdoc-font-lock-doc-comments)
	(c-font-lock-doc-comments "/\\*< " limit
	  gtkdoc-font-lock-doc-protection)
	))))

Which looks more correct anyway.  So I think this has already been fixed
in a different manner, and I'm closing this bug report.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Added tag(s) fixed. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Fri, 26 Feb 2016 03:38:02 GMT) Full text and rfc822 format available.

bug closed, send any further explanations to 11865 <at> debbugs.gnu.org and Toon Claes <toon <at> tonotdo.com> Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Fri, 26 Feb 2016 03:38:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Fri, 26 Feb 2016 10:24:02 GMT) Full text and rfc822 format available.

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

From: Toon Claes <toon <at> iotcl.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Toon Claes <toon <at> tonotdo.com>, 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50;
 doxygen comments not highlighted in c++-mode
Date: Fri, 26 Feb 2016 09:03:27 +0100
[Message part 1 (text/plain, inline)]
Hi,

I do not really agree.

Let me explain in detail.
Only comment blocks like the following were recognized as gtkdoc:
/**
 * This is the gtkdoc comment
 */

I wanted also gtkdoc styling to be applied to:
/** This should be gtkdoc comment too */

I admit, the regexp I wrote back in the day was not correctly escaped.
But I was trying to achieve comments with 3 or more asterisks would not get styled like gtkdoc comments.


Gr,
Toon


> On 26 Feb 2016, at 04:37, Lars Ingebrigtsen <larsi <at> gnus.org> wrote:
> 
> Toon Claes <toon <at> tonotdo.com> writes:
> 
>> (defconst gtkdoc-font-lock-keywords
>> `((,(lambda (limit)
>> - (c-font-lock-doc-comments "/**$" limit
>> + (c-font-lock-doc-comments "/**([^*/].*)?$" limit
> 
> Can this be correct, though?  It would mean that /** foo / **/ wouldn't
> be a comment...  and anyway, the /** is invalid as a regexp, anyway.
> 
> The current code looks like
> 
> (defconst gtkdoc-font-lock-keywords
>  `((,(lambda (limit)
> 	(c-font-lock-doc-comments "/\\*\\*$" limit
> 	  gtkdoc-font-lock-doc-comments)
> 	(c-font-lock-doc-comments "/\\*< " limit
> 	  gtkdoc-font-lock-doc-protection)
> 	))))
> 
> Which looks more correct anyway.  So I think this has already been fixed
> in a different manner, and I'm closing this bug report.
> 
> --
> (domestic pets only, the antidote for overdose, milk.)
>   bloggy blog: http://lars.ingebrigtsen.no

[signature.asc (application/pgp-signature, attachment)]

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Sat, 27 Feb 2016 04:06:01 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Toon Claes <toon <at> iotcl.com>
Cc: Toon Claes <toon <at> tonotdo.com>, 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50;
 doxygen comments not highlighted in c++-mode
Date: Sat, 27 Feb 2016 14:34:29 +1030
Toon Claes <toon <at> iotcl.com> writes:

> I do not really agree.
>
> Let me explain in detail.
> Only comment blocks like the following were recognized as gtkdoc:
> /**
>  * This is the gtkdoc comment
>  */
>
> I wanted also gtkdoc styling to be applied to:
> /** This should be gtkdoc comment too */
>
> I admit, the regexp I wrote back in the day was not correctly escaped.
> But I was trying to achieve comments with 3 or more asterisks would
> not get styled like gtkdoc comments.

Can you supply a patch that will give the correct styling?

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Did not alter fixed versions and reopened. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Sat, 27 Feb 2016 04:06:02 GMT) Full text and rfc822 format available.

Removed tag(s) patch. Request was from Lars Ingebrigtsen <larsi <at> gnus.org> to control <at> debbugs.gnu.org. (Sat, 27 Feb 2016 04:06:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Thu, 10 Mar 2016 16:34:03 GMT) Full text and rfc822 format available.

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

From: Toon Claes <toon <at> iotcl.com>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Toon Claes <toon <at> tonotdo.com>, 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50;
 doxygen comments not highlighted in c++-mode
Date: Thu, 10 Mar 2016 09:58:56 +0100
[Message part 1 (text/plain, inline)]
Hi Lars,

Find the patch attached.
The regexp is written to match:
/** gtkdoc */
/**
 * gtkdoc
 */

And to not match:
/*******/


Kind regards,
Toon


[0001-Fix-Bug-11865.patch (application/octet-stream, attachment)]
[Message part 3 (text/plain, inline)]

> On 27 Feb 2016, at 05:04, Lars Ingebrigtsen <larsi <at> gnus.org> wrote:
> 
> Toon Claes <toon <at> iotcl.com> writes:
> 
>> I do not really agree.
>> 
>> Let me explain in detail.
>> Only comment blocks like the following were recognized as gtkdoc:
>> /**
>> * This is the gtkdoc comment
>> */
>> 
>> I wanted also gtkdoc styling to be applied to:
>> /** This should be gtkdoc comment too */
>> 
>> I admit, the regexp I wrote back in the day was not correctly escaped.
>> But I was trying to achieve comments with 3 or more asterisks would
>> not get styled like gtkdoc comments.
> 
> Can you supply a patch that will give the correct styling?
> 
> --
> (domestic pets only, the antidote for overdose, milk.)
>   bloggy blog: http://lars.ingebrigtsen.no

[signature.asc (application/pgp-signature, attachment)]

Added tag(s) patch; removed tag(s) fixed. Request was from Toon Claes <toon <at> iotcl.com> to control <at> debbugs.gnu.org. (Wed, 23 Mar 2016 20:21:01 GMT) Full text and rfc822 format available.

Changed bug title to 'doxygen syntax not enabled in c++-mode & /** single line comments */' from '24.1.50; doxygen comments not highlighted in c++-mode' Request was from npostavs <at> users.sourceforge.net to control <at> debbugs.gnu.org. (Thu, 29 Jun 2017 01:35:02 GMT) Full text and rfc822 format available.

Severity set to 'minor' from 'normal' Request was from npostavs <at> users.sourceforge.net to control <at> debbugs.gnu.org. (Thu, 29 Jun 2017 01:35:02 GMT) Full text and rfc822 format available.

bug Marked as found in versions 25.2. Request was from npostavs <at> users.sourceforge.net to control <at> debbugs.gnu.org. (Thu, 29 Jun 2017 01:35:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Thu, 27 Jun 2019 15:11:01 GMT) Full text and rfc822 format available.

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

From: Lars Ingebrigtsen <larsi <at> gnus.org>
To: Alan Mackenzie <acm <at> muc.de>
Cc: Toon Claes <toon <at> tonotdo.com>, Toon Claes <toon <at> iotcl.com>,
 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50;
 doxygen comments not highlighted in c++-mode
Date: Thu, 27 Jun 2019 17:10:05 +0200
Toon Claes <toon <at> iotcl.com> writes:

> Hi Lars,
>
> Find the patch attached.
> The regexp is written to match:
> /** gtkdoc */
> /**
>  * gtkdoc
>  */
>
> And to not match:
> /*******/

Alan, can you comment on this patch?  It's about not recognising gtkdoc
comments in c++-mode: 

> * progmodes/cc-vars.el (c-doc-comment-style): Set gtkdoc the
> default for c++-mode.
> * progmodes/cc-fonts.el (gtkdoc-font-lock-keywords): Text inside
> GtkDoc comment can be on the same line as the comment start "/**".
> ---
>  ChangeLog.2                | 9 +++++++++
>  lisp/progmodes/cc-fonts.el | 2 +-
>  lisp/progmodes/cc-vars.el  | 5 +++--
>  3 files changed, 13 insertions(+), 3 deletions(-)
>
> diff --git a/ChangeLog.2 b/ChangeLog.2
> index 5253a92..7ba1872 100644
> --- a/ChangeLog.2
> +++ b/ChangeLog.2
> @@ -1,3 +1,12 @@
> +2016-03-10  Toon Claes <toon <at> iotcl.com>
> +
> +	Fix Bug#11865
> +
> +	* progmodes/cc-vars.el (c-doc-comment-style): Set gtkdoc the
> +	default for c++-mode.
> +	* progmodes/cc-fonts.el (gtkdoc-font-lock-keywords): Text inside
> +	GtkDoc comment can be on the same line as the comment start "/**".
> +
>  2016-03-04  Michael Albinus  <michael.albinus <at> gmx.de>
>  
>  	Fix Bug#22859
> diff --git a/lisp/progmodes/cc-fonts.el b/lisp/progmodes/cc-fonts.el
> index a7097b9..6bbb8f4 100644
> --- a/lisp/progmodes/cc-fonts.el
> +++ b/lisp/progmodes/cc-fonts.el
> @@ -2515,7 +2515,7 @@ need for `pike-font-lock-extra-types'.")
>  
>  (defconst gtkdoc-font-lock-keywords
>    `((,(lambda (limit)
> -	(c-font-lock-doc-comments "/\\*\\*$" limit
> +	(c-font-lock-doc-comments "/\\*\\*\\([^\\*].*\\)?$" limit
>  	  gtkdoc-font-lock-doc-comments)
>  	(c-font-lock-doc-comments "/\\*< " limit
>  	  gtkdoc-font-lock-doc-protection)
> diff --git a/lisp/progmodes/cc-vars.el b/lisp/progmodes/cc-vars.el
> index a695718..9783516 100644
> --- a/lisp/progmodes/cc-vars.el
> +++ b/lisp/progmodes/cc-vars.el
> @@ -550,7 +550,8 @@ variable in a mode hook."
>  (defcustom-c-stylevar c-doc-comment-style
>    '((java-mode . javadoc)
>      (pike-mode . autodoc)
> -    (c-mode    . gtkdoc))
> +    (c-mode    . gtkdoc)
> +    (c++-mode  . gtkdoc))
>    "*Specifies documentation comment style(s) to recognize.
>  This is primarily used to fontify doc comments and the markup within
>  them, e.g. Javadoc comments.
> @@ -560,7 +561,7 @@ comment styles:
>  
>   javadoc -- Javadoc style for \"/** ... */\" comments (default in Java mode).
>   autodoc -- Pike autodoc style for \"//! ...\" comments (default in Pike mode).
> - gtkdoc  -- GtkDoc style for \"/** ... **/\" comments (default in C mode).
> + gtkdoc  -- GtkDoc style for \"/** ... **/\" comments (default in C/C++ mode).
>  
>  The value may also be a list of doc comment styles, in which case all
>  of them are recognized simultaneously (presumably with markup cues

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no




Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Fri, 28 Jun 2019 09:21:02 GMT) Full text and rfc822 format available.

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

From: Alan Mackenzie <acm <at> muc.de>
To: Lars Ingebrigtsen <larsi <at> gnus.org>
Cc: Toon Claes <toon <at> tonotdo.com>, Toon Claes <toon <at> iotcl.com>,
 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50; doxygen comments not highlighted in
 c++-mode
Date: Fri, 28 Jun 2019 09:19:55 +0000
Hello, Lars.

On Thu, Jun 27, 2019 at 17:10:05 +0200, Lars Ingebrigtsen wrote:
> Toon Claes <toon <at> iotcl.com> writes:

> > Hi Lars,

> > Find the patch attached.
> > The regexp is written to match:
> > /** gtkdoc */
> > /**
> >  * gtkdoc
> >  */

> > And to not match:
> > /*******/

> Alan, can you comment on this patch?  It's about not recognising gtkdoc
> comments in c++-mode: 

Thanks for the reminder.

I'm a bit busy in RL at the moment, but I should be able to look at it
sometime in the next week or two.

[ .... ]

> -- 
> (domestic pets only, the antidote for overdose, milk.)
>    bloggy blog: http://lars.ingebrigtsen.no

-- 
Alan Mackenzie (Nuremberg, Germany).




Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Sun, 30 Jun 2019 15:14:02 GMT) Full text and rfc822 format available.

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

From: Alan Mackenzie <acm <at> muc.de>
To: Lars Ingebrigtsen <larsi <at> gnus.org>, Toon Claes <toon <at> tonotdo.com>,
 Toon Claes <toon <at> iotcl.com>
Cc: 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50; doxygen comments not highlighted in
 c++-mode
Date: Sun, 30 Jun 2019 15:13:31 +0000
Hello, Toon and Lars.

On Thu, Jun 27, 2019 at 17:10:05 +0200, Lars Ingebrigtsen wrote:
> Toon Claes <toon <at> iotcl.com> writes:

> > Hi Lars,

> > Find the patch attached.
> > The regexp is written to match:
> > /** gtkdoc */
> > /**
> >  * gtkdoc
> >  */

> > And to not match:
> > /*******/

> Alan, can you comment on this patch?  It's about not recognising gtkdoc
> comments in c++-mode: 

I've just had a close look at this, and it's the least controversial
patch I've seen in years.  There is simply nothing in it which raises the
slightest question as to it's being a good thing.

So I've committed the change.  If I don't hear anything back within a few
days, I'll assume the change successful and close the bug.

> > * progmodes/cc-vars.el (c-doc-comment-style): Set gtkdoc the
> > default for c++-mode.
> > * progmodes/cc-fonts.el (gtkdoc-font-lock-keywords): Text inside
> > GtkDoc comment can be on the same line as the comment start "/**".
> > ---
> >  ChangeLog.2                | 9 +++++++++
> >  lisp/progmodes/cc-fonts.el | 2 +-
> >  lisp/progmodes/cc-vars.el  | 5 +++--
> >  3 files changed, 13 insertions(+), 3 deletions(-)

> -- 
> (domestic pets only, the antidote for overdose, milk.)
>    bloggy blog: http://lars.ingebrigtsen.no

-- 
Alan Mackenzie (Nuremberg, Germany).




Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Mon, 01 Jul 2019 07:50:02 GMT) Full text and rfc822 format available.

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

From: Toon Claes <toon <at> iotcl.com>
To: Alan Mackenzie <acm <at> muc.de>
Cc: Toon Claes <toon <at> tonotdo.com>, Lars Ingebrigtsen <larsi <at> gnus.org>,
 11865 <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50;
 doxygen comments not highlighted in c++-mode
Date: Mon, 01 Jul 2019 09:49:40 +0200
[Message part 1 (text/plain, inline)]
close 11865
thanks

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

> So I've committed the change.  If I don't hear anything back within a few
> days, I'll assume the change successful and close the bug.

Thanks. I'm no longer typing C++, but I think there still will people be
happy with this.

-- 
Toon
[signature.asc (application/pgp-signature, inline)]

Added tag(s) fixed. Request was from "Basil L. Contovounesios" <contovob <at> tcd.ie> to control <at> debbugs.gnu.org. (Wed, 03 Jul 2019 02:37:02 GMT) Full text and rfc822 format available.

bug marked as fixed in version 27.1, send any further explanations to 11865 <at> debbugs.gnu.org and Toon Claes <toon <at> tonotdo.com> Request was from "Basil L. Contovounesios" <contovob <at> tcd.ie> to control <at> debbugs.gnu.org. (Wed, 03 Jul 2019 02:37:02 GMT) Full text and rfc822 format available.

Information forwarded to bug-gnu-emacs <at> gnu.org, bug-cc-mode <at> gnu.org:
bug#11865; Package emacs,cc-mode. (Wed, 03 Jul 2019 02:37:02 GMT) Full text and rfc822 format available.

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

From: "Basil L. Contovounesios" <contovob <at> tcd.ie>
To: Toon Claes <toon <at> iotcl.com>
Cc: Toon Claes <toon <at> tonotdo.com>, Alan Mackenzie <acm <at> muc.de>,
 Lars Ingebrigtsen <larsi <at> gnus.org>, 11865-done <at> debbugs.gnu.org
Subject: Re: bug#11865: Fwd: Re: 24.1.50;
 doxygen comments not highlighted in c++-mode
Date: Wed, 03 Jul 2019 03:36:36 +0100
tags 11865 fixed
close 11865 27.1
quit

Toon Claes <toon <at> iotcl.com> writes:

> close 11865
> thanks

This didn't seem to close the bug (perhaps you forgot to Bcc
control <at> debbugs.gnu.org), so I'm doing that now.

Thanks,

-- 
Basil




bug archived. Request was from Debbugs Internal Request <help-debbugs <at> gnu.org> to internal_control <at> debbugs.gnu.org. (Wed, 31 Jul 2019 11:24:06 GMT) Full text and rfc822 format available.

This bug report was last modified 4 years and 276 days ago.

Previous Next


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