drop test-suite
This commit is contained in:
Than Ngo
parent
97ec8457c6
commit
c465c5db9c
|
|
@ -16,7 +16,7 @@ Summary: A documentation system for C/C++
|
|||
Name: doxygen
|
||||
Epoch: 1
|
||||
Version: 1.9.1
|
||||
Release: 6%{?dist}
|
||||
Release: 7%{?dist}
|
||||
|
||||
# No version is specified.
|
||||
License: GPL+
|
||||
|
|
@ -304,6 +304,9 @@ desktop-file-install --dir=%{buildroot}%{_datadir}/applications %{SOURCE1}
|
|||
%endif
|
||||
|
||||
%changelog
|
||||
* Mon Feb 22 2021 Than Ngo <than@redhat.com> - 1:1.9.1-7
|
||||
- drop test-suite
|
||||
|
||||
* Wed Feb 10 2021 Than Ngo <than@redhat.com> - 1:1.9.1-6
|
||||
- fixed Coverity issues
|
||||
- fixed crash in docparser
|
||||
|
|
|
|||
|
|
@ -1,7 +0,0 @@
|
|||
--- !Policy
|
||||
product_versions:
|
||||
- fedora-*
|
||||
decision_context: bodhi_update_push_testing
|
||||
rules:
|
||||
- !PassingTestCaseRule {test_case_name: dist.depcheck}
|
||||
- !PassingTestCaseRule {test_case_name: dist.abicheck}
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
---
|
||||
# Run tests in all contexts
|
||||
- hosts: localhost
|
||||
tags:
|
||||
- classic
|
||||
roles:
|
||||
- role: standard-test-beakerlib
|
||||
tests:
|
||||
- upstream-test-suite
|
||||
required_packages:
|
||||
- doxygen
|
||||
- python3
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text <emphasis>argument</emphasis> more text. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
// objective: test the \a and \mainpage commands
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* Text \a argument more text.
|
||||
*/
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<indexentry>
|
||||
<primaryie>keyword</primaryie>
|
||||
<secondaryie/>
|
||||
</indexentry>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
// objective: test \addindex command
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* \addindex keyword
|
||||
*/
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para><ref refid="index_1myanchor" kindref="member">See Anchor</ref> Some text. <anchor id="index_1myanchor"/>More text. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
// objective: test \anchor command
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* \ref myanchor "See Anchor"
|
||||
* Some text.
|
||||
* \anchor myanchor
|
||||
* More text.
|
||||
*/
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para><itemizedlist><listitem><para><computeroutput>AlignLeft</computeroutput> left alignment. </para></listitem><listitem><para><computeroutput>AlignCenter</computeroutput> center alignment. </para></listitem><listitem><para><computeroutput>AlignRight</computeroutput> right alignment</para></listitem></itemizedlist>
|
||||
No other types of alignment are supported.</para>
|
||||
<para><itemizedlist><listitem><para><computeroutput>AlignLeft</computeroutput> left alignment. </para></listitem><listitem><para><computeroutput>AlignCenter</computeroutput> center alignment. </para></listitem><listitem><para><computeroutput>AlignRight</computeroutput> right alignment</para></listitem></itemizedlist>
|
||||
No other types of alignment are supported. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
// objective: test \arg and \li commands
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
\arg \c AlignLeft left alignment.
|
||||
\arg \c AlignCenter center alignment.
|
||||
\arg \c AlignRight right alignment
|
||||
|
||||
No other types of alignment are supported.
|
||||
|
||||
\li \c AlignLeft left alignment.
|
||||
\li \c AlignCenter center alignment.
|
||||
\li \c AlignRight right alignment
|
||||
|
||||
No other types of alignment are supported.
|
||||
*/
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<simplesect kind="attention">
|
||||
<para>Attention message. </para>
|
||||
</simplesect>
|
||||
<simplesect kind="note">
|
||||
<para>Something to note. </para>
|
||||
</simplesect>
|
||||
<simplesect kind="remark">
|
||||
<para>A remark. </para>
|
||||
</simplesect>
|
||||
<simplesect kind="warning">
|
||||
<para>A warning message. </para>
|
||||
</simplesect>
|
||||
<simplesect kind="par">
|
||||
<title/>
|
||||
<para>Second paragraph </para>
|
||||
</simplesect>
|
||||
<simplesect kind="par">
|
||||
<title>User defined paragraph.</title>
|
||||
<para>Contents of paragraph. </para>
|
||||
</simplesect>
|
||||
<simplesect kind="par">
|
||||
<title/>
|
||||
<para>More text in a new paragraph. </para>
|
||||
</simplesect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
// objective: test \attention, \note, \remark, \warning, and \par commands
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* \attention Attention message.
|
||||
* \note Something to note.
|
||||
* \remark A remark.
|
||||
* \warning A warning message.
|
||||
* \par
|
||||
* Second paragraph
|
||||
* \par User defined paragraph.
|
||||
* Contents of paragraph.
|
||||
* \par
|
||||
* More text in a new paragraph.
|
||||
*/
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<simplesect kind="author">
|
||||
<para>John Doe </para>
|
||||
</simplesect>
|
||||
<simplesect kind="author">
|
||||
<para>Jane Doe </para>
|
||||
</simplesect>
|
||||
<simplesect kind="authors">
|
||||
<para>David, Steven </para>
|
||||
</simplesect>
|
||||
<simplesect kind="since">
|
||||
<para>version 1.2 </para>
|
||||
</simplesect>
|
||||
<simplesect kind="version">
|
||||
<para>1.8-beta2 </para>
|
||||
</simplesect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
// objective: test the \author, \since, and \version command
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* \author John Doe
|
||||
* \author Jane Doe
|
||||
* \authors David, Steven
|
||||
* \since version 1.2
|
||||
* \version 1.8-beta2
|
||||
*/
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text <bold>bold</bold> normal text. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
// objective: test the \b command
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* Text \b bold normal text.
|
||||
*/
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<?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="008__brief_8c" kind="file" language="C++">
|
||||
<compoundname>008_brief.c</compoundname>
|
||||
<briefdescription>
|
||||
<para>A brief description. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>More details. </para>
|
||||
</detaileddescription>
|
||||
<location file="008_brief.c"/>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
// objective: test \brief and \file command
|
||||
// check: 008__brief_8c.xml
|
||||
/** \file
|
||||
* \brief A brief description.
|
||||
*
|
||||
* More details.
|
||||
*/
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<?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="bug" kind="page">
|
||||
<compoundname>bug</compoundname>
|
||||
<title>Bug List</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Class <ref refid="class_bug" kindref="compound">Bug</ref></term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="bug_1_bug000001"/>Class bug. </para>
|
||||
</listitem>
|
||||
<varlistentry>
|
||||
<term>Member <ref refid="class_bug_1a1f720954dd97cd1203e80501a6eae74c" kindref="member">Bug::foo</ref> ()</term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="bug_1_bug000002"/>Function bug<itemizedlist><listitem><para>list item 1 in bug</para></listitem><listitem><para>list item 2 in bug</para></listitem></itemizedlist></para>
|
||||
</listitem>
|
||||
</variablelist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
<?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="class_bug" kind="class" language="C++" prot="public">
|
||||
<compoundname>Bug</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_bug_1a1f720954dd97cd1203e80501a6eae74c" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void Bug::foo</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>foo</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Description <xrefsect id="bug_1_bug000002"><xreftitle>Bug</xreftitle><xrefdescription><para>Function bug<itemizedlist><listitem><para>list item 1 in bug</para></listitem><listitem><para>list item 2 in bug</para></listitem></itemizedlist>
|
||||
</para></xrefdescription></xrefsect></para>
|
||||
<para>More text. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="009_bug.cpp" line="25" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<xrefsect id="bug_1_bug000001">
|
||||
<xreftitle>Bug</xreftitle>
|
||||
<xrefdescription>
|
||||
<para>Class bug. </para>
|
||||
</xrefdescription>
|
||||
</xrefsect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<location file="009_bug.cpp" line="16" column="1" bodyfile="009_bug.cpp" bodystart="15" bodyend="26"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_bug_1a1f720954dd97cd1203e80501a6eae74c" prot="public" virt="non-virtual">
|
||||
<scope>Bug</scope>
|
||||
<name>foo</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,41 +0,0 @@
|
|||
<?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="class_deprecated" kind="class" language="C++" prot="public">
|
||||
<compoundname>Deprecated</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_deprecated_1a1d5f6803e72c625727e7083d1722dbf9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void Deprecated::deprecated</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>deprecated</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Do deprecated things. <xrefsect id="deprecated_1_deprecated000002"><xreftitle>Deprecated</xreftitle><xrefdescription><para>No not use this function anymore. </para></xrefdescription></xrefsect></para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="009_bug.cpp" line="35" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<xrefsect id="deprecated_1_deprecated000001">
|
||||
<xreftitle>Deprecated</xreftitle>
|
||||
<xrefdescription>
|
||||
<para>This class is deprecated </para>
|
||||
</xrefdescription>
|
||||
</xrefsect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<location file="009_bug.cpp" line="30" column="1" bodyfile="009_bug.cpp" bodystart="29" bodyend="36"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_deprecated_1a1d5f6803e72c625727e7083d1722dbf9" prot="public" virt="non-virtual">
|
||||
<scope>Deprecated</scope>
|
||||
<name>deprecated</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
<?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="class_reminder" kind="class" language="C++" prot="public">
|
||||
<compoundname>Reminder</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_reminder_1a173b5218bb11287b0e86a550d9f0728d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void Reminder::reminder</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>reminder</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<xrefsect id="reminders_1_reminders000002">
|
||||
<xreftitle>Reminder</xreftitle>
|
||||
<xrefdescription>
|
||||
<para>Need to rework this before the next release. </para>
|
||||
</xrefdescription>
|
||||
</xrefsect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="009_bug.cpp" line="59" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<xrefsect id="reminders_1_reminders000001">
|
||||
<xreftitle>Reminder</xreftitle>
|
||||
<xrefdescription>
|
||||
<para>A reminder </para>
|
||||
</xrefdescription>
|
||||
</xrefsect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<location file="009_bug.cpp" line="56" column="1" bodyfile="009_bug.cpp" bodystart="55" bodyend="60"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_reminder_1a173b5218bb11287b0e86a550d9f0728d" prot="public" virt="non-virtual">
|
||||
<scope>Reminder</scope>
|
||||
<name>reminder</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
<?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="class_test" kind="class" language="C++" prot="public">
|
||||
<compoundname>Test</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_test_1a9fc54b716f326514a4c5f434137f4fc0" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void Test::test</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>test</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<xrefsect id="test_1_test000002">
|
||||
<xreftitle>Test</xreftitle>
|
||||
<xrefdescription>
|
||||
<para>more things to test. </para>
|
||||
</xrefdescription>
|
||||
</xrefsect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="009_bug.cpp" line="51" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<xrefsect id="test_1_test000001">
|
||||
<xreftitle>Test</xreftitle>
|
||||
<xrefdescription>
|
||||
<para>This is part of testing </para>
|
||||
</xrefdescription>
|
||||
</xrefsect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<location file="009_bug.cpp" line="48" column="1" bodyfile="009_bug.cpp" bodystart="47" bodyend="52"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_test_1a9fc54b716f326514a4c5f434137f4fc0" prot="public" virt="non-virtual">
|
||||
<scope>Test</scope>
|
||||
<name>test</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
<?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="class_todo" kind="class" language="C++" prot="public">
|
||||
<compoundname>Todo</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_todo_1a9e70ec9176ac4c1b20e011b4daddc9d8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void Todo::todo</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>todo</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<xrefsect id="todo_1_todo000002">
|
||||
<xreftitle>Todo</xreftitle>
|
||||
<xrefdescription>
|
||||
<para>more things to do here </para>
|
||||
</xrefdescription>
|
||||
</xrefsect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="009_bug.cpp" line="43" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<xrefsect id="todo_1_todo000001">
|
||||
<xreftitle>Todo</xreftitle>
|
||||
<xrefdescription>
|
||||
<para>This still needs to be done. </para>
|
||||
</xrefdescription>
|
||||
</xrefsect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<location file="009_bug.cpp" line="40" column="1" bodyfile="009_bug.cpp" bodystart="39" bodyend="44"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_todo_1a9e70ec9176ac4c1b20e011b4daddc9d8" prot="public" virt="non-virtual">
|
||||
<scope>Todo</scope>
|
||||
<name>todo</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<?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="deprecated" kind="page">
|
||||
<compoundname>deprecated</compoundname>
|
||||
<title>Deprecated List</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Class <ref refid="class_deprecated" kindref="compound">Deprecated</ref></term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="deprecated_1_deprecated000001"/>This class is deprecated </para>
|
||||
</listitem>
|
||||
<varlistentry>
|
||||
<term>Member <ref refid="class_deprecated_1a1d5f6803e72c625727e7083d1722dbf9" kindref="member">Deprecated::deprecated</ref> ()</term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="deprecated_1_deprecated000002"/>No not use this function anymore. </para>
|
||||
</listitem>
|
||||
</variablelist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<?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="reminders" kind="page">
|
||||
<compoundname>reminders</compoundname>
|
||||
<title>Reminders</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Class <ref refid="class_reminder" kindref="compound">Reminder</ref></term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="reminders_1_reminders000001"/>A reminder </para>
|
||||
</listitem>
|
||||
<varlistentry>
|
||||
<term>Member <ref refid="class_reminder_1a173b5218bb11287b0e86a550d9f0728d" kindref="member">Reminder::reminder</ref> ()</term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="reminders_1_reminders000002"/>Need to rework this before the next release. </para>
|
||||
</listitem>
|
||||
</variablelist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<?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="test" kind="page">
|
||||
<compoundname>test</compoundname>
|
||||
<title>Test List</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Class <ref refid="class_test" kindref="compound">Test</ref></term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="test_1_test000001"/>This is part of testing </para>
|
||||
</listitem>
|
||||
<varlistentry>
|
||||
<term>Member <ref refid="class_test_1a9fc54b716f326514a4c5f434137f4fc0" kindref="member">Test::test</ref> ()</term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="test_1_test000002"/>more things to test. </para>
|
||||
</listitem>
|
||||
</variablelist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
<?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="todo" kind="page">
|
||||
<compoundname>todo</compoundname>
|
||||
<title>Todo List</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term>Class <ref refid="class_todo" kindref="compound">Todo</ref></term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="todo_1_todo000001"/>This still needs to be done. </para>
|
||||
</listitem>
|
||||
<varlistentry>
|
||||
<term>Member <ref refid="class_todo_1a9e70ec9176ac4c1b20e011b4daddc9d8" kindref="member">Todo::todo</ref> ()</term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para><anchor id="todo_1_todo000002"/>more things to do here </para>
|
||||
</listitem>
|
||||
</variablelist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,62 +0,0 @@
|
|||
// objective: test the \bug, \deprecated, \todo, \test, and \xrefitem commands
|
||||
// check: class_bug.xml
|
||||
// check: class_deprecated.xml
|
||||
// check: class_todo.xml
|
||||
// check: class_test.xml
|
||||
// check: class_reminder.xml
|
||||
// check: bug.xml
|
||||
// check: deprecated.xml
|
||||
// check: todo.xml
|
||||
// check: test.xml
|
||||
// check: reminders.xml
|
||||
// config: ALIASES = "reminder=\xrefitem reminders \"Reminder\" \"Reminders\""
|
||||
|
||||
/** \bug Class bug. */
|
||||
class Bug
|
||||
{
|
||||
public:
|
||||
/** Description
|
||||
* \bug Function bug
|
||||
* - list item 1 in bug
|
||||
* - list item 2 in bug
|
||||
*
|
||||
* More text.
|
||||
*/
|
||||
void foo();
|
||||
};
|
||||
|
||||
/** \deprecated This class is deprecated */
|
||||
class Deprecated
|
||||
{
|
||||
public:
|
||||
/** Do deprecated things.
|
||||
* \deprecated No not use this function anymore.
|
||||
*/
|
||||
void deprecated();
|
||||
};
|
||||
|
||||
/** \todo This still needs to be done. */
|
||||
class Todo
|
||||
{
|
||||
public:
|
||||
/** \todo more things to do here */
|
||||
void todo();
|
||||
};
|
||||
|
||||
/** \test This is part of testing */
|
||||
class Test
|
||||
{
|
||||
public:
|
||||
/** \test more things to test. */
|
||||
void test();
|
||||
};
|
||||
|
||||
/** \reminder A reminder */
|
||||
class Reminder
|
||||
{
|
||||
public:
|
||||
/** \reminder Need to rework this before the next release. */
|
||||
void reminder();
|
||||
};
|
||||
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text <computeroutput>code</computeroutput> normal text.</para>
|
||||
<para>Text <computeroutput>code</computeroutput> normal text. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
// objective: test the \c and \p commands
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* Text \c code normal text.
|
||||
*
|
||||
* Text \p code normal text.
|
||||
*/
|
||||
|
|
@ -1,60 +0,0 @@
|
|||
<?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="category_integer_07_arithmetic_08" kind="category" language="Objective-C" prot="public">
|
||||
<compoundname>Integer(Arithmetic)</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="category_integer_07_arithmetic_08_1a12f411c5872ba3bafb8ea7dd1826cf2a" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
|
||||
<type>id</type>
|
||||
<definition>id Integer(Arithmetic)::add:</definition>
|
||||
<argsstring>(Integer *addend)</argsstring>
|
||||
<name>add:</name>
|
||||
<param>
|
||||
<type><ref refid="interface_integer" kindref="compound">Integer</ref> *</type>
|
||||
<declname>addend</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>add operation </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="011_category.m" line="8" column="1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="category_integer_07_arithmetic_08_1ae4ff0b0c62b6809e8f5bcee9baa6e521" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
|
||||
<type>id</type>
|
||||
<definition>id Integer(Arithmetic)::sub:</definition>
|
||||
<argsstring>(Integer *subtrahend)</argsstring>
|
||||
<name>sub:</name>
|
||||
<param>
|
||||
<type><ref refid="interface_integer" kindref="compound">Integer</ref> *</type>
|
||||
<declname>subtrahend</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>subtract operation </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="011_category.m" line="8" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A category </para>
|
||||
</detaileddescription>
|
||||
<location file="011_category.m" line="17" column="1" bodyfile="011_category.m" bodystart="17" bodyend="-1"/>
|
||||
<listofallmembers>
|
||||
<member refid="category_integer_07_arithmetic_08_1a12f411c5872ba3bafb8ea7dd1826cf2a" prot="public" virt="virtual">
|
||||
<scope>Integer(Arithmetic)</scope>
|
||||
<name>add:</name>
|
||||
</member>
|
||||
<member refid="category_integer_07_arithmetic_08_1ae4ff0b0c62b6809e8f5bcee9baa6e521" prot="public" virt="virtual">
|
||||
<scope>Integer(Arithmetic)</scope>
|
||||
<name>sub:</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,99 +0,0 @@
|
|||
<?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="interface_integer" kind="class" language="Objective-C" prot="public">
|
||||
<compoundname>Integer</compoundname>
|
||||
<basecompoundref prot="public" virt="non-virtual">Object</basecompoundref>
|
||||
<sectiondef kind="protected-attrib">
|
||||
<memberdef kind="variable" id="interface_integer_1a35e89216966d8179a1b77f14b8211fda" prot="protected" static="no" mutable="no">
|
||||
<type>int</type>
|
||||
<definition>int Integer::integer</definition>
|
||||
<argsstring/>
|
||||
<name>integer</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>data member </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="011_category.m" line="8" column="1" bodyfile="011_category.m" bodystart="8" bodyend="-1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="interface_integer_1a7b55035e1b0e8e7d4c8587f54a760819" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
|
||||
<type>int</type>
|
||||
<definition>int Integer::integer</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>integer</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>getter </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="011_category.m" line="8" column="1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="interface_integer_1ad2f47761103b2442ff7b3fbfe33ec6c9" prot="public" static="no" const="no" explicit="no" inline="no" virt="virtual">
|
||||
<type>id</type>
|
||||
<definition>id Integer::integer:</definition>
|
||||
<argsstring>(int _integer)</argsstring>
|
||||
<name>integer:</name>
|
||||
<param>
|
||||
<type>int</type>
|
||||
<declname>_integer</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>setter </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="011_category.m" line="8" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>An interface </para>
|
||||
</detaileddescription>
|
||||
<inheritancegraph>
|
||||
<node id="1">
|
||||
<label>Object</label>
|
||||
</node>
|
||||
<node id="0">
|
||||
<label>Integer</label>
|
||||
<link refid="interface_integer"/>
|
||||
<childnode refid="1" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
</inheritancegraph>
|
||||
<collaborationgraph>
|
||||
<node id="3">
|
||||
<label>Object</label>
|
||||
</node>
|
||||
<node id="2">
|
||||
<label>Integer</label>
|
||||
<link refid="interface_integer"/>
|
||||
<childnode refid="3" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
</collaborationgraph>
|
||||
<location file="011_category.m" line="6" column="1" bodyfile="011_category.m" bodystart="6" bodyend="-1"/>
|
||||
<listofallmembers>
|
||||
<member refid="interface_integer_1a35e89216966d8179a1b77f14b8211fda" prot="protected" virt="non-virtual">
|
||||
<scope>Integer</scope>
|
||||
<name>integer</name>
|
||||
</member>
|
||||
<member refid="interface_integer_1a7b55035e1b0e8e7d4c8587f54a760819" prot="public" virt="virtual">
|
||||
<scope>Integer</scope>
|
||||
<name>integer</name>
|
||||
</member>
|
||||
<member refid="interface_integer_1ad2f47761103b2442ff7b3fbfe33ec6c9" prot="public" virt="virtual">
|
||||
<scope>Integer</scope>
|
||||
<name>integer:</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,30 +0,0 @@
|
|||
// objective: test the \interface and \category command
|
||||
// check: category_integer_07_arithmetic_08.xml
|
||||
// check: interface_integer.xml
|
||||
# import <objc/Object.h>
|
||||
|
||||
@interface Integer : Object {
|
||||
/** data member */
|
||||
int integer;
|
||||
}
|
||||
|
||||
/** getter */
|
||||
- (int) integer;
|
||||
/** setter */
|
||||
- (id) integer: (int) _integer;
|
||||
@end
|
||||
|
||||
@interface Integer (Arithmetic)
|
||||
/** add operation */
|
||||
- (id) add: (Integer *) addend;
|
||||
/** subtract operation */
|
||||
- (id) sub: (Integer *) subtrahend;
|
||||
@end
|
||||
|
||||
/** \interface Integer
|
||||
* An interface
|
||||
*/
|
||||
|
||||
/** \category Integer(Arithmetic)
|
||||
* A category
|
||||
*/
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
<?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="citelist" kind="page">
|
||||
<compoundname>citelist</compoundname>
|
||||
<title>Bibliography</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<variablelist>
|
||||
<varlistentry>
|
||||
<term><anchor id="citelist_1CITEREF_knuth79"/>[1]</term>
|
||||
</varlistentry>
|
||||
<listitem>
|
||||
<para>Donald<nonbreakablespace/>E. Knuth. <emphasis>Tex and Metafont, New Directions in Typesetting</emphasis>. American Mathematical Society and Digital Press, Stanford, 1979.</para>
|
||||
<para/>
|
||||
</listitem>
|
||||
</variablelist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>See <ref refid="citelist_1CITEREF_knuth79" kindref="member">[1]</ref> for more info. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
// objective: test the \cite command
|
||||
// check: indexpage.xml
|
||||
// check: citelist.xml
|
||||
// config: CITE_BIB_FILES = $INPUTDIR/sample.bib
|
||||
/** \mainpage
|
||||
* See \cite knuth79 for more info.
|
||||
*/
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<?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="class_t1" kind="class" language="C++" prot="public">
|
||||
<compoundname>T1</compoundname>
|
||||
<includes refid="013__class_8h" local="yes">inc/013_class.h</includes>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A class </para>
|
||||
</detaileddescription>
|
||||
<location file="013_class.h" line="11" column="1" bodyfile="013_class.h" bodystart="10" bodyend="12"/>
|
||||
<listofallmembers>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<?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="class_t2" kind="class" language="C++" prot="public">
|
||||
<compoundname>T2</compoundname>
|
||||
<includes refid="013__class_8h" local="no">013_class.h</includes>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>class <ref refid="class_t2" kindref="compound">T2</ref> </para>
|
||||
</detaileddescription>
|
||||
<location file="013_class.h" line="15" column="1" bodyfile="013_class.h" bodystart="14" bodyend="16"/>
|
||||
<listofallmembers>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<?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="class_t3" kind="class" language="C++" prot="public">
|
||||
<compoundname>T3</compoundname>
|
||||
<includes refid="013__class_8h" local="no">013_class.h</includes>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>class <ref refid="class_t3" kindref="compound">T3</ref> </para>
|
||||
</detaileddescription>
|
||||
<location file="013_class.h" line="19" column="1" bodyfile="013_class.h" bodystart="18" bodyend="20"/>
|
||||
<listofallmembers>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<?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="class_t4" kind="class" language="C++" prot="public">
|
||||
<compoundname>T4</compoundname>
|
||||
<includes refid="013__class_8h" local="yes">inc/013_class.h</includes>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>class <ref refid="class_t4" kindref="compound">T4</ref> </para>
|
||||
</detaileddescription>
|
||||
<location file="013_class.h" line="23" column="1" bodyfile="013_class.h" bodystart="22" bodyend="24"/>
|
||||
<listofallmembers>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
// objective: test the \class and \headerfile commands
|
||||
// check: class_t1.xml
|
||||
// check: class_t2.xml
|
||||
// check: class_t3.xml
|
||||
// check: class_t4.xml
|
||||
|
||||
/** A class
|
||||
* \headerfile 013_class.h "inc/013_class.h"
|
||||
*/
|
||||
class T1
|
||||
{
|
||||
};
|
||||
|
||||
class T2
|
||||
{
|
||||
};
|
||||
|
||||
class T3
|
||||
{
|
||||
};
|
||||
|
||||
class T4
|
||||
{
|
||||
};
|
||||
|
||||
/** \class T2
|
||||
* \headerfile <>
|
||||
* class T2
|
||||
*/
|
||||
|
||||
/** \class T3 013_class.h
|
||||
* class T3
|
||||
*/
|
||||
|
||||
/** \class T4 013_class.h "inc/013_class.h"
|
||||
* class T4
|
||||
*/
|
||||
|
|
@ -1,51 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<programlisting filename=".py">
|
||||
<codeline>
|
||||
<highlight class="comment">#<sp/>comment<sp/>in<sp/>Python</highlight>
|
||||
<highlight class="normal"/>
|
||||
</codeline>
|
||||
<codeline>
|
||||
<highlight class="normal"/>
|
||||
<highlight class="keyword">class<sp/></highlight>
|
||||
<highlight class="normal">Python:</highlight>
|
||||
</codeline>
|
||||
<codeline>
|
||||
<highlight class="normal">
|
||||
<sp/>
|
||||
<sp/>
|
||||
</highlight>
|
||||
<highlight class="keywordflow">pass</highlight>
|
||||
</codeline>
|
||||
</programlisting>
|
||||
</para>
|
||||
<para>
|
||||
<programlisting filename=".cpp">
|
||||
<codeline>
|
||||
<highlight class="comment">//<sp/>comment<sp/>in<sp/>a<sp/>code<sp/>block</highlight>
|
||||
<highlight class="normal"/>
|
||||
</codeline>
|
||||
<codeline>
|
||||
<highlight class="normal"/>
|
||||
<highlight class="keyword">class<sp/></highlight>
|
||||
<highlight class="normal">Cpp<sp/>{};</highlight>
|
||||
</codeline>
|
||||
</programlisting>
|
||||
</para>
|
||||
<para>
|
||||
<programlisting>
|
||||
<codeline>
|
||||
<highlight class="normal">//<sp />implicit<sp />code<sp />language</highlight>
|
||||
</codeline>
|
||||
</programlisting>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
// objective: test the \code command
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* \code{.py}
|
||||
* # comment in Python
|
||||
* class Python:
|
||||
* pass
|
||||
* \endcode
|
||||
*
|
||||
* \code{.cpp}
|
||||
* // comment in a code block
|
||||
* class Cpp {};
|
||||
* \endcode
|
||||
*
|
||||
* \code
|
||||
* // implicit code language
|
||||
* \endcode
|
||||
*/
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
<?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="015__cond_8c" kind="file" language="C++">
|
||||
<compoundname>015_cond.c</compoundname>
|
||||
<sectiondef kind="func">
|
||||
<memberdef kind="function" id="015__cond_8c_1a2521dcda743ec66ad8e030113d6e0c63" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void cond_enabled</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>cond_enabled</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Function to be shown. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="015_cond.c" line="21" column="1" bodyfile="015_cond.c" bodystart="21" bodyend="23"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text <emphasis>argument</emphasis> more text. </para>
|
||||
</detaileddescription>
|
||||
<location file="015_cond.c"/>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,32 +0,0 @@
|
|||
// objective: test the `cond` command
|
||||
// check: 015__cond_8c.xml
|
||||
// config: ENABLED_SECTIONS = COND_ENABLED
|
||||
|
||||
/** \file
|
||||
* Text \a argument more text.
|
||||
*/
|
||||
|
||||
/// \cond
|
||||
|
||||
/** A function */
|
||||
void func();
|
||||
|
||||
/** A macro */
|
||||
#define MACRO 42
|
||||
|
||||
/// \endcond
|
||||
|
||||
/// \cond COND_ENABLED
|
||||
/// Function to be shown.
|
||||
void cond_enabled()
|
||||
{
|
||||
}
|
||||
/// \endcond
|
||||
|
||||
/** \cond COND_DISABLED */
|
||||
Function not to be shown.
|
||||
void cond_disabled()
|
||||
{
|
||||
}
|
||||
/** \endcond */
|
||||
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
<?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="016__copydoc_8c" kind="file" language="C++">
|
||||
<compoundname>016_copydoc.c</compoundname>
|
||||
<sectiondef kind="func">
|
||||
<memberdef kind="function" id="016__copydoc_8c_1af721a79655a3857b98d70fa6ada8a916" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func</definition>
|
||||
<argsstring>(int i)</argsstring>
|
||||
<name>func</name>
|
||||
<param>
|
||||
<type>int</type>
|
||||
<declname>i</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
<para>Brief description. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Detailed description. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="016_copydoc.c" line="11" column="1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="016__copydoc_8c_1a119dbcf2f0bc3ec1fbf77fcd35dec6df" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func_brief</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>func_brief</name>
|
||||
<briefdescription>
|
||||
<para>Brief description. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="016_copydoc.c" line="14" column="1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="016__copydoc_8c_1a3c1e44de2b412b5218b55e216cebb4ac" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func_details</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>func_details</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Detailed description. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="016_copydoc.c" line="17" column="1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="016__copydoc_8c_1a2535f29ea009c3d7449264671e15afe9" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func_doc</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>func_doc</name>
|
||||
<briefdescription>
|
||||
<para>Brief description. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Detailed description. More text. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="016_copydoc.c" line="22" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text <emphasis>argument</emphasis> more text. </para>
|
||||
</detaileddescription>
|
||||
<location file="016_copydoc.c"/>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
// objective: test the \copydoc, \copybrief, \copydetails, and \details commands
|
||||
// check: 016__copydoc_8c.xml
|
||||
|
||||
/** \file
|
||||
* Text \a argument more text.
|
||||
*/
|
||||
|
||||
/** \brief Brief description.
|
||||
* \details Detailed description.
|
||||
*/
|
||||
void func(int i);
|
||||
|
||||
/** \copybrief func(int) */
|
||||
void func_brief();
|
||||
|
||||
/** \copydetails func(int) */
|
||||
void func_details();
|
||||
|
||||
/** \copydoc func(int)
|
||||
* More text.
|
||||
*/
|
||||
void func_doc();
|
||||
|
||||
|
|
@ -1,19 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<simplesect kind="copyright">
|
||||
<para>Dimitri van Heesch </para>
|
||||
</simplesect>
|
||||
<simplesect kind="date">
|
||||
<para>July 13 2013 </para>
|
||||
</simplesect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,6 +0,0 @@
|
|||
// objective: test \copyright and \date commands
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* \copyright Dimitri van Heesch
|
||||
* \date July 13 2013
|
||||
*/
|
||||
|
|
@ -1,126 +0,0 @@
|
|||
<?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="018__def_8c" kind="file" language="C++">
|
||||
<compoundname>018_def.c</compoundname>
|
||||
<sectiondef kind="define">
|
||||
<memberdef kind="define" id="018__def_8c_1a824c99cb152a3c2e9111a2cb9c34891e" prot="public" static="no">
|
||||
<name>MACRO</name>
|
||||
<initializer>42</initializer>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A macro definition </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="018_def.c" line="8" column="9"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<sectiondef kind="enum">
|
||||
<memberdef kind="enum" id="018__def_8c_1aa57b8491d1d8fc1014dd54bcf83b130a" prot="public" static="no" strong="no">
|
||||
<type/>
|
||||
<name>E</name>
|
||||
<enumvalue id="018__def_8c_1aa57b8491d1d8fc1014dd54bcf83b130aab1710e6a49014ba389d57c8753c530f4" prot="public">
|
||||
<name>E1</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
</enumvalue>
|
||||
<enumvalue id="018__def_8c_1aa57b8491d1d8fc1014dd54bcf83b130aace9a5783f96994d28bc6ec5c9ece8c80" prot="public">
|
||||
<name>E2</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
</enumvalue>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>An enum </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="018_def.c" line="13" column="1" bodyfile="018_def.c" bodystart="13" bodyend="13"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<sectiondef kind="typedef">
|
||||
<memberdef kind="typedef" id="018__def_8c_1a1d1cfd8ffb84e947f82999c682b666a7" prot="public" static="no">
|
||||
<type>int</type>
|
||||
<definition>Type</definition>
|
||||
<argsstring/>
|
||||
<name>Type</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A type definition. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="018_def.c" line="12" column="1" bodyfile="018_def.c" bodystart="12" bodyend="-1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<sectiondef kind="var">
|
||||
<memberdef kind="variable" id="018__def_8c_1a335628f2e9085305224b4f9cc6e95ed5" prot="public" static="no" mutable="no">
|
||||
<type>int</type>
|
||||
<definition>var</definition>
|
||||
<argsstring/>
|
||||
<name>var</name>
|
||||
<initializer>= 10</initializer>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A variable </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="018_def.c" line="9" column="1" bodyfile="018_def.c" bodystart="9" bodyend="-1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<sectiondef kind="func">
|
||||
<memberdef kind="function" id="018__def_8c_1aee50dbe7d43d2202b490a6977a325584" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>func</definition>
|
||||
<argsstring>(int)</argsstring>
|
||||
<name>func</name>
|
||||
<param>
|
||||
<type>int</type>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A function with one parameter. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="018_def.c" line="10" column="1" bodyfile="018_def.c" bodystart="10" bodyend="10"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="018__def_8c_1a2652ccbfb85efa2df3c70ba6c4628f8d" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>func</definition>
|
||||
<argsstring>(int, const char *)</argsstring>
|
||||
<name>func</name>
|
||||
<param>
|
||||
<type>int</type>
|
||||
</param>
|
||||
<param>
|
||||
<type>const char *</type>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A function with two parameters </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="018_def.c" line="11" column="1" bodyfile="018_def.c" bodystart="11" bodyend="11"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text <emphasis>argument</emphasis> more text. </para>
|
||||
</detaileddescription>
|
||||
<location file="018_def.c"/>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,37 +0,0 @@
|
|||
// objective: test the \def, \var, \fn, and \typedef commands
|
||||
// check: 018__def_8c.xml
|
||||
|
||||
/** \file
|
||||
* Text \a argument more text.
|
||||
*/
|
||||
|
||||
#define MACRO 42
|
||||
int var = 10;
|
||||
void func(int) {}
|
||||
void func(int,const char *) {}
|
||||
typedef int Type;
|
||||
enum E { E1, E2 };
|
||||
|
||||
/** \def MACRO
|
||||
* A macro definition
|
||||
*/
|
||||
|
||||
/** \var var
|
||||
* A variable
|
||||
*/
|
||||
|
||||
/** \fn func(int)
|
||||
* A function with one parameter.
|
||||
*/
|
||||
|
||||
/** \fn func(int,const char *)
|
||||
* A function with two parameters
|
||||
*/
|
||||
|
||||
/** \typedef Type
|
||||
* A type definition.
|
||||
*/
|
||||
|
||||
/** \enum E
|
||||
* An enum
|
||||
*/
|
||||
|
|
@ -1,28 +0,0 @@
|
|||
<?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="group__g1" kind="group">
|
||||
<compoundname>g1</compoundname>
|
||||
<title>First Group</title>
|
||||
<sectiondef kind="func">
|
||||
<memberdef kind="function" id="group__g1_1gae84463e3941387a9da58279761e18d7e" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func_g1</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>func_g1</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A function in the first group. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="019_defgroup.c" line="13" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text for first group. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,29 +0,0 @@
|
|||
<?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="group__g2" kind="group">
|
||||
<compoundname>g2</compoundname>
|
||||
<title>Second Group</title>
|
||||
<innergroup refid="group__g3">Third Group</innergroup>
|
||||
<sectiondef kind="func">
|
||||
<memberdef kind="function" id="group__g2_1gafd310bbec27993e80a5dbaf6c54d5e0b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func_g2</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>func_g2</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A function in the second group </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="019_defgroup.c" line="23" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text for second group. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
<?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="group__g3" kind="group">
|
||||
<compoundname>g3</compoundname>
|
||||
<title>Third Group</title>
|
||||
<sectiondef kind="func">
|
||||
<memberdef kind="function" id="group__g3_1ga59de48fb40aec5ee2623cc453fe71643" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func_g3</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>func_g3</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A function in the third group </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="019_defgroup.c" line="36" column="1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="group__g3_1gaf32d23522a5d9c3e7fed3dd5710001f7" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func_g3_add</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>func_g3_add</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Another function added to the third group </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="019_defgroup.c" line="45" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text for third group. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,48 +0,0 @@
|
|||
// objective: test the \defgroup, \addtogroup, and \ingroup command.
|
||||
// check: group__g1.xml
|
||||
// check: group__g2.xml
|
||||
// check: group__g3.xml
|
||||
|
||||
/** \defgroup g1 First Group
|
||||
* Text for first group.
|
||||
*/
|
||||
|
||||
/** A function in the first group.
|
||||
* \ingroup g1
|
||||
*/
|
||||
void func_g1();
|
||||
|
||||
//--------------------------------
|
||||
|
||||
/** \defgroup g2 Second Group
|
||||
* Text for second group.
|
||||
*/
|
||||
/// \{
|
||||
|
||||
/** A function in the second group */
|
||||
void func_g2();
|
||||
|
||||
/// \}
|
||||
|
||||
/** \defgroup g3 Third Group
|
||||
* Text for third group.
|
||||
* \ingroup g2
|
||||
* \{
|
||||
*/
|
||||
|
||||
//--------------------------------
|
||||
|
||||
/** A function in the third group */
|
||||
void func_g3();
|
||||
|
||||
/** \} */
|
||||
|
||||
/** \addtogroup g3
|
||||
* \{
|
||||
*/
|
||||
|
||||
/** Another function added to the third group */
|
||||
void func_g3_add();
|
||||
|
||||
/** \} */
|
||||
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text.
|
||||
XML
|
||||
More text. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,27 +0,0 @@
|
|||
// objective: test the \*only and \*endonly commands
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* Text.
|
||||
* \htmlonly
|
||||
* HTML
|
||||
* \endhtmlonly
|
||||
* \htmlonly[block]
|
||||
* HTML with block
|
||||
* \endhtmlonly
|
||||
* \rtfonly
|
||||
* RTF
|
||||
* \endrtfonly
|
||||
* \manonly
|
||||
* Man
|
||||
* \endmanonly
|
||||
* \latexonly
|
||||
* LaTeX
|
||||
* \endlatexonly
|
||||
* \xmlonly
|
||||
* XML
|
||||
* \endxmlonly
|
||||
* \docbookonly
|
||||
* DocBook
|
||||
* \enddocbookonly
|
||||
* More text.
|
||||
*/
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para> Our main function starts like this: <programlisting filename="example_test.cpp"><codeline><highlight class="normal">void<sp/>main()</highlight></codeline><codeline><highlight class="normal">{</highlight></codeline></programlisting> First we create a object <computeroutput>t</computeroutput> of the <ref refid="class_test" kindref="compound">Test</ref> class. <programlisting filename="example_test.cpp"><codeline><highlight class="normal"><sp/><sp/>Test<sp/>t;</highlight></codeline></programlisting> Then we call the example member function <programlisting filename="example_test.cpp"><codeline><highlight class="normal"><sp/><sp/>t.example();</highlight></codeline></programlisting> After that our little test routine ends. <programlisting filename="example_test.cpp"><codeline><highlight class="normal">}</highlight></codeline></programlisting> </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
// objective: test the \dontinclude, \skip, \until, \skipline, \line commands
|
||||
// check: indexpage.xml
|
||||
/*! A test class. */
|
||||
|
||||
class Test
|
||||
{
|
||||
public:
|
||||
/// a member function
|
||||
void example();
|
||||
};
|
||||
|
||||
/*! \mainpage
|
||||
* \dontinclude example_test.cpp
|
||||
* Our main function starts like this:
|
||||
* \skip main
|
||||
* \until {
|
||||
* First we create a object \c t of the Test class.
|
||||
* \skipline Test
|
||||
* Then we call the example member function
|
||||
* \line example
|
||||
* After that our little test routine ends.
|
||||
* \line }
|
||||
*/
|
||||
|
|
@ -1,20 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Class relations expressed via an inline dot graph: <dot>
|
||||
digraph example {
|
||||
node [shape=record, fontname=Helvetica, fontsize=10];
|
||||
b [ label="class B" URL="\ref B"];
|
||||
c [ label="class C" URL="\ref C"];
|
||||
b -> c [ arrowhead="open", style="dashed" ];
|
||||
}
|
||||
</dot>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,22 +0,0 @@
|
|||
// objective: test the \dot and \enddot commands
|
||||
// check: indexpage.xml
|
||||
// config: HAVE_DOT = YES
|
||||
// config: DOTFILE_DIRS = $INPUTDIR
|
||||
|
||||
/*! class B */
|
||||
class B {};
|
||||
/*! class C */
|
||||
class C {};
|
||||
|
||||
/*! \mainpage
|
||||
Class relations expressed via an inline dot graph:
|
||||
\dot
|
||||
digraph example {
|
||||
node [shape=record, fontname=Helvetica, fontsize=10];
|
||||
b [ label="class B" URL="\ref B"];
|
||||
c [ label="class C" URL="\ref C"];
|
||||
b -> c [ arrowhead="open", style="dashed" ];
|
||||
}
|
||||
\enddot
|
||||
*/
|
||||
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Normal <emphasis>emphasis</emphasis> and more <emphasis>emphasis</emphasis> back to normal. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,5 +0,0 @@
|
|||
// objective: test the \e, \em commands
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* Normal \e emphasis and more \em emphasis back to normal.
|
||||
*/
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Unconditional (start) Enabled (if). Enabled (else). Unconditional (middle) Enabled (else). Unconditional (end) </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
// objective: test the \if, \ifnot, \elsif, \else, and \endif commands
|
||||
// check: indexpage.xml
|
||||
// config: ENABLED_SECTIONS = GUARD_ENABLED
|
||||
/** \mainpage
|
||||
* Unconditional (start)
|
||||
* \if GUARD_ENABLED
|
||||
* Enabled (if).
|
||||
* \if (!GUARD_ENABLED) Disabled (if).\else Enabled (else). \endif
|
||||
* \else
|
||||
* Disabled.
|
||||
* \endif
|
||||
* Unconditional (middle)
|
||||
* \ifnot GUARD_ENABLED
|
||||
* Disabled (ifnot).
|
||||
* \elseif GUARD_DISABLED
|
||||
* Disabled (elseif).
|
||||
* \else
|
||||
* Enabled (else).
|
||||
* \endif
|
||||
* Unconditional (end)
|
||||
*/
|
||||
|
|
@ -1,36 +0,0 @@
|
|||
<?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="class_test" kind="class" language="C++" prot="public">
|
||||
<compoundname>Test</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_test_1a47b775f65718978f1ffcd96376f8ecfa" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void Test::example</definition>
|
||||
<argsstring>()</argsstring>
|
||||
<name>example</name>
|
||||
<briefdescription>
|
||||
<para>An example member function. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>More details about this function. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="025_example.cpp" line="17" column="1" bodyfile="025_example.cpp" bodystart="20" bodyend="20"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
<para>A <ref refid="class_test" kindref="compound">Test</ref> class. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>More details about this class. </para>
|
||||
</detaileddescription>
|
||||
<location file="025_example.cpp" line="11" column="1" bodyfile="025_example.cpp" bodystart="10" bodyend="18"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_test_1a47b775f65718978f1ffcd96376f8ecfa" prot="public" virt="non-virtual">
|
||||
<scope>Test</scope>
|
||||
<name>example</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="example_test_8cpp-example" kind="example">
|
||||
<compoundname>example_test.cpp</compoundname>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>This is an example of how to use the <ref refid="class_test" kindref="compound">Test</ref> class.</para>
|
||||
<para>More details about this example. <programlisting filename="example_test.cpp"><codeline><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline><highlight class="normal">{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal">*<sp/>a<sp/>=<sp/></highlight><highlight class="stringliteral">"Some<sp/>special<sp/>character<sp/>here:<sp/><sp value="7"/><sp/>"</highlight><highlight class="normal">;</highlight></codeline><codeline><highlight class="normal"/></codeline><codeline><highlight class="normal"><sp/><sp/><ref refid="class_test" kindref="compound">Test</ref><sp/>t;</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>t.<ref refid="class_test_1a47b775f65718978f1ffcd96376f8ecfa" kindref="member">example</ref>();</highlight></codeline><codeline><highlight class="normal">}</highlight></codeline><codeline><highlight class="normal"/></codeline></programlisting> </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,26 +0,0 @@
|
|||
// objective: test the \example command
|
||||
// check: example_test_8cpp-example.xml
|
||||
// check: class_test.xml
|
||||
|
||||
|
||||
/** \brief A Test class.
|
||||
*
|
||||
* More details about this class.
|
||||
*/
|
||||
class Test
|
||||
{
|
||||
public:
|
||||
/** \brief An example member function.
|
||||
*
|
||||
* More details about this function.
|
||||
*/
|
||||
void example();
|
||||
};
|
||||
|
||||
void Test::example() {}
|
||||
|
||||
/** \example example_test.cpp
|
||||
* This is an example of how to use the Test class.
|
||||
*
|
||||
* More details about this example.
|
||||
*/
|
||||
|
|
@ -1,52 +0,0 @@
|
|||
<?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="class_test" kind="class" language="C++" prot="public">
|
||||
<compoundname>Test</compoundname>
|
||||
<templateparamlist>
|
||||
<param>
|
||||
<type>class T</type>
|
||||
</param>
|
||||
</templateparamlist>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_test_1abf9d5fbdaa4c23d0a513ee9746060779" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>int</type>
|
||||
<definition>int Test< T >::example</definition>
|
||||
<argsstring>(int p1, int p2)</argsstring>
|
||||
<name>example</name>
|
||||
<param>
|
||||
<type>int</type>
|
||||
<declname>p1</declname>
|
||||
</param>
|
||||
<param>
|
||||
<type>int</type>
|
||||
<declname>p2</declname>
|
||||
</param>
|
||||
<exceptions> throw (std::out_of_range)</exceptions>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>An example member function. <parameterlist kind="param"><parameteritem><parameternamelist><parametername>p1</parametername></parameternamelist><parameterdescription><para>First parameter. </para></parameterdescription></parameteritem><parameteritem><parameternamelist><parametername>p2</parametername></parameternamelist><parameterdescription><para>Second parameter. </para></parameterdescription></parameteritem></parameterlist>
|
||||
<parameterlist kind="exception"><parameteritem><parameternamelist><parametername>std::out_of_range</parametername></parameternamelist><parameterdescription><para>parameter is out of range. </para></parameterdescription></parameteritem></parameterlist>
|
||||
<parameterlist kind="retval"><parameteritem><parameternamelist><parametername>0</parametername></parameternamelist><parameterdescription><para>if p1 and p2 are equal </para></parameterdescription></parameteritem><parameteritem><parameternamelist><parametername>-1</parametername></parameternamelist><parameterdescription><para>if p1 is smaller than p2 </para></parameterdescription></parameteritem><parameteritem><parameternamelist><parametername>1</parametername></parameternamelist><parameterdescription><para>if p1 is bigger than p2 </para></parameterdescription></parameteritem></parameterlist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="026_exception.cpp" line="19" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A <ref refid="class_test" kindref="compound">Test</ref> class. More details about this class. <parameterlist kind="templateparam"><parameteritem><parameternamelist><parametername>T</parametername></parameternamelist><parameterdescription><para>A template parameter. </para></parameterdescription></parameteritem></parameterlist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<location file="026_exception.cpp" line="9" column="1" bodyfile="026_exception.cpp" bodystart="8" bodyend="20"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_test_1abf9d5fbdaa4c23d0a513ee9746060779" prot="public" virt="non-virtual">
|
||||
<scope>Test</scope>
|
||||
<name>example</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
// objective: test the \exception, \param, and \tparam commands
|
||||
// check: class_test.xml
|
||||
|
||||
/** A Test class.
|
||||
* More details about this class.
|
||||
* @tparam T A template parameter.
|
||||
*/
|
||||
template<class T> class Test
|
||||
{
|
||||
public:
|
||||
/** An example member function.
|
||||
* \param p1 First parameter.
|
||||
* \param p2 Second parameter.
|
||||
* \exception std::out_of_range parameter is out of range.
|
||||
* \retval 0 if p1 and p2 are equal
|
||||
* \retval -1 if p1 is smaller than p2
|
||||
* \retval 1 if p1 is bigger than p2
|
||||
*/
|
||||
int example(int p1,int p2) throw(std::out_of_range);
|
||||
};
|
||||
|
||||
|
|
@ -1,95 +0,0 @@
|
|||
<?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="struct_car" kind="struct" language="C++" prot="public">
|
||||
<compoundname>Car</compoundname>
|
||||
<basecompoundref refid="struct_vehicle" prot="public" virt="non-virtual">Vehicle</basecompoundref>
|
||||
<sectiondef kind="protected-attrib">
|
||||
<memberdef kind="variable" id="struct_car_1ab8ff28306286da5a8b14fa9bdccaafaa" prot="protected" static="no" mutable="no">
|
||||
<type>
|
||||
<ref refid="struct_vehicle" kindref="compound">Vehicle</ref>
|
||||
</type>
|
||||
<definition>Vehicle Car::base</definition>
|
||||
<argsstring/>
|
||||
<name>base</name>
|
||||
<briefdescription>
|
||||
<para>Base class. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="027_extends.c" line="69" column="1" bodyfile="027_extends.c" bodystart="69" bodyend="-1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para><ref refid="struct_car" kindref="compound">Car</ref> class. </para>
|
||||
</detaileddescription>
|
||||
<inheritancegraph>
|
||||
<node id="1">
|
||||
<label>Vehicle</label>
|
||||
<link refid="struct_vehicle"/>
|
||||
<childnode refid="2" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="2">
|
||||
<label>Object</label>
|
||||
<link refid="struct_object"/>
|
||||
</node>
|
||||
<node id="0">
|
||||
<label>Car</label>
|
||||
<link refid="struct_car"/>
|
||||
<childnode refid="1" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
</inheritancegraph>
|
||||
<collaborationgraph>
|
||||
<node id="4">
|
||||
<label>Vehicle</label>
|
||||
<link refid="struct_vehicle"/>
|
||||
<childnode refid="5" relation="public-inheritance">
|
||||
</childnode>
|
||||
<childnode refid="5" relation="usage">
|
||||
<edgelabel>base</edgelabel>
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="5">
|
||||
<label>Object</label>
|
||||
<link refid="struct_object"/>
|
||||
</node>
|
||||
<node id="3">
|
||||
<label>Car</label>
|
||||
<link refid="struct_car"/>
|
||||
<childnode refid="4" relation="public-inheritance">
|
||||
</childnode>
|
||||
<childnode refid="4" relation="usage">
|
||||
<edgelabel>base</edgelabel>
|
||||
</childnode>
|
||||
</node>
|
||||
</collaborationgraph>
|
||||
<location file="027_extends.c" line="68" column="1" bodyfile="027_extends.c" bodystart="67" bodyend="70"/>
|
||||
<listofallmembers>
|
||||
<member refid="struct_car_1ab8ff28306286da5a8b14fa9bdccaafaa" prot="protected" virt="non-virtual">
|
||||
<scope>Car</scope>
|
||||
<name>base</name>
|
||||
</member>
|
||||
<member refid="struct_object_1a71225073d06a793b9a6ea9263ed37b12" prot="public" virt="non-virtual">
|
||||
<scope>Car</scope>
|
||||
<name>objRef</name>
|
||||
</member>
|
||||
<member refid="struct_object_1a924ee0cecc906d148022b3f0d6325cfb" prot="public" virt="non-virtual">
|
||||
<scope>Car</scope>
|
||||
<name>objUnref</name>
|
||||
</member>
|
||||
<member refid="struct_vehicle_1a6891d3d28853bc3fdd075596dc6de9f8" prot="public" virt="non-virtual">
|
||||
<scope>Car</scope>
|
||||
<name>vehicleStart</name>
|
||||
</member>
|
||||
<member refid="struct_vehicle_1a4dcbcba43792dcd673a552b14479ab77" prot="public" virt="non-virtual">
|
||||
<scope>Car</scope>
|
||||
<name>vehicleStop</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,105 +0,0 @@
|
|||
<?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="struct_object" kind="struct" language="C++" prot="public">
|
||||
<compoundname>Object</compoundname>
|
||||
<derivedcompoundref refid="struct_vehicle" prot="public" virt="non-virtual">Vehicle</derivedcompoundref>
|
||||
<sectiondef kind="private-attrib">
|
||||
<memberdef kind="variable" id="struct_object_1a1b6037fba835e83243ababce426ff9af" prot="private" static="no" mutable="no">
|
||||
<type>int</type>
|
||||
<definition>int Object::ref</definition>
|
||||
<argsstring/>
|
||||
<name>ref</name>
|
||||
<briefdescription>
|
||||
<para>Reference count. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="027_extends.c" line="21" column="1" bodyfile="027_extends.c" bodystart="21" bodyend="-1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="struct_object_1a71225073d06a793b9a6ea9263ed37b12" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type><ref refid="struct_object" kindref="compound">Object</ref> *</type>
|
||||
<definition>static Object * objRef</definition>
|
||||
<argsstring>(Object *obj)</argsstring>
|
||||
<name>objRef</name>
|
||||
<param>
|
||||
<type><ref refid="struct_object" kindref="compound">Object</ref> *</type>
|
||||
<declname>obj</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Increments object reference count by one. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="027_extends.c" line="29" column="1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="struct_object_1a924ee0cecc906d148022b3f0d6325cfb" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type><ref refid="struct_object" kindref="compound">Object</ref> *</type>
|
||||
<definition>static Object * objUnref</definition>
|
||||
<argsstring>(Object *obj)</argsstring>
|
||||
<name>objUnref</name>
|
||||
<param>
|
||||
<type><ref refid="struct_object" kindref="compound">Object</ref> *</type>
|
||||
<declname>obj</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Decrements object reference count by one. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="027_extends.c" line="36" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Base object class. </para>
|
||||
</detaileddescription>
|
||||
<inheritancegraph>
|
||||
<node id="9">
|
||||
<label>Truck</label>
|
||||
<link refid="struct_truck"/>
|
||||
<childnode refid="7" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="7">
|
||||
<label>Vehicle</label>
|
||||
<link refid="struct_vehicle"/>
|
||||
<childnode refid="6" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="6">
|
||||
<label>Object</label>
|
||||
<link refid="struct_object"/>
|
||||
</node>
|
||||
<node id="8">
|
||||
<label>Car</label>
|
||||
<link refid="struct_car"/>
|
||||
<childnode refid="7" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
</inheritancegraph>
|
||||
<location file="027_extends.c" line="20" column="1" bodyfile="027_extends.c" bodystart="19" bodyend="22"/>
|
||||
<listofallmembers>
|
||||
<member refid="struct_object_1a71225073d06a793b9a6ea9263ed37b12" prot="public" virt="non-virtual">
|
||||
<scope>Object</scope>
|
||||
<name>objRef</name>
|
||||
</member>
|
||||
<member refid="struct_object_1a924ee0cecc906d148022b3f0d6325cfb" prot="public" virt="non-virtual">
|
||||
<scope>Object</scope>
|
||||
<name>objUnref</name>
|
||||
</member>
|
||||
<member refid="struct_object_1a1b6037fba835e83243ababce426ff9af" prot="private" virt="non-virtual">
|
||||
<scope>Object</scope>
|
||||
<name>ref</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,95 +0,0 @@
|
|||
<?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="struct_truck" kind="struct" language="C++" prot="public">
|
||||
<compoundname>Truck</compoundname>
|
||||
<basecompoundref refid="struct_vehicle" prot="public" virt="non-virtual">Vehicle</basecompoundref>
|
||||
<sectiondef kind="protected-attrib">
|
||||
<memberdef kind="variable" id="struct_truck_1ad0ac321609dda1a6c552488b05ec7ac8" prot="protected" static="no" mutable="no">
|
||||
<type>
|
||||
<ref refid="struct_vehicle" kindref="compound">Vehicle</ref>
|
||||
</type>
|
||||
<definition>Vehicle Truck::base</definition>
|
||||
<argsstring/>
|
||||
<name>base</name>
|
||||
<briefdescription>
|
||||
<para>Base class. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="027_extends.c" line="79" column="1" bodyfile="027_extends.c" bodystart="79" bodyend="-1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para><ref refid="struct_truck" kindref="compound">Truck</ref> class. </para>
|
||||
</detaileddescription>
|
||||
<inheritancegraph>
|
||||
<node id="11">
|
||||
<label>Truck</label>
|
||||
<link refid="struct_truck"/>
|
||||
<childnode refid="12" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="12">
|
||||
<label>Vehicle</label>
|
||||
<link refid="struct_vehicle"/>
|
||||
<childnode refid="13" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="13">
|
||||
<label>Object</label>
|
||||
<link refid="struct_object"/>
|
||||
</node>
|
||||
</inheritancegraph>
|
||||
<collaborationgraph>
|
||||
<node id="14">
|
||||
<label>Truck</label>
|
||||
<link refid="struct_truck"/>
|
||||
<childnode refid="15" relation="public-inheritance">
|
||||
</childnode>
|
||||
<childnode refid="15" relation="usage">
|
||||
<edgelabel>base</edgelabel>
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="15">
|
||||
<label>Vehicle</label>
|
||||
<link refid="struct_vehicle"/>
|
||||
<childnode refid="16" relation="public-inheritance">
|
||||
</childnode>
|
||||
<childnode refid="16" relation="usage">
|
||||
<edgelabel>base</edgelabel>
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="16">
|
||||
<label>Object</label>
|
||||
<link refid="struct_object"/>
|
||||
</node>
|
||||
</collaborationgraph>
|
||||
<location file="027_extends.c" line="78" column="1" bodyfile="027_extends.c" bodystart="77" bodyend="80"/>
|
||||
<listofallmembers>
|
||||
<member refid="struct_truck_1ad0ac321609dda1a6c552488b05ec7ac8" prot="protected" virt="non-virtual">
|
||||
<scope>Truck</scope>
|
||||
<name>base</name>
|
||||
</member>
|
||||
<member refid="struct_object_1a71225073d06a793b9a6ea9263ed37b12" prot="public" virt="non-virtual">
|
||||
<scope>Truck</scope>
|
||||
<name>objRef</name>
|
||||
</member>
|
||||
<member refid="struct_object_1a924ee0cecc906d148022b3f0d6325cfb" prot="public" virt="non-virtual">
|
||||
<scope>Truck</scope>
|
||||
<name>objUnref</name>
|
||||
</member>
|
||||
<member refid="struct_vehicle_1a6891d3d28853bc3fdd075596dc6de9f8" prot="public" virt="non-virtual">
|
||||
<scope>Truck</scope>
|
||||
<name>vehicleStart</name>
|
||||
</member>
|
||||
<member refid="struct_vehicle_1a4dcbcba43792dcd673a552b14479ab77" prot="public" virt="non-virtual">
|
||||
<scope>Truck</scope>
|
||||
<name>vehicleStop</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,132 +0,0 @@
|
|||
<?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="struct_vehicle" kind="struct" language="C++" prot="public">
|
||||
<compoundname>Vehicle</compoundname>
|
||||
<basecompoundref refid="struct_object" prot="public" virt="non-virtual">Object</basecompoundref>
|
||||
<derivedcompoundref refid="struct_car" prot="public" virt="non-virtual">Car</derivedcompoundref>
|
||||
<derivedcompoundref refid="struct_truck" prot="public" virt="non-virtual">Truck</derivedcompoundref>
|
||||
<sectiondef kind="protected-attrib">
|
||||
<memberdef kind="variable" id="struct_vehicle_1ad7970f528d429f6fc1725173e93a77c2" prot="protected" static="no" mutable="no">
|
||||
<type>
|
||||
<ref refid="struct_object" kindref="compound">Object</ref>
|
||||
</type>
|
||||
<definition>Object Vehicle::base</definition>
|
||||
<argsstring/>
|
||||
<name>base</name>
|
||||
<briefdescription>
|
||||
<para>Base class. </para>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="027_extends.c" line="45" column="1" bodyfile="027_extends.c" bodystart="45" bodyend="-1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="struct_vehicle_1a6891d3d28853bc3fdd075596dc6de9f8" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void vehicleStart</definition>
|
||||
<argsstring>(Vehicle *obj)</argsstring>
|
||||
<name>vehicleStart</name>
|
||||
<param>
|
||||
<type><ref refid="struct_vehicle" kindref="compound">Vehicle</ref> *</type>
|
||||
<declname>obj</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Starts the vehicle. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="027_extends.c" line="53" column="1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="function" id="struct_vehicle_1a4dcbcba43792dcd673a552b14479ab77" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void vehicleStop</definition>
|
||||
<argsstring>(Vehicle *obj)</argsstring>
|
||||
<name>vehicleStop</name>
|
||||
<param>
|
||||
<type><ref refid="struct_vehicle" kindref="compound">Vehicle</ref> *</type>
|
||||
<declname>obj</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Stops the vehicle. </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="027_extends.c" line="60" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para><ref refid="struct_vehicle" kindref="compound">Vehicle</ref> class. </para>
|
||||
</detaileddescription>
|
||||
<inheritancegraph>
|
||||
<node id="20">
|
||||
<label>Truck</label>
|
||||
<link refid="struct_truck"/>
|
||||
<childnode refid="17" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="17">
|
||||
<label>Vehicle</label>
|
||||
<link refid="struct_vehicle"/>
|
||||
<childnode refid="18" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="18">
|
||||
<label>Object</label>
|
||||
<link refid="struct_object"/>
|
||||
</node>
|
||||
<node id="19">
|
||||
<label>Car</label>
|
||||
<link refid="struct_car"/>
|
||||
<childnode refid="17" relation="public-inheritance">
|
||||
</childnode>
|
||||
</node>
|
||||
</inheritancegraph>
|
||||
<collaborationgraph>
|
||||
<node id="21">
|
||||
<label>Vehicle</label>
|
||||
<link refid="struct_vehicle"/>
|
||||
<childnode refid="22" relation="public-inheritance">
|
||||
</childnode>
|
||||
<childnode refid="22" relation="usage">
|
||||
<edgelabel>base</edgelabel>
|
||||
</childnode>
|
||||
</node>
|
||||
<node id="22">
|
||||
<label>Object</label>
|
||||
<link refid="struct_object"/>
|
||||
</node>
|
||||
</collaborationgraph>
|
||||
<location file="027_extends.c" line="44" column="1" bodyfile="027_extends.c" bodystart="43" bodyend="46"/>
|
||||
<listofallmembers>
|
||||
<member refid="struct_vehicle_1ad7970f528d429f6fc1725173e93a77c2" prot="protected" virt="non-virtual">
|
||||
<scope>Vehicle</scope>
|
||||
<name>base</name>
|
||||
</member>
|
||||
<member refid="struct_object_1a71225073d06a793b9a6ea9263ed37b12" prot="public" virt="non-virtual">
|
||||
<scope>Vehicle</scope>
|
||||
<name>objRef</name>
|
||||
</member>
|
||||
<member refid="struct_object_1a924ee0cecc906d148022b3f0d6325cfb" prot="public" virt="non-virtual">
|
||||
<scope>Vehicle</scope>
|
||||
<name>objUnref</name>
|
||||
</member>
|
||||
<member refid="struct_vehicle_1a6891d3d28853bc3fdd075596dc6de9f8" prot="public" virt="non-virtual">
|
||||
<scope>Vehicle</scope>
|
||||
<name>vehicleStart</name>
|
||||
</member>
|
||||
<member refid="struct_vehicle_1a4dcbcba43792dcd673a552b14479ab77" prot="public" virt="non-virtual">
|
||||
<scope>Vehicle</scope>
|
||||
<name>vehicleStop</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,93 +0,0 @@
|
|||
// objective: test the \extends, \implements, \memberof, \private, and \public commands
|
||||
// check: struct_object.xml
|
||||
// check: struct_vehicle.xml
|
||||
// check: struct_car.xml
|
||||
// check: struct_truck.xml
|
||||
|
||||
/**
|
||||
* \file
|
||||
*/
|
||||
|
||||
typedef struct Object Object; //!< Object type
|
||||
typedef struct Vehicle Vehicle; //!< Vehicle type
|
||||
typedef struct Car Car; //!< Car type
|
||||
typedef struct Truck Truck; //!< Truck type
|
||||
|
||||
/*!
|
||||
* Base object class.
|
||||
*/
|
||||
struct Object
|
||||
{
|
||||
int ref; //!< \private Reference count.
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* Increments object reference count by one.
|
||||
* \public \memberof Object
|
||||
*/
|
||||
static Object * objRef(Object *obj);
|
||||
|
||||
|
||||
/*!
|
||||
* Decrements object reference count by one.
|
||||
* \public \memberof Object
|
||||
*/
|
||||
static Object * objUnref(Object *obj);
|
||||
|
||||
|
||||
/*!
|
||||
* Vehicle class.
|
||||
* \extends Object
|
||||
*/
|
||||
struct Vehicle
|
||||
{
|
||||
Object base; //!< \protected Base class.
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* Starts the vehicle.
|
||||
* \public \memberof Vehicle
|
||||
*/
|
||||
void vehicleStart(Vehicle *obj);
|
||||
|
||||
|
||||
/*!
|
||||
* Stops the vehicle.
|
||||
* \public \memberof Vehicle
|
||||
*/
|
||||
void vehicleStop(Vehicle *obj);
|
||||
|
||||
|
||||
/*!
|
||||
* Car class.
|
||||
* \implements Vehicle
|
||||
*/
|
||||
struct Car
|
||||
{
|
||||
Vehicle base; //!< \protected Base class.
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* Truck class.
|
||||
* \implements Vehicle
|
||||
*/
|
||||
struct Truck
|
||||
{
|
||||
Vehicle base; //!< \protected Base class.
|
||||
};
|
||||
|
||||
|
||||
/*!
|
||||
* Main function.
|
||||
*
|
||||
* Ref vehicleStart(), objRef(), objUnref().
|
||||
*/
|
||||
int main(void)
|
||||
{
|
||||
Car c;
|
||||
vehicleStart((Vehicle*) &c);
|
||||
}
|
||||
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Here are some formulas:<orderedlist><listitem><para>The distance between <formula id="0">$(x_1,y_1)$</formula> and <formula id="1">$(x_2,y_2)$</formula> is <formula id="2">$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}$</formula>.</para></listitem><listitem><para>Unnumbered formula: <formula id="3">\[ |I_2|=\left| \int_{0}^T \psi(t) \left\{ u(a,t)- \int_{\gamma(t)}^a \frac{d\theta}{k(\theta,t)} \int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi \right\} dt \right| \]</formula></para></listitem><listitem><para>Formula in different environment <formula id="4">\begin{eqnarray*} g &=& \frac{Gm_2}{r^2} \\ &=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\, \mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\ &=& 9.82066032\,\mbox{m/s}^2 \end{eqnarray*}</formula> </para></listitem></orderedlist>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,17 +0,0 @@
|
|||
// objective: test the \f$, \f[, \f], \f{, and \f} commands
|
||||
// check: indexpage.xml
|
||||
|
||||
/** @mainpage
|
||||
Here are some formulas:
|
||||
-# The distance between \f$(x_1,y_1)\f$ and \f$(x_2,y_2)\f$ is
|
||||
\f$\sqrt{(x_2-x_1)^2+(y_2-y_1)^2}\f$.
|
||||
-# Unnumbered formula:
|
||||
\f[ |I_2|=\left| \int_{0}^T \psi(t) \left\{ u(a,t)- \int_{\gamma(t)}^a
|
||||
\frac{d\theta}{k(\theta,t)} \int_{a}^\theta c(\xi)u_t(\xi,t)\,d\xi \right\} dt \right| \f]
|
||||
-# Formula in different environment
|
||||
\f{eqnarray*}{ g &=& \frac{Gm_2}{r^2} \\
|
||||
&=& \frac{(6.673 \times 10^{-11}\,\mbox{m}^3\,\mbox{kg}^{-1}\,
|
||||
\mbox{s}^{-2})(5.9736 \times 10^{24}\,\mbox{kg})}{(6371.01\,\mbox{km})^2} \\
|
||||
&=& 9.82066032\,\mbox{m/s}^2
|
||||
\f}
|
||||
*/
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
<?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="029__hideinit_8c" kind="file" language="C++">
|
||||
<compoundname>029_hideinit.c</compoundname>
|
||||
<sectiondef kind="var">
|
||||
<memberdef kind="variable" id="029__hideinit_8c_1a799f44203647e4c53bdb0386aa95680f" prot="public" static="no" mutable="no">
|
||||
<type>int</type>
|
||||
<definition>int var1</definition>
|
||||
<argsstring/>
|
||||
<name>var1</name>
|
||||
<initializer>= 10</initializer>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>a variable with initializer visible </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="029_hideinit.c" line="7" column="1" bodyfile="029_hideinit.c" bodystart="7" bodyend="-1"/>
|
||||
</memberdef>
|
||||
<memberdef kind="variable" id="029__hideinit_8c_1ac0da06d47d79ad4b9fb1c0eaf1118c3f" prot="public" static="no" mutable="no">
|
||||
<type>int</type>
|
||||
<definition>int var2</definition>
|
||||
<argsstring/>
|
||||
<name>var2</name>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>a variable without initializer visible </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="029_hideinit.c" line="12" column="1" bodyfile="029_hideinit.c" bodystart="12" bodyend="-1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
<location file="029_hideinit.c"/>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
// objective: test the \hideinitializer command
|
||||
// check: 029__hideinit_8c.xml
|
||||
|
||||
/** \file */
|
||||
|
||||
/** a variable with initializer visible */
|
||||
int var1 = 10;
|
||||
|
||||
/** a variable without initializer visible
|
||||
* \hideinitializer
|
||||
*/
|
||||
int var2 = 20;
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Some text. <htmlonly block="yes"><h1>Hello world</h1>
|
||||
</htmlonly> More text. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
// objective: test the \htmlinclude command
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
* Some text.
|
||||
* \htmlinclude[block] sample.html
|
||||
* More text.
|
||||
*/
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Some text. <image type="html" name="sample.png"/>
|
||||
<image type="latex" name="sample.png" width="5cm">Doxygen logo</image>
|
||||
<image type="docbook" name="sample.png"/>
|
||||
More text. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
// objective: test the \image command
|
||||
// check: indexpage.xml
|
||||
// config: IMAGE_PATH = $INPUTDIR
|
||||
/** \mainpage
|
||||
* Some text.
|
||||
* \image html sample.png
|
||||
* \image latex sample.png "Doxygen logo" width=5cm
|
||||
* \image docbook sample.png
|
||||
* More text.
|
||||
*/
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Some text. <programlisting filename="example_test.cpp"><codeline><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline><highlight class="normal">{</highlight></codeline><codeline><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal">*<sp/>a<sp/>=<sp/></highlight><highlight class="stringliteral">"Some<sp/>special<sp/>character<sp/>here:<sp/><sp value="7"/><sp/>"</highlight><highlight class="normal">;</highlight></codeline><codeline><highlight class="normal"/></codeline><codeline><highlight class="normal"><sp/><sp/>Test<sp/>t;</highlight></codeline><codeline><highlight class="normal"><sp/><sp/>t.example();</highlight></codeline><codeline><highlight class="normal">}</highlight></codeline><codeline><highlight class="normal"/></codeline></programlisting> More text. <programlisting filename="example_test.cpp"><codeline lineno="1"><highlight class="keywordtype">void</highlight><highlight class="normal"><sp/>main()</highlight></codeline><codeline lineno="2"><highlight class="normal">{</highlight></codeline><codeline lineno="3"><highlight class="normal"><sp/><sp/></highlight><highlight class="keyword">const</highlight><highlight class="normal"><sp/></highlight><highlight class="keywordtype">char</highlight><highlight class="normal">*<sp/>a<sp/>=<sp/></highlight><highlight class="stringliteral">"Some<sp/>special<sp/>character<sp/>here:<sp/><sp value="7"/><sp/>"</highlight><highlight class="normal">;</highlight></codeline><codeline lineno="4"><highlight class="normal"/></codeline><codeline lineno="5"><highlight class="normal"><sp/><sp/>Test<sp/>t;</highlight></codeline><codeline lineno="6"><highlight class="normal"><sp/><sp/>t.example();</highlight></codeline><codeline lineno="7"><highlight class="normal">}</highlight></codeline><codeline lineno="8"><highlight class="normal"/></codeline></programlisting> End. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,10 +0,0 @@
|
|||
// objective: test the \include and \includelineno commands
|
||||
// check: indexpage.xml
|
||||
|
||||
/** \mainpage
|
||||
* Some text.
|
||||
* \include example_test.cpp
|
||||
* More text.
|
||||
* \includelineno example_test.cpp
|
||||
* End.
|
||||
*/
|
||||
|
|
@ -1,13 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Some text.</para>
|
||||
<para>More visible text. </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,12 +0,0 @@
|
|||
// objective: test the \internal and \endinternal commands (1)
|
||||
// check: indexpage.xml
|
||||
|
||||
/** \mainpage
|
||||
* Some text.
|
||||
* \internal
|
||||
* Internal text.
|
||||
* \endinternal
|
||||
* More visible text.
|
||||
* \internal
|
||||
* More internal text.
|
||||
*/
|
||||
|
|
@ -1,31 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Some text. </para>
|
||||
<internal>
|
||||
<para>Internal text. </para>
|
||||
</internal>
|
||||
<sect1 id="index_1s1">
|
||||
<title>A Section</title>
|
||||
<para>Some text in the section 1. </para>
|
||||
<internal>
|
||||
<para>Internal text. </para>
|
||||
<sect2 id="index_1ss1">
|
||||
<title>A Subsection</title>
|
||||
<para>Some text in the subsection. </para>
|
||||
</sect2>
|
||||
</internal>
|
||||
<para>Visible text in section 1. </para>
|
||||
</sect1>
|
||||
<sect1 id="index_1s2">
|
||||
<title>Another Section</title>
|
||||
<para>Visible text. </para>
|
||||
</sect1>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,21 +0,0 @@
|
|||
// objective: test the \internal and \endinternal commands (2)
|
||||
// check: indexpage.xml
|
||||
// config: INTERNAL_DOCS = YES
|
||||
|
||||
/** \mainpage
|
||||
* Some text.
|
||||
* \internal
|
||||
* Internal text.
|
||||
* \endinternal
|
||||
* \section s1 A Section
|
||||
* Some text in the section 1.
|
||||
* \internal
|
||||
* Internal text.
|
||||
* \subsection ss1 A Subsection
|
||||
* Some text in the subsection.
|
||||
* \endinternal
|
||||
* Visible text in section 1.
|
||||
* \section s2 Another Section
|
||||
* Visible text.
|
||||
*/
|
||||
|
||||
|
|
@ -1,45 +0,0 @@
|
|||
<?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="035__invariant_8c" kind="file" language="C++">
|
||||
<compoundname>035_invariant.c</compoundname>
|
||||
<sectiondef kind="func">
|
||||
<memberdef kind="function" id="035__invariant_8c_1a92e32ddd4278ab907422d5aaa34cb796" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func</definition>
|
||||
<argsstring>(int p, int *q)</argsstring>
|
||||
<name>func</name>
|
||||
<param>
|
||||
<type>int</type>
|
||||
<declname>p</declname>
|
||||
</param>
|
||||
<param>
|
||||
<type>int *</type>
|
||||
<declname>q</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>
|
||||
<simplesect kind="invariant">
|
||||
<para>i+j=p </para>
|
||||
</simplesect>
|
||||
<simplesect kind="pre">
|
||||
<para>p>=0 </para>
|
||||
</simplesect>
|
||||
<simplesect kind="post">
|
||||
<para>*q=2^(p+1) </para>
|
||||
</simplesect>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="035_invariant.c" line="10" column="1" bodyfile="035_invariant.c" bodystart="10" bodyend="15"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
</detaileddescription>
|
||||
<location file="035_invariant.c"/>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,15 +0,0 @@
|
|||
// objective: test \invariant, \pre and \post commands
|
||||
// check: 035__invariant_8c.xml
|
||||
|
||||
/** \file */
|
||||
|
||||
/** \invariant i+j=p
|
||||
* \pre p\>=0
|
||||
* \post *q=2^(p+1)
|
||||
*/
|
||||
void func(int p,int *q)
|
||||
{
|
||||
int j = p, k=1, i;
|
||||
for (i=0; i<=p; i++) j--,k=k*2;
|
||||
*q = k;
|
||||
}
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
<?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="036__link_8c" kind="file" language="C++">
|
||||
<compoundname>036_link.c</compoundname>
|
||||
<innerclass refid="class_test" prot="public">Test</innerclass>
|
||||
<sectiondef kind="func">
|
||||
<memberdef kind="function" id="036__link_8c_1affb6da6cff1b57cdf8efc0123dceac9b" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void func</definition>
|
||||
<argsstring>(int p)</argsstring>
|
||||
<name>func</name>
|
||||
<param>
|
||||
<type>int</type>
|
||||
<declname>p</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>A function </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="036_link.c" line="11" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>See <ref refid="036__link_8c_1affb6da6cff1b57cdf8efc0123dceac9b" kindref="member">the function</ref> for more info. See the <ref refid="class_test" kindref="compound">test</ref> class. </para>
|
||||
</detaileddescription>
|
||||
<location file="036_link.c"/>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,16 +0,0 @@
|
|||
// objective: test \link command
|
||||
// check: 036__link_8c.xml
|
||||
|
||||
/** \file
|
||||
* See \link func() the function\endlink for more info.
|
||||
* See the \link Test test\endlink class.
|
||||
*/
|
||||
|
||||
/** A function
|
||||
*/
|
||||
void func(int p);
|
||||
|
||||
/** A test */
|
||||
class Test
|
||||
{
|
||||
};
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
<?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="class_receiver" kind="class" language="C++" prot="public">
|
||||
<compoundname>Receiver</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_receiver_1a162099741e0324e6254c9bc570566e40" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void Receiver::Command</definition>
|
||||
<argsstring>(int commandId)</argsstring>
|
||||
<name>Command</name>
|
||||
<param>
|
||||
<type>int</type>
|
||||
<declname>commandId</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Executable a command on the server </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="037_msc.cpp" line="32" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para><ref refid="class_receiver" kindref="compound">Receiver</ref> class. Can be used to receive and execute commands. After execution of a command, the receiver will send an acknowledgement <msc>
|
||||
Receiver,Sender;
|
||||
Receiver<-Sender [label="Command()", URL="\ref Command()"];
|
||||
Receiver->Sender [label="Ack()", URL="\ref Sender::Ack()", ID="1"];
|
||||
</msc>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<location file="037_msc.cpp" line="29" column="1" bodyfile="037_msc.cpp" bodystart="28" bodyend="33"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_receiver_1a162099741e0324e6254c9bc570566e40" prot="public" virt="non-virtual">
|
||||
<scope>Receiver</scope>
|
||||
<name>Command</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,43 +0,0 @@
|
|||
<?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="class_sender" kind="class" language="C++" prot="public">
|
||||
<compoundname>Sender</compoundname>
|
||||
<sectiondef kind="public-func">
|
||||
<memberdef kind="function" id="class_sender_1a8ad2c6f9baa4e798868fe4a4d45f8fda" prot="public" static="no" const="no" explicit="no" inline="no" virt="non-virtual">
|
||||
<type>void</type>
|
||||
<definition>void Sender::Ack</definition>
|
||||
<argsstring>(bool ok)</argsstring>
|
||||
<name>Ack</name>
|
||||
<param>
|
||||
<type>bool</type>
|
||||
<declname>ok</declname>
|
||||
</param>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Acknowledgement from server </para>
|
||||
</detaileddescription>
|
||||
<inbodydescription>
|
||||
</inbodydescription>
|
||||
<location file="037_msc.cpp" line="17" column="1"/>
|
||||
</memberdef>
|
||||
</sectiondef>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para><ref refid="class_sender" kindref="compound">Sender</ref> class. Can be used to send a command to the server. The receiver will acknowledge the command by calling <ref refid="class_sender_1a8ad2c6f9baa4e798868fe4a4d45f8fda" kindref="member">Ack()</ref>. <msc>
|
||||
Sender,Receiver;
|
||||
Sender->Receiver [label="Command()", URL="\ref Receiver::Command()"];
|
||||
Sender<-Receiver [label="Ack()", URL="\ref Ack()", ID="1"];
|
||||
</msc>
|
||||
</para>
|
||||
</detaileddescription>
|
||||
<location file="037_msc.cpp" line="14" column="1" bodyfile="037_msc.cpp" bodystart="13" bodyend="18"/>
|
||||
<listofallmembers>
|
||||
<member refid="class_sender_1a8ad2c6f9baa4e798868fe4a4d45f8fda" prot="public" virt="non-virtual">
|
||||
<scope>Sender</scope>
|
||||
<name>Ack</name>
|
||||
</member>
|
||||
</listofallmembers>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,33 +0,0 @@
|
|||
// objective: test the \msc and \endmsc commands
|
||||
// check: class_sender.xml
|
||||
// check: class_receiver.xml
|
||||
|
||||
/** Sender class. Can be used to send a command to the server.
|
||||
* The receiver will acknowledge the command by calling Ack().
|
||||
* \msc
|
||||
* Sender,Receiver;
|
||||
* Sender->Receiver [label="Command()", URL="\ref Receiver::Command()"];
|
||||
* Sender<-Receiver [label="Ack()", URL="\ref Ack()", ID="1"];
|
||||
* \endmsc
|
||||
*/
|
||||
class Sender
|
||||
{
|
||||
public:
|
||||
/** Acknowledgement from server */
|
||||
void Ack(bool ok);
|
||||
};
|
||||
|
||||
/** Receiver class. Can be used to receive and execute commands.
|
||||
* After execution of a command, the receiver will send an acknowledgement
|
||||
* \msc
|
||||
* Receiver,Sender;
|
||||
* Receiver<-Sender [label="Command()", URL="\ref Command()"];
|
||||
* Receiver->Sender [label="Ack()", URL="\ref Sender::Ack()", ID="1"];
|
||||
* \endmsc
|
||||
*/
|
||||
class Receiver
|
||||
{
|
||||
public:
|
||||
/** Executable a command on the server */
|
||||
void Command(int commandId);
|
||||
};
|
||||
|
|
@ -1,14 +0,0 @@
|
|||
<?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="indexpage" kind="page">
|
||||
<compoundname>index</compoundname>
|
||||
<title>My Project</title>
|
||||
<briefdescription>
|
||||
</briefdescription>
|
||||
<detaileddescription>
|
||||
<para>Text<linebreak/>
|
||||
New line<linebreak/>
|
||||
Another line </para>
|
||||
</detaileddescription>
|
||||
</compounddef>
|
||||
</doxygen>
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
// objective: test the \n command
|
||||
// check: indexpage.xml
|
||||
/** \mainpage
|
||||
Text\n
|
||||
New line\n
|
||||
Another line
|
||||
*/
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue