10SecTom
10SecTom

Reputation: 2664

Doxygen multiple bold words

I am trying to make an entire line of text bold. The Doxygen documentation states:

\b Displays the argument using a bold font. Equivalent to < b>word< /b>. To put multiple words in bold use < b>multiple words< /b>.

I have tried (before reading HTML commands section):

I looked at HTML tags < B> and < /B> but I don't want to tie the formatting to only HTML output. Aside from this when I tried '\\!< B> lots of words < /B>' it did not work.

Note:

Upvotes: 8

Views: 12269

Answers (2)

jadarve
jadarve

Reputation: 324

Starting with Doxygen 1.8.0, you can also use Markdown syntax **Bold text**.

/**
@mainpage

**This will be rendered as bold text**
*/

Upvotes: 8

Justin Randall
Justin Randall

Reputation: 2278

Your second attempt is the correct way to bold out multiple words in doxygen (without the spaces between b tags of course). Note that if you are doing non-standard delimiters for comments, then you will need to specify what those delimiers are in your doxygen configuration file.

/**
@mainpage
This short example contains some text markup
illustrating how to do html formatting in doxygen.
.
This will be < em>italic< /em> and this is
< b>how you make lots of words bold.< /b> You will
have to remove the spaces from the tags.
*/

Upvotes: 10

Related Questions