Hello,

 

I am using Doxygen 1.8.5 on Windows 7 and am trying to include a bullet list
in a brief paragraph for a C++ class. I want the brief paragraph, including
the list, to be displayed in the Class List and at the top of the Class
Reference page.

 

I have tried:

 

/// \a Purpose:

/// - Item 1.

/// - Item 2.

/// - Item 3.

/// .

 

/** 

 * Lots of detailed description goes here . . .

*/

class Foo

{

    // Class definition goes here . . .

}

 

And:

 

/**

* \brief \a Purpose:

*  - Item 1.

*  - Item 2.

*  - Item 3.

*  .

* 

 * Lots of detailed description goes here . . .

*/

class Foo

{

    // Class definition goes here . . .

}

 

And:

 

/**

* <summary>

* \a Purpose:

* - Item 1.

* - Item 2.

* - Item 3.

* .

* </summary>

* 

* Lots of detailed description goes here . . .

*/

class Foo

{

    // Class definition goes here . . .

}

 

And:

 

/**

* <summary>

*   <em>Purpose:</em>

*   <ul>

*      <li>Item 1.

*      <li>Item 2.

*      <li>Item 3.

*   </ul>

* </summary>

*

* Lots of detailed description goes here . . .

*/

class Foo

{

    // Class definition goes here . . .

}

 

And many other permutations. In all cases I have the following set in my
Doxyfile configuration file:

 

BRIEF_MEMBER_DESC      = YES

REPEAT_BRIEF           = YES

MULTILINE_CPP_IS_BRIEF = YES

MARKDOWN_SUPPORT       = NO

 

The results in all cases are the same. The only text displayed in the Class
List and at the top of the Foo Class Reference page is:

 

Purpose:

 

However, the Detailed Description section of the Foo Class Reference page
always displays Purpose:  followed by the properly formatted bullet list
followed by all the detailed description text. So it seems that Doxygen is
always treating my bullet list as part of the detailed description. Can
anyone tell me how to get my bullet list included as part of the brief
paragraph?

 

Thank you.

 

-- John Koehring

Attachment: smime.p7s
Description: S/MIME cryptographic signature

------------------------------------------------------------------------------
October Webinars: Code for Performance
Free Intel webinars can help you accelerate application performance.
Explore tips for MPI, OpenMP, advanced profiling, and more. Get the most from 
the latest Intel processors and coprocessors. See abstracts and register >
http://pubads.g.doubleclick.net/gampad/clk?id=60135991&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users

Reply via email to