Hi,
First of all, thanks a lot to Dimitri for fixing the javadoc {@link}. I saw
it's been included in the latest changelog. Very quick turnaround on that
one. I really appreciate that.
I've seen two other small problems. They are illustrated by the example
below:
/**
* A test class. <br>
* Details.
*/
class Test
{
public:
/**
* A character constant. Details.
*/
static const char cOne;
};
const char Test::cOne='t';
First, the value of Test::cOne is not included in the generated
documentation. The value is included for int or const char* const
constants. It looks like const chars don't behave the same way for some
reason.
Second, it's the problem with the <br> in the class docs. I use
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
JAVADOC_AUTOBRIEF = YES
to get a behavior as close as possible to the output of the javadoc tool.
I'm only interested in HTML docs generation.
With the javadoc tool, the detailed description is made up of all the docs,
including the brief description, all copied verbatim. For that reason, it's
quite common to include a <br> after the brief description, to put it on a
different line from the rest of the docs.
Doxygen inserts some <p> tags to separate the brief description from the
rest of the docs in the detailed description. Not a bad idea, actually, but
this gets combined with the <br> tag, and results in a large space being
inserted between the first line and the rest of the docs.
Could the insertion of <p> tags be made a configurable option, so that one
can use comments written for javadoc without modification?
Again, I can hardly classify these as serious problems, but I guess it
would be nice to have them sorted out.
Cheers,
Bogdan
|
