How to Create A Line Break In Doxygen Markdown?

2 minutes read

In Doxygen markdown, you can create a line break by leaving a blank line between two lines of text. This will create a clear separation between the two lines, making it easier for readers to understand the content. Additionally, you can also use the <br> tag to create a line break within a single line of text. Simply add <br> where you want the line break to occur, and Doxygen will render it accordingly. These methods can help improve the readability and organization of your documentation when using Doxygen markdown.


How to create a line break between headings in doxygen markdown?

To create a line break between headings in Doxygen markdown, you can simply insert a blank line between the headings. This will create a visual separation between the headings, making it easier for readers to distinguish them. Here's an example:

1
2
3
4
5
6
7
# Heading 1

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum efficitur, risus a lacinia condimentum, nunc tellus vulputate augue.

# Heading 2

Fusce vel magna ac elit consectetur eleifend. Nulla facilisi.


In this example, there is a blank line between the two headings, which creates a line break and visually separates them.


What is the character code for a line break in doxygen markdown?

The character code for a line break in doxygen markdown is "<br>".


How to incorporate line breaks in code blocks in doxygen markdown?

To incorporate line breaks in code blocks in Doxygen Markdown, you can use the <br> HTML tag followed by a newline character (\n). Here is an example:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
/**
 * \code{.cpp}
 * void myFunction() {
 *     int a = 10;
 *     int b = 20;
 *     int sum = a + b;
 *     cout << "Sum is: " << sum << endl;
 *     <br>\n
 *     // This is a line break
 *     cout << "End of function" << endl;
 * }
 * \endcode
 */


In the above example, the <br>\n tag is used to add a line break in the code block after the statement cout << "Sum is: " << sum << endl;. This will ensure that the next line cout << "End of function" << endl; is displayed on a new line within the code block.

Facebook Twitter LinkedIn Telegram Whatsapp

Related Posts:

To specify a markdown file as another tab in Doxygen, you can include the markdown file in the Doxygen configuration file by using the INPUT tag. This tag allows you to specify additional files or directories to be processed by Doxygen.Once you have added the ...
To check if Doxygen is locked, you can look for a file named &#34;doxygenlock&#34; in the root directory of your project. This file is created by Doxygen when it is running, to ensure that only one instance of Doxygen is running at a time. If this file is pres...
To put a blank line between two images in Doxygen, you can use HTML code to add a line break. Simply add or between the image tags of the two images in your Doxygen documentation. This will create a blank line separating the two images and improve the reada...
To generate a changelog using Doxygen, you need to utilize Doxygen&#39;s support for changelog generation. This can be done by enabling the GENERATE_CHANGELOG option in the Doxygen configuration file. By setting this option to YES, Doxygen will include a chang...
To link a PlantUML diagram in Doxygen, you first need to create the PlantUML diagram using the PlantUML syntax. Once the diagram is created, you can save it as a .puml file.In your Doxygen documentation, you can use the @dot command to include the PlantUML dia...