You may need to use the @brief command before your brief explanation and
@details in front of the detailed explanation.
On Apr 16, 2015 10:57 AM, "Alessandro Antonello" <ant...@gm...>
wrote:
> Hi everyone,
>
> My question is: what could cause a brief description to appear as a '!'
> sign
> in the HTML documentation output?
>
> I had set JAVADOC_AUTOBRIEF = YES in the configuration file. I wrote my
> classes like:
>
> -----------------------------------------------------------
> /**
> * This should be the brief.
> * This is the detailed description.
> */
> class MyClass
> {
> };
> -----------------------------------------------------------
>
> In the list of classes the related item appears as:
>
> -----------------------------------------------------------
> class MyClass ! More...
> -----------------------------------------------------------
>
> In the class page documentation it also appears that way.
>
> -----------------------------------------------------------
> MyClass Class Reference
> ! More...
> -----------------------------------------------------------
>
> Also in The deails.
>
> -----------------------------------------------------------
> Detailed Description
> !
> This should be the brief.
> This is the detailed description.
> -----------------------------------------------------------
>
> Since there are no '!' characters in the documentation, what could cause
> that
> problem? All C++ files are encoded using UTF-8. That was correctly
> configured
> in the doxygen configuration file.
>
> I also tried specificaly setting the brief with '@brief'. Got same result.
>
>
>
>
Hi Robert.
Tanks for your answer. I found what was going wrong. Before each comment
block I had a conditional comment section that I mistakenly wrote as
follows:
--------------------------------------------------------------------------
///! \cond my_cond
///! \endcond
--------------------------------------------------------------------------
For some reason the '!' character in this conditional section is leaking to
the next comment block. When I removed the '!' characters from the
conditional section the HTML output becomes correct.
Thanks for your help.
|
