Re: [Doxygen-develop] Feature request: color coded comments in source browser

[Michael S. <mi...@st...>]

Dimitri,

Thanks for taking the time to respond.  Yes, I mean to *keep* the markup
commands, preserving the original source file as it was written.  Indeed,
like Eclipse or Notepad++.

We use the doxygen in a few ways.  One for high level overview of structure
for the code, something non-software people can look at.  The other is for
the purpose of peer review code; using STRIP_CODE_COMMENT=NO allow the
markup usage to be reviewed too (learn from and/or critic).  The added
color would help reading source view, catch errors*, and clarify how
Doxygen interprets the markup.

(*the warning file catches errors anyway, so somewhat redundant.)


Thanks again,
Michael


On 1 April 2013 22:47, Doxygen [via Doxygen] <
ml-...@n7...> wrote:

> Hi Michael,
>
> On Mar 29, 2013, at 4:13 , Michael Stangeland <[hidden email]<http://user/SendEmail.jtp?type=node&node=5815&i=0>>
> wrote:
>
> > Eclipse and Notepad++ interpret the comment sections nicely with
> colorized
> > keywords, and a different color for normal comments verses Doxygen
> markup
> > comments.  But when looking at the source the Doxygen markup is now
> harder
> > to read.  (I use STRIP_CODE_COMMENTS=NO because I write minimal comments
> and
> > what little I do write,  I still want to see it)
> >
> > When generating the source code view, would it be possible to add a few
> more
> > styles for the elements inside the comment sections?  I figure the
> parser
> > already identifies the them.  Moreover, this would help understand how
> the
> > parser is using the markup.
> >
> > In the CSS file I found how to change the style, but obviously only one
> > style for all comments.
> >
> > span.comment {
> > color: #800000
> > }
> >
> > I propose:
> > "comment" for normal comments.
> > "docomment" for general Doxygen
> > "dockeyword" or "docommand" for interpreted Doxygen commands (assuming
> the
> > same engine used to interpret the markup, ALIASes would also be
> identified
> > automatically).
> >
> > The extra nice to have would be to also identify and colorize the parsed
> > components of the commands such as <name>.  Also Bold, italic and other
> > formatting could be reflected.
> >
> > Maybe going too far... but the source markup that produces links could
> also
> > be clickable.
>
> Then why not go one step further and let doxygen render the special
> comments
> as it does for the documentation?
>
> Then you could have a documentation view with inline code (when
> INLINE_SOURCES=YES)
> and the inverse; a source view with inline documentation
> (when SOURCE_BROWSER=YES and STRIP_CODE_COMMENTS=NO)
>
> Or do you really want to see the markup commands in the source view, like
> you
> would in Eclipse or Notepad++?
>
> Regards,
>   Dimitri
>
>
>
> ------------------------------------------------------------------------------
>
> Own the Future-Intel&reg; Level Up Game Demo Contest 2013
> Rise to greatness in Intel's independent game demo contest.
> Compete for recognition, cash, and the chance to get your game
> on Steam. $5K grand prize plus 10 genre and skill prizes.
> Submit your demo by 6/6/13. http://p.sf.net/sfu/intel_levelupd2d
> _______________________________________________
> Doxygen-develop mailing list
> [hidden email] <http://user/SendEmail.jtp?type=node&node=5815&i=1>
> https://lists.sourceforge.net/lists/listinfo/doxygen-develop
>
>
> ------------------------------
>  If you reply to this email, your message will be added to the discussion
> below:
>
> http://doxygen.10944.n7.nabble.com/Feature-request-color-coded-comments-in-source-browser-tp5812p5815.html
>  To unsubscribe from Feature request: color coded comments in source
> browser, click here<http://doxygen.10944.n7.nabble.com/template/NamlServlet.jtp?macro=unsubscribe_by_code&node=5812&code=bWljaGFlbEBzdGFuZ2VsYW5kLmNhfDU4MTJ8LTI4OTk1Mjc2OA==>
> .
> NAML<http://doxygen.10944.n7.nabble.com/template/NamlServlet.jtp?macro=macro_viewer&id=instant_html%21nabble%3Aemail.naml&base=nabble.naml.namespaces.BasicNamespace-nabble.view.web.template.NabbleNamespace-nabble.view.web.template.NodeNamespace&breadcrumbs=notify_subscribers%21nabble%3Aemail.naml-instant_emails%21nabble%3Aemail.naml-send_instant_email%21nabble%3Aemail.naml>
>




--
View this message in context: http://doxygen.10944.n7.nabble.com/Feature-request-color-coded-comments-in-source-browser-tp5812p5819.html
Sent from the Doxygen - Development mailing list archive at Nabble.com.