GNU bug report logs - #3417
c-mode uses font-lock-doc-face for /**

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 3417 in the body.
You can then email your comments to 3417 AT debbugs.gnu.org in the normal way.

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

Message #5 received at submit <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Antoine Levitt <antoine.levitt <at> gmail.com>
To: bug-gnu-emacs <at> gnu.org
Subject: c-mode uses font-lock-doc-face for /**
Date: Fri, 29 May 2009 16:45:42 +0200

[Message part 1 (text/plain, inline)]

Compare :
/**
some file
*/
with
/*
some file
*/

In the first case, font-lock-doc-face is used, in the second
font-lock-comment-face is.

The first example fontifies with doc-face only if there is just "/**" :
"/*", "/** " (with a space) or "/***", for instance, use the standard
comment-face.

This is using emacs 23.0.94.1, and was reproduced on emacs22 as well. C++
and obj-C aren't affected, and java also shows this behavior on "/***"" and
"/** "/

This behavior is certainly unexpected : I expect all comments to be
fontified with the same face. Am I right in thinking it's a bug ?

Antoine

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

Message #10 received at 3417-done <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Stefan Monnier <monnier <at> IRO.UMontreal.CA>
To: Antoine Levitt <antoine.levitt <at> gmail.com>
Cc: 3417-done <at> debbugs.gnu.org
Subject: Re: bug#3417: c-mode uses font-lock-doc-face for /**
Date: Fri, 29 May 2009 12:01:38 -0400

> This behavior is certainly unexpected : I expect all comments to be
> fontified with the same face.  Am I right in thinking it's a bug ?

It's a feature. This comment format is used by doxygen (or somesuch).


        Stefan

Message #11 received at 3417-done <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Antoine Levitt <antoine.levitt <at> gmail.com>
To: Stefan Monnier <monnier <at> iro.umontreal.ca>
Cc: 3417-done <at> debbugs.gnu.org
Subject: Re: bug#3417: c-mode uses font-lock-doc-face for /**
Date: Fri, 29 May 2009 18:20:24 +0200

[Message part 1 (text/plain, inline)]

Ok, it makes sense.

But how comes "/** " (with a space) isn't fontified, when it is in other
modes like java ? There is no obvious difference between :
/**
* some comment */
and
/**
* some comment */
, but they are fontified differently (the second has a space after the /**).
2009/5/29 Stefan Monnier <monnier <at> iro.umontreal.ca>

> > This behavior is certainly unexpected : I expect all comments to be
> > fontified with the same face.  Am I right in thinking it's a bug ?
>
> It's a feature. This comment format is used by doxygen (or somesuch).
>
>
>        Stefan
>

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

Message #16 received at 3417 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: martin rudalics <rudalics <at> gmx.at>
To: Antoine Levitt <antoine.levitt <at> gmail.com>, 3417 <at> debbugs.gnu.org
Subject: Re: bug#3417: c-mode uses font-lock-doc-face for /**
Date: Fri, 29 May 2009 18:46:51 +0200

> Compare :
> /**
> some file
> */
> with
> /*
> some file
> */
>
> In the first case, font-lock-doc-face is used, in the second
> font-lock-comment-face is.
>
> The first example fontifies with doc-face only if there is just "/**" :
> "/*", "/** " (with a space) or "/***", for instance, use the standard
> comment-face.
>
> This is using emacs 23.0.94.1, and was reproduced on emacs22 as well. C++
> and obj-C aren't affected, and java also shows this behavior on "/***"" and
> "/** "/
>
> This behavior is certainly unexpected : I expect all comments to be
> fontified with the same face. Am I right in thinking it's a bug ?

Have you tried to customize `c-doc-comment-style'?

martin

Message #21 received at 3417 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: Antoine Levitt <antoine.levitt <at> gmail.com>
To: martin rudalics <rudalics <at> gmx.at>
Cc: 3417 <at> debbugs.gnu.org
Subject: Re: bug#3417: c-mode uses font-lock-doc-face for /**
Date: Fri, 29 May 2009 19:03:05 +0200

[Message part 1 (text/plain, inline)]

Using your variable as a starting point, I found this :
for gtkdoc (default in C), regexp is :
    (c-font-lock-doc-comments "/\\*\\*$" limit
      gtkdoc-font-lock-doc-comments)

for javadoc, it's :
(c-font-lock-doc-comments "/\\*\\*" limit
      javadoc-font-lock-doc-comments)))))

Gtkdoc manual specifies :

A multiline comment that starts with an additional '*' marks a documentation
block that will be processed by the Gtk-Doc tools.

Shouldn't the regexp for gtkdoc be "/\\*\\*" then ? (without the $)
2009/5/29 martin rudalics <rudalics <at> gmx.at>

> > Compare :
> > /**
> > some file
> > */
> > with
> > /*
> > some file
> > */
> >
> > In the first case, font-lock-doc-face is used, in the second
> > font-lock-comment-face is.
> >
> > The first example fontifies with doc-face only if there is just "/**" :
> > "/*", "/** " (with a space) or "/***", for instance, use the standard
> > comment-face.
> >
> > This is using emacs 23.0.94.1, and was reproduced on emacs22 as well. C++
> > and obj-C aren't affected, and java also shows this behavior on "/***""
> and
> > "/** "/
> >
> > This behavior is certainly unexpected : I expect all comments to be
> > fontified with the same face. Am I right in thinking it's a bug ?
>
> Have you tried to customize `c-doc-comment-style'?
>
> martin
>

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

Message #26 received at 3417 <at> emacsbugs.donarmstrong.com (full text, mbox):

From: martin rudalics <rudalics <at> gmx.at>
To: Antoine Levitt <antoine.levitt <at> gmail.com>
Cc: 3417 <at> debbugs.gnu.org, Alan Mackenzie <acm <at> muc.de>
Subject: Re: bug#3417: c-mode uses font-lock-doc-face for /**
Date: Fri, 29 May 2009 19:10:45 +0200

> Using your variable as a starting point, I found this :
> for gtkdoc (default in C), regexp is :
>     (c-font-lock-doc-comments "/\\*\\*$" limit
>       gtkdoc-font-lock-doc-comments)
>
> for javadoc, it's :
> (c-font-lock-doc-comments "/\\*\\*" limit
>       javadoc-font-lock-doc-comments)))))
>
> Gtkdoc manual specifies :
>
> A multiline comment that starts with an additional '*' marks a documentation
> block that will be processed by the Gtk-Doc tools.
>
> Shouldn't the regexp for gtkdoc be "/\\*\\*" then ? (without the $)

I don't have the slightest idea about these conventions.  That's in the
domain of Mr. Mackenzie.  Good evening, Alan ...

martin

Previous Next

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