Skip to content

Commit

Permalink
Terminate brief in case of -# list
Browse files Browse the repository at this point in the history
Test case.
  • Loading branch information
albert-github committed Jan 11, 2019
1 parent 0f1e5fa commit db8ab6a
Show file tree
Hide file tree
Showing 2 changed files with 144 additions and 0 deletions.
121 changes: 121 additions & 0 deletions testing/081/081__brief__lists_8h.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<doxygen xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="compound.xsd" version="">
<compounddef id="081__brief__lists_8h" kind="file" language="C++">
<compoundname>081_brief_lists.h</compoundname>
<sectiondef kind="func">
<memberdef kind="function" id="081__brief__lists_8h_1a319a01268f470ad2ab65e6838e13cc05" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void c_subr1</definition>
<argsstring>(void)</argsstring>
<name>c_subr1</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>Just with minus. </para>
</briefdescription>
<detaileddescription>
<para>
<itemizedlist>
<listitem>
<para>Item 1</para>
</listitem>
<listitem>
<para>Item 2 </para>
</listitem>
</itemizedlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="081_brief_lists.h" line="8" column="1"/>
</memberdef>
<memberdef kind="function" id="081__brief__lists_8h_1a6724979ae3655ed6eb8b377337119d94" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void c_subr2</definition>
<argsstring>(void)</argsstring>
<name>c_subr2</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>With minus and hash. </para>
</briefdescription>
<detaileddescription>
<para>
<orderedlist>
<listitem>
<para>Item 3</para>
</listitem>
<listitem>
<para>Item 4 </para>
</listitem>
</orderedlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="081_brief_lists.h" line="13" column="1"/>
</memberdef>
<memberdef kind="function" id="081__brief__lists_8h_1a32cca553d19c1f483a6c308000517353" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void c_subr3</definition>
<argsstring>(void)</argsstring>
<name>c_subr3</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>With numbers. </para>
</briefdescription>
<detaileddescription>
<para>
<orderedlist>
<listitem>
<para>Item 5</para>
</listitem>
<listitem>
<para>Item 6 </para>
</listitem>
</orderedlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="081_brief_lists.h" line="18" column="1"/>
</memberdef>
<memberdef kind="function" id="081__brief__lists_8h_1a350caf1b2bbbbb18b9b4f08bb799f86b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
<type>void</type>
<definition>void c_subr4</definition>
<argsstring>(void)</argsstring>
<name>c_subr4</name>
<param>
<type>void</type>
</param>
<briefdescription>
<para>With asterisk. </para>
</briefdescription>
<detaileddescription>
<para>
<itemizedlist>
<listitem>
<para>Item 7</para>
</listitem>
<listitem>
<para>Item 8 </para>
</listitem>
</itemizedlist>
</para>
</detaileddescription>
<inbodydescription>
</inbodydescription>
<location file="081_brief_lists.h" line="23" column="1"/>
</memberdef>
</sectiondef>
<briefdescription>
</briefdescription>
<detaileddescription>
</detaileddescription>
<location file="081_brief_lists.h"/>
</compounddef>
</doxygen>
23 changes: 23 additions & 0 deletions testing/081_brief_lists.h
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
// objective: Test termination of brief description with lists
// check: 081__brief__lists_8h.xml
/// \file

/// @brief Just with minus
/// - Item 1
/// - Item 2
void c_subr1(void);

/// @brief With minus and hash
/// -# Item 3
/// -# Item 4
void c_subr2(void);

/// @brief With numbers
/// 1. Item 5
/// 2. Item 6
void c_subr3(void);

/// @brief With asterisk
/// * Item 7
/// * Item 8
void c_subr4(void);

0 comments on commit db8ab6a

Please sign in to comment.