diff options
Diffstat (limited to 'doc/markdown.doc')
-rw-r--r-- | doc/markdown.doc | 36 |
1 files changed, 35 insertions, 1 deletions
diff --git a/doc/markdown.doc b/doc/markdown.doc index cec2191..300d7fc 100644 --- a/doc/markdown.doc +++ b/doc/markdown.doc @@ -337,6 +337,40 @@ which will look as follows: | 10 | 10 | 10 | | 1000 | 1000 | 1000 | +Additionally, column and row spans are supported. Using a caret ("^") +in a cell indicates that the cell above should span rows. Sequences +of carets may be used for any number of row spans. For example: + + | Right | Center | Left | + | ----: | :----: | :---- | + | 10 | 10 | 10 | + | ^ | 1000 | 1000 | + +which will look as follows: + +| Right | Center | Left | +| ----: | :----: | :---- | +| 10 | 10 | 10 | +| ^ | 1000 | 1000 | + +Column spans are supported by means of directly adjacent vertical bars +("|"). Each additional vertical bar indicates an additional column to +be spanned. To put it another way, a single vertical bar indicates a +single column span, two vertical bars indicates a 2 columns span, and +so on. For example: + + | Right | Center | Left | + | ----: | :----: | :---- | + | 10 | 10 | 10 | + | 1000 ||| + +which will look as follows: + +| Right | Center | Left | +| ----: | :----: | :---- | +| 10 | 10 | 10 | +| 1000 ||| + For more complex tables in doxygen please have a look at: \ref tables \subsection md_fenced Fenced Code Blocks @@ -511,7 +545,7 @@ is noticeable: code In this case Markdown will put the word code in a code block, -whereas Doxygen will treat it as normal text, since although the absolute +whereas doxygen will treat it as normal text, since although the absolute indentation is 4, the indentation with respect to the previous paragraph is only 1. |