Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Doxygen table: Create table that has line breaks in source

Tags:

doxygen

/**
 * | A | B |
 * | - | - |
 * | 123 | This should be a long line with
 * a line break without breaking the table |
 * | A further | row |
 */

Doxygen stops the table parsing after "with". How can I prevent this behavior?

like image 559
braggPeaks Avatar asked Mar 20 '14 08:03

braggPeaks


1 Answers

I found that using markups for table is not convinient enough. if you will switch to html fromat you will not have a problem to break whenever you want. I have created the following aliases in Doxyfile for my table to simplify the code:

"table_start_b{1}=<table><caption align= bottom>\1</caption>" \
"table_start_t{1}=<table><caption align= top>\1</caption>" \
"table_end=</table>" \
"table_h2{2}=<tr><th>\1</th><th>\2</th></tr>" \
"table_row2{2}=<tr><td align= center>\1</td><td align= center>\2</td></tr>" \

and use it as following :

\table_start_t{Abbreviations}
    \table_h2{ 
               Acronym , 
               Description }
    \table_row2{ "TBD" , "To be 
                          defined" }
\table_end

You have no problem to have a line break in any place.

like image 168
Ilya Avatar answered Oct 22 '22 13:10

Ilya