Re:[Doxygen-users] [newbi question] - Stripping Doxygen comments

[Philippe L. <Ph...@gm...>]

> What I have noticed, looking at various groups using Doxygen is that the
> development code contains doxygen comments, but the distributed source
> code does not. (E.g. Doxygen etc..).
> 
> What script / utility is being used to remove the comments before 
> distribution of the source code ?

Doxygen source code isn't a good example of using Doxygen to comment a
program :-)
Dimitri didn't used Doxygen on and don't generate Doxygen doc. for his own
code. This has been already pointed out on this mailing list.
Of course, we all prefer that he works on removing bugs and adding features
that spending a lot of time on documenting the source :-) Even if it would
have been a good introduction to use Doxygen. But now, there are plenty open
source projects using Doxygen, so it is easy to pick an example.

Now, let's take a project in the Doxygen project page, says TinyXml
(http://www.grinninglizard.com/tinyxml/index.html).
If you look at the *real* source, you can see the Doxygen comments.
If you look at the source formatted by Doxygen, they are not there, but if
you take a look at the line numbers, you can see a lot are missing:

00131 
00144     const std::string& Value()  const           { return value; }
00145 
00155     void SetValue( const std::string& _value )      { value = _value;
}

Actually, Doxygen strips out the documentation comments before listing the
source, because they would be redundant with the actual documentation.

BTW, a way to get the source without Doxygen comment could be to view the
source page in a browser, select all, paste in a text editor, remove header and
footer and the line numbers.

Regard.

-- 
--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--
Philippe Lhoste (Paris -- France)
Professional programmer and amateur artist
http://jove.prohosting.com/~philho/
--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--=#=--

Sent through GMX FreeMail - http://www.gmx.net