doxygen-users

[Doxygen-users] Comment Folding Problem

[Christian R. <cra...@de...>]

  I am using doxygen-1.2.6 and I am having a small problem with how the
brief and detailed comments in a method are folded together. In my header
file I have something like:

/** Describes method briefly starting with a  verb. */
void MyMethod(int myparameter);

In my source file I then have:

/**
 * More detailed information about the method. Possibly
 * many sentences or paragraphs with embedded HTML. The
 * brief comment is not restated.
 *
 * @param myparameter Information about the parameter.
 */
void MyClass::MyMethod(int myparameter)
{
  // ...
}

  The trouble I am having is that doxygen-1.2.6 appears to assume the first
sentence in the source file comment is a restatement of the brief comment
from the header file. This isn't the case, and I want to tell it not to
delete the first sentence.
  I thought I saw this was fixed in a more recent version of doxygen, but I
cannot update to the latest version. Can the person who provided that fix
let me know what the code change was so I can patch my 1.2.6 source and
rebuild? A patch file is not intrinsically necessary. I deeply appreciate
any efforts on this issue.

thank you very much,
christian

+-----+
Christian Ratliff <cra...@de...>
Sr. Technology Architect / Core Libraries Group
DeLorme Publishing Co.
"This is the very perfection of man, 
  to find out his own imperfections" -  St. Augustine

Re: [Doxygen-users] Comment Folding Problem

[Dimitri v. H. <di...@st...>]

On Wed, Dec 12, 2001 at 12:00:57PM -0500, Christian Ratliff wrote:
> 
>   I am using doxygen-1.2.6 and I am having a small problem with how the
> brief and detailed comments in a method are folded together. In my header
> file I have something like:
> 
> /** Describes method briefly starting with a  verb. */
> void MyMethod(int myparameter);

I would have expected a @brief here (and JAVADOC_AUTOBRIEF to NO).
You cannot have two detailed or two brief descriptions (in any version of
doxygen so far).

> In my source file I then have:
> 
> /**
>  * More detailed information about the method. Possibly
>  * many sentences or paragraphs with embedded HTML. The
>  * brief comment is not restated.
>  *
>  * @param myparameter Information about the parameter.
>  */
> void MyClass::MyMethod(int myparameter)
> {
>   // ...
> }
> 
>   The trouble I am having is that doxygen-1.2.6 appears to assume the first
> sentence in the source file comment is a restatement of the brief comment
> from the header file. This isn't the case, and I want to tell it not to
> delete the first sentence.
>   I thought I saw this was fixed in a more recent version of doxygen, but I
> cannot update to the latest version. 

Why not? You wouldn't want to continue with that release forever, would you?

Regards, 
  Dimitri