[Doxygen-users] \brief bug

[Scot W. <sc...@wi...>]

I was trying to use \brief to create a description which was terminated by a 
command.  The documentation says it "ends when a blank line or another 
sectioning command is encountered."

The \par and \sa commands are within the "Section Indicators" command group.  
Those two commands do not terminate \brief.  I did not try \section to see if 
that is the definition of "sectioning command".

# /** \file   testerscript.sh \brief Tester Script \sa testershow.sh Perform 
the desired script for tester. */

Note the leading "#", as this is within a shell script file which uses # to 
delimit comments (this issue dealt with in recent message).

I was trying to make a one-line \file entry so as to not get "#" symbols within 
my descriptions.  The goal of the above was to try to get "Tester Script" as 
the Brief Description, with the Detailed Description having a "See also 
testershow.sh" and "Perform desired script for tester."

I also tried:

# /** \file   testerscript.sh \brief Tester Script \par "" Perform the desired 
script for tester. */


This was an attempt to get a Brief Description of "Tester Script" and a 
Detailed Description of "Perform the desired script for tester."  Nope, the new 
paragraph (with an odd Title) was part of the Brief Description.