Skip to content

Commit db8ab6a

Browse files
albert-githubalbert-github
committed
Terminate brief in case of -# list
Test case.
1 parent 0f1e5fa commit db8ab6a

File tree

2 files changed

+144
-0
lines changed

2 files changed

+144
-0
lines changed

‎testing/081/081__brief__lists_8h.xml

Lines changed: 121 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,121 @@
1+
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2+
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="">
3+
<compounddef id="081__brief__lists_8h" kind="file" language="C++">
4+
<compoundname>081_brief_lists.h</compoundname>
5+
<sectiondef kind="func">
6+
<memberdef kind="function" id="081__brief__lists_8h_1a319a01268f470ad2ab65e6838e13cc05" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
7+
<type>void</type>
8+
<definition>void c_subr1</definition>
9+
<argsstring>(void)</argsstring>
10+
<name>c_subr1</name>
11+
<param>
12+
<type>void</type>
13+
</param>
14+
<briefdescription>
15+
<para>Just with minus. </para>
16+
</briefdescription>
17+
<detaileddescription>
18+
<para>
19+
<itemizedlist>
20+
<listitem>
21+
<para>Item 1</para>
22+
</listitem>
23+
<listitem>
24+
<para>Item 2 </para>
25+
</listitem>
26+
</itemizedlist>
27+
</para>
28+
</detaileddescription>
29+
<inbodydescription>
30+
</inbodydescription>
31+
<location file="081_brief_lists.h" line="8" column="1"/>
32+
</memberdef>
33+
<memberdef kind="function" id="081__brief__lists_8h_1a6724979ae3655ed6eb8b377337119d94" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
34+
<type>void</type>
35+
<definition>void c_subr2</definition>
36+
<argsstring>(void)</argsstring>
37+
<name>c_subr2</name>
38+
<param>
39+
<type>void</type>
40+
</param>
41+
<briefdescription>
42+
<para>With minus and hash. </para>
43+
</briefdescription>
44+
<detaileddescription>
45+
<para>
46+
<orderedlist>
47+
<listitem>
48+
<para>Item 3</para>
49+
</listitem>
50+
<listitem>
51+
<para>Item 4 </para>
52+
</listitem>
53+
</orderedlist>
54+
</para>
55+
</detaileddescription>
56+
<inbodydescription>
57+
</inbodydescription>
58+
<location file="081_brief_lists.h" line="13" column="1"/>
59+
</memberdef>
60+
<memberdef kind="function" id="081__brief__lists_8h_1a32cca553d19c1f483a6c308000517353" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
61+
<type>void</type>
62+
<definition>void c_subr3</definition>
63+
<argsstring>(void)</argsstring>
64+
<name>c_subr3</name>
65+
<param>
66+
<type>void</type>
67+
</param>
68+
<briefdescription>
69+
<para>With numbers. </para>
70+
</briefdescription>
71+
<detaileddescription>
72+
<para>
73+
<orderedlist>
74+
<listitem>
75+
<para>Item 5</para>
76+
</listitem>
77+
<listitem>
78+
<para>Item 6 </para>
79+
</listitem>
80+
</orderedlist>
81+
</para>
82+
</detaileddescription>
83+
<inbodydescription>
84+
</inbodydescription>
85+
<location file="081_brief_lists.h" line="18" column="1"/>
86+
</memberdef>
87+
<memberdef kind="function" id="081__brief__lists_8h_1a350caf1b2bbbbb18b9b4f08bb799f86b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
88+
<type>void</type>
89+
<definition>void c_subr4</definition>
90+
<argsstring>(void)</argsstring>
91+
<name>c_subr4</name>
92+
<param>
93+
<type>void</type>
94+
</param>
95+
<briefdescription>
96+
<para>With asterisk. </para>
97+
</briefdescription>
98+
<detaileddescription>
99+
<para>
100+
<itemizedlist>
101+
<listitem>
102+
<para>Item 7</para>
103+
</listitem>
104+
<listitem>
105+
<para>Item 8 </para>
106+
</listitem>
107+
</itemizedlist>
108+
</para>
109+
</detaileddescription>
110+
<inbodydescription>
111+
</inbodydescription>
112+
<location file="081_brief_lists.h" line="23" column="1"/>
113+
</memberdef>
114+
</sectiondef>
115+
<briefdescription>
116+
</briefdescription>
117+
<detaileddescription>
118+
</detaileddescription>
119+
<location file="081_brief_lists.h"/>
120+
</compounddef>
121+
</doxygen>

‎testing/081_brief_lists.h

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
// objective: Test termination of brief description with lists
2+
// check: 081__brief__lists_8h.xml
3+
/// \file
4+
5+
/// @brief Just with minus
6+
/// - Item 1
7+
/// - Item 2
8+
void c_subr1(void);
9+
10+
/// @brief With minus and hash
11+
/// -# Item 3
12+
/// -# Item 4
13+
void c_subr2(void);
14+
15+
/// @brief With numbers
16+
/// 1. Item 5
17+
/// 2. Item 6
18+
void c_subr3(void);
19+
20+
/// @brief With asterisk
21+
/// * Item 7
22+
/// * Item 8
23+
void c_subr4(void);

0 commit comments

Comments
 (0)