diff --git a/test-files/golden-tests/config/auto-brief/auto-brief.adoc b/test-files/golden-tests/config/auto-brief/auto-brief.adoc deleted file mode 100644 index 3d328b203..000000000 --- a/test-files/golden-tests/config/auto-brief/auto-brief.adoc +++ /dev/null @@ -1,551 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#copyBriefFromCopyBrief[`copyBriefFromCopyBrief`] -| This is the explicit brief. -| link:#copyBriefFromExplicitBrief[`copyBriefFromExplicitBrief`] -| This is the explicit brief. -| link:#copyBriefFromFirstSentenceAsBrief[`copyBriefFromFirstSentenceAsBrief`] -| This is the brief. -| link:#copyBriefFromFirstValid[`copyBriefFromFirstValid`] -| This function has documentation but no brief. -| link:#copyDetailsFromCopyBrief[`copyDetailsFromCopyBrief`] -| Details will be copied -| link:#copyDetailsFromDocNoBrief[`copyDetailsFromDocNoBrief`] -| Custom brief -| link:#copyDetailsFromExplicitBrief[`copyDetailsFromExplicitBrief`] -| -| link:#copyDetailsFromFirstSentenceAsBrief[`copyDetailsFromFirstSentenceAsBrief`] -| -| link:#copyDetailsFromNoDoc[`copyDetailsFromNoDoc`] -| Custom brief -| link:#copyDocFromCopyBrief[`copyDocFromCopyBrief`] -| This is the explicit brief. -| link:#copyDocFromExplicitBrief[`copyDocFromExplicitBrief`] -| This is the explicit brief. -| link:#copyDocFromFirstSentenceAsBrief[`copyDocFromFirstSentenceAsBrief`] -| This is the brief. -| link:#docNoBriefFunction[`docNoBriefFunction`] -| This function has documentation but no brief. -| link:#explicitBriefFunction[`explicitBriefFunction`] -| This is the explicit brief. -| link:#explicitBriefFunction2[`explicitBriefFunction2`] -| This is the explicit brief. -| link:#failCircularReferenceCopyFunction[`failCircularReferenceCopyFunction`] -| -| link:#failCircularSourceFunctionA[`failCircularSourceFunctionA`] -| -| link:#failCircularSourceFunctionB[`failCircularSourceFunctionB`] -| -| link:#failCopyBriefFromDocNoBrief[`failCopyBriefFromDocNoBrief`] -| This function has documentation but no brief. -| link:#failCopyBriefFromInvalidReference[`failCopyBriefFromInvalidReference`] -| -| link:#failCopyBriefFromNoDoc[`failCopyBriefFromNoDoc`] -| -| link:#failCopyDetailsFromInvalidReference[`failCopyDetailsFromInvalidReference`] -| -| link:#failCopyDocFromDocNoBrief[`failCopyDocFromDocNoBrief`] -| This function has documentation but no brief. -| link:#failCopyDocFromInvalidReference[`failCopyDocFromInvalidReference`] -| -| link:#failCopyDocFromNoDoc[`failCopyDocFromNoDoc`] -| -| link:#failInvalidReferenceCopyFunctions[`failInvalidReferenceCopyFunctions`] -| -| link:#firstSentenceAsBriefFunction[`firstSentenceAsBriefFunction`] -| This is the brief. -| link:#noDocFunction[`noDocFunction`] -| -| link:#recursiveReferenceCopyFunction[`recursiveReferenceCopyFunction`] -| Final recursive brief -| link:#recursiveSourceFunctionA[`recursiveSourceFunctionA`] -| Final recursive brief -| link:#recursiveSourceFunctionB[`recursiveSourceFunctionB`] -| Final recursive brief -|=== - -[#copyBriefFromCopyBrief] -== copyBriefFromCopyBrief - -This is the explicit brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyBriefFromCopyBrief(); ----- - -[#copyBriefFromExplicitBrief] -== copyBriefFromExplicitBrief - -This is the explicit brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyBriefFromExplicitBrief(); ----- - -[#copyBriefFromFirstSentenceAsBrief] -== copyBriefFromFirstSentenceAsBrief - -This is the brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyBriefFromFirstSentenceAsBrief(); ----- - -[#copyBriefFromFirstValid] -== copyBriefFromFirstValid - -This function has documentation but no brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyBriefFromFirstValid(); ----- - -[#copyDetailsFromCopyBrief] -== copyDetailsFromCopyBrief - -Details will be copied - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromCopyBrief(); ----- - -[#copyDetailsFromDocNoBrief] -== copyDetailsFromDocNoBrief - -Custom brief - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromDocNoBrief(); ----- - -[#copyDetailsFromExplicitBrief] -== copyDetailsFromExplicitBrief - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromExplicitBrief(); ----- - -=== Description - -This description will never be copied as brief because it is an explicit brief. - -[#copyDetailsFromFirstSentenceAsBrief] -== copyDetailsFromFirstSentenceAsBrief - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromFirstSentenceAsBrief(); ----- - -=== Description - -This is more documentation. - -[#copyDetailsFromNoDoc] -== copyDetailsFromNoDoc - -Custom brief - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromNoDoc(); ----- - -[#copyDocFromCopyBrief] -== copyDocFromCopyBrief - -This is the explicit brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDocFromCopyBrief(); ----- - -=== Description - -This description will never be copied as brief because it is an explicit brief. - -[#copyDocFromExplicitBrief] -== copyDocFromExplicitBrief - -This is the explicit brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDocFromExplicitBrief(); ----- - -=== Description - -This description will never be copied as brief because it is an explicit brief. - -[#copyDocFromFirstSentenceAsBrief] -== copyDocFromFirstSentenceAsBrief - -This is the brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDocFromFirstSentenceAsBrief(); ----- - -=== Description - -This is more documentation. - -[#docNoBriefFunction] -== docNoBriefFunction - -This function has documentation but no brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -docNoBriefFunction(); ----- - -[#explicitBriefFunction] -== explicitBriefFunction - -This is the explicit brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -explicitBriefFunction(); ----- - -=== Description - -This description will never be copied as brief because it is an explicit brief. - -[#explicitBriefFunction2] -== explicitBriefFunction2 - -This is the explicit brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -explicitBriefFunction2(); ----- - -=== Description - -This will not be copied as brief. - -[#failCircularReferenceCopyFunction] -== failCircularReferenceCopyFunction - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCircularReferenceCopyFunction(); ----- - -[#failCircularSourceFunctionA] -== failCircularSourceFunctionA - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCircularSourceFunctionA(); ----- - -[#failCircularSourceFunctionB] -== failCircularSourceFunctionB - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCircularSourceFunctionB(); ----- - -[#failCopyBriefFromDocNoBrief] -== failCopyBriefFromDocNoBrief - -This function has documentation but no brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyBriefFromDocNoBrief(); ----- - -[#failCopyBriefFromInvalidReference] -== failCopyBriefFromInvalidReference - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyBriefFromInvalidReference(); ----- - -[#failCopyBriefFromNoDoc] -== failCopyBriefFromNoDoc - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyBriefFromNoDoc(); ----- - -[#failCopyDetailsFromInvalidReference] -== failCopyDetailsFromInvalidReference - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyDetailsFromInvalidReference(); ----- - -[#failCopyDocFromDocNoBrief] -== failCopyDocFromDocNoBrief - -This function has documentation but no brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyDocFromDocNoBrief(); ----- - -[#failCopyDocFromInvalidReference] -== failCopyDocFromInvalidReference - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyDocFromInvalidReference(); ----- - -[#failCopyDocFromNoDoc] -== failCopyDocFromNoDoc - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyDocFromNoDoc(); ----- - -[#failInvalidReferenceCopyFunctions] -== failInvalidReferenceCopyFunctions - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failInvalidReferenceCopyFunctions(); ----- - -[#firstSentenceAsBriefFunction] -== firstSentenceAsBriefFunction - -This is the brief. - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -firstSentenceAsBriefFunction(); ----- - -=== Description - -This is more documentation. - -[#noDocFunction] -== noDocFunction - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -noDocFunction(); ----- - -[#recursiveReferenceCopyFunction] -== recursiveReferenceCopyFunction - -Final recursive brief - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -recursiveReferenceCopyFunction(); ----- - -[#recursiveSourceFunctionA] -== recursiveSourceFunctionA - -Final recursive brief - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -recursiveSourceFunctionA(); ----- - -[#recursiveSourceFunctionB] -== recursiveSourceFunctionB - -Final recursive brief - -=== Synopsis - -Declared in `<auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -recursiveSourceFunctionB(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-brief/auto-brief.cpp b/test-files/golden-tests/config/auto-brief/auto-brief.cpp deleted file mode 100644 index e7f1d068f..000000000 --- a/test-files/golden-tests/config/auto-brief/auto-brief.cpp +++ /dev/null @@ -1,175 +0,0 @@ -// No documentation -void noDocFunction(); - -// Documentation with no brief -/** - * This function has documentation but no brief. - */ -void docNoBriefFunction(); - -// Explicit brief -/** - * @brief This is the explicit brief. - * - * This description will never be copied as - * brief because it is an explicit brief. - */ -void explicitBriefFunction(); - -/** - * This will not be copied as brief. - * - * @brief This is the explicit brief. - */ -void explicitBriefFunction2(); - -// First sentence as brief and more documentation -/** - * This is the brief. - * - * This is more documentation. - */ -void firstSentenceAsBriefFunction(); - -// Copy brief -/** - * \copybrief noDocFunction - */ -void failCopyBriefFromNoDoc(); - -/** - * \copybrief docNoBriefFunction - */ -void failCopyBriefFromDocNoBrief(); - -/** - * \copybrief explicitBriefFunction - */ -void copyBriefFromExplicitBrief(); - -/** - * \copybrief noDocFunction - * \copybrief docNoBriefFunction - * \copybrief explicitBriefFunction - */ -void copyBriefFromFirstValid(); - -/** - * \copybrief firstSentenceAsBriefFunction - */ -void copyBriefFromFirstSentenceAsBrief(); - -/** - * \copybrief invalidReference - */ -void failCopyBriefFromInvalidReference(); - -/** - * \copybrief copyBriefFromExplicitBrief - */ -void copyBriefFromCopyBrief(); - -// Copy details -/** - * \brief Custom brief - * \copydetails noDocFunction - */ -void copyDetailsFromNoDoc(); - -/** - * \brief Custom brief - * \copydetails docNoBriefFunction - */ -void copyDetailsFromDocNoBrief(); - -/** - * \copydetails explicitBriefFunction - */ -void copyDetailsFromExplicitBrief(); - -/** - * \copydetails firstSentenceAsBriefFunction - */ -void copyDetailsFromFirstSentenceAsBrief(); - -/** - * \copydetails invalidReference - */ -void failCopyDetailsFromInvalidReference(); - -/** - * \brief Details will be copied - * \copydetails copyDetailsFromExplicitBrief - */ -void copyDetailsFromCopyBrief(); - -// Copy docs -/** - * \copydoc noDocFunction - */ -void failCopyDocFromNoDoc(); - -/** - * \copydoc docNoBriefFunction - */ -void failCopyDocFromDocNoBrief(); - -/** - * \copydoc explicitBriefFunction - */ -void copyDocFromExplicitBrief(); - -/** - * \copydoc firstSentenceAsBriefFunction - */ -void copyDocFromFirstSentenceAsBrief(); - -/** - * \copydoc invalidReference - */ -void failCopyDocFromInvalidReference(); - -/** - * \copydoc copyDocFromExplicitBrief - */ -void copyDocFromCopyBrief(); - -// Invalid reference for copy brief/details/docs -/** - * \copybrief invalidReference - * \copydetails invalidReference - * \copydoc invalidReference - */ -void failInvalidReferenceCopyFunctions(); - -// Recursive reference for copy brief/details/docs - -/** - * @brief Final recursive brief - */ -void recursiveSourceFunctionA(); - -/** - * \copybrief recursiveSourceFunctionA - */ -void recursiveSourceFunctionB(); - -/** - * \copybrief recursiveSourceFunctionB - */ -void recursiveReferenceCopyFunction(); - -/** - * \copybrief failCircularReferenceCopyFunction - */ -void failCircularSourceFunctionA(); - -/** - * \copybrief failCircularSourceFunctionA - */ -void failCircularSourceFunctionB(); - -/** - * \copybrief failCircularSourceFunctionB - */ -void failCircularReferenceCopyFunction(); diff --git a/test-files/golden-tests/config/auto-brief/auto-brief.html b/test-files/golden-tests/config/auto-brief/auto-brief.html deleted file mode 100644 index 4eeac05f7..000000000 --- a/test-files/golden-tests/config/auto-brief/auto-brief.html +++ /dev/null @@ -1,667 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
copyBriefFromCopyBrief This is the explicit brief.
copyBriefFromExplicitBrief This is the explicit brief.
copyBriefFromFirstSentenceAsBrief This is the brief.
copyBriefFromFirstValid This function has documentation but no brief.
copyDetailsFromCopyBrief Details will be copied
copyDetailsFromDocNoBrief Custom brief
copyDetailsFromExplicitBrief
copyDetailsFromFirstSentenceAsBrief
copyDetailsFromNoDoc Custom brief
copyDocFromCopyBrief This is the explicit brief.
copyDocFromExplicitBrief This is the explicit brief.
copyDocFromFirstSentenceAsBrief This is the brief.
docNoBriefFunction This function has documentation but no brief.
explicitBriefFunction This is the explicit brief.
explicitBriefFunction2 This is the explicit brief.
failCircularReferenceCopyFunction
failCircularSourceFunctionA
failCircularSourceFunctionB
failCopyBriefFromDocNoBrief This function has documentation but no brief.
failCopyBriefFromInvalidReference
failCopyBriefFromNoDoc
failCopyDetailsFromInvalidReference
failCopyDocFromDocNoBrief This function has documentation but no brief.
failCopyDocFromInvalidReference
failCopyDocFromNoDoc
failInvalidReferenceCopyFunctions
firstSentenceAsBriefFunction This is the brief.
noDocFunction
recursiveReferenceCopyFunction Final recursive brief
recursiveSourceFunctionA Final recursive brief
recursiveSourceFunctionB Final recursive brief
- -
-
-
-

copyBriefFromCopyBrief

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyBriefFromCopyBrief();
-
-
-
-
-
-
-
-

copyBriefFromExplicitBrief

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyBriefFromExplicitBrief();
-
-
-
-
-
-
-
-

copyBriefFromFirstSentenceAsBrief

-
-This is the brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyBriefFromFirstSentenceAsBrief();
-
-
-
-
-
-
-
-

copyBriefFromFirstValid

-
-This function has documentation but no brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyBriefFromFirstValid();
-
-
-
-
-
-
-
-

copyDetailsFromCopyBrief

-
-Details will be copied - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyDetailsFromCopyBrief();
-
-
-
-
-
-
-
-

copyDetailsFromDocNoBrief

-
-Custom brief - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyDetailsFromDocNoBrief();
-
-
-
-
-
-
-
-

copyDetailsFromExplicitBrief

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyDetailsFromExplicitBrief();
-
-
-
-
-
-

Description

-

This description will never be copied as brief because it is an explicit brief.

-
-
-
-
-

copyDetailsFromFirstSentenceAsBrief

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyDetailsFromFirstSentenceAsBrief();
-
-
-
-
-
-

Description

-

This is more documentation.

-
-
-
-
-

copyDetailsFromNoDoc

-
-Custom brief - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyDetailsFromNoDoc();
-
-
-
-
-
-
-
-

copyDocFromCopyBrief

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyDocFromCopyBrief();
-
-
-
-
-
-

Description

-

This description will never be copied as brief because it is an explicit brief.

-
-
-
-
-

copyDocFromExplicitBrief

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyDocFromExplicitBrief();
-
-
-
-
-
-

Description

-

This description will never be copied as brief because it is an explicit brief.

-
-
-
-
-

copyDocFromFirstSentenceAsBrief

-
-This is the brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-copyDocFromFirstSentenceAsBrief();
-
-
-
-
-
-

Description

-

This is more documentation.

-
-
-
-
-

docNoBriefFunction

-
-This function has documentation but no brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-docNoBriefFunction();
-
-
-
-
-
-
-
-

explicitBriefFunction

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-explicitBriefFunction();
-
-
-
-
-
-

Description

-

This description will never be copied as brief because it is an explicit brief.

-
-
-
-
-

explicitBriefFunction2

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-explicitBriefFunction2();
-
-
-
-
-
-

Description

-

This will not be copied as brief.

-
-
-
-
-

failCircularReferenceCopyFunction

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCircularReferenceCopyFunction();
-
-
-
-
-
-
-
-

failCircularSourceFunctionA

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCircularSourceFunctionA();
-
-
-
-
-
-
-
-

failCircularSourceFunctionB

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCircularSourceFunctionB();
-
-
-
-
-
-
-
-

failCopyBriefFromDocNoBrief

-
-This function has documentation but no brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCopyBriefFromDocNoBrief();
-
-
-
-
-
-
-
-

failCopyBriefFromInvalidReference

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCopyBriefFromInvalidReference();
-
-
-
-
-
-
-
-

failCopyBriefFromNoDoc

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCopyBriefFromNoDoc();
-
-
-
-
-
-
-
-

failCopyDetailsFromInvalidReference

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCopyDetailsFromInvalidReference();
-
-
-
-
-
-
-
-

failCopyDocFromDocNoBrief

-
-This function has documentation but no brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCopyDocFromDocNoBrief();
-
-
-
-
-
-
-
-

failCopyDocFromInvalidReference

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCopyDocFromInvalidReference();
-
-
-
-
-
-
-
-

failCopyDocFromNoDoc

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failCopyDocFromNoDoc();
-
-
-
-
-
-
-
-

failInvalidReferenceCopyFunctions

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-failInvalidReferenceCopyFunctions();
-
-
-
-
-
-
-
-

firstSentenceAsBriefFunction

-
-This is the brief. - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-firstSentenceAsBriefFunction();
-
-
-
-
-
-

Description

-

This is more documentation.

-
-
-
-
-

noDocFunction

-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-noDocFunction();
-
-
-
-
-
-
-
-

recursiveReferenceCopyFunction

-
-Final recursive brief - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-recursiveReferenceCopyFunction();
-
-
-
-
-
-
-
-

recursiveSourceFunctionA

-
-Final recursive brief - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-recursiveSourceFunctionA();
-
-
-
-
-
-
-
-

recursiveSourceFunctionB

-
-Final recursive brief - -
-
-
-

Synopsis

-
-Declared in <auto-brief.cpp>
-
-void
-recursiveSourceFunctionB();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-brief/auto-brief.xml b/test-files/golden-tests/config/auto-brief/auto-brief.xml deleted file mode 100644 index a53007dee..000000000 --- a/test-files/golden-tests/config/auto-brief/auto-brief.xml +++ /dev/null @@ -1,256 +0,0 @@ - - - - - - - - This is the explicit brief. - - - - - - - - This is the explicit brief. - - - - - - - - This is the brief. - - - - - - - - This function has documentation but no brief. - - - - - - - - Details will be copied - - - - - - - - Custom brief - - - - - - - - This description will never be copied as brief because it is an explicit brief. - - - - - - - - This is more documentation. - - - - - - - - Custom brief - - - - - - - - This is the explicit brief. - - - This description will never be copied as brief because it is an explicit brief. - - - - - - - - This is the explicit brief. - - - This description will never be copied as brief because it is an explicit brief. - - - - - - - - This is the brief. - - - This is more documentation. - - - - - - - - This function has documentation but no brief. - - - - - - - - This is the explicit brief. - - - This description will never be copied as brief because it is an explicit brief. - - - - - - - - This is the explicit brief. - - - This will not be copied as brief. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This function has documentation but no brief. - - - - - - - - - - - - - - - - - - - - - - - - - - - This function has documentation but no brief. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This is the brief. - - - This is more documentation. - - - - - - - - - - - Final recursive brief - - - - - - - - Final recursive brief - - - - - - - - Final recursive brief - - - - - diff --git a/test-files/golden-tests/config/auto-brief/auto-brief.yml b/test-files/golden-tests/config/auto-brief/auto-brief.yml deleted file mode 100644 index 9ffbd33c7..000000000 --- a/test-files/golden-tests/config/auto-brief/auto-brief.yml +++ /dev/null @@ -1,2 +0,0 @@ -auto-brief: true -warn-broken-ref: false \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-brief/no-auto-brief.adoc b/test-files/golden-tests/config/auto-brief/no-auto-brief.adoc deleted file mode 100644 index c4edc9ae5..000000000 --- a/test-files/golden-tests/config/auto-brief/no-auto-brief.adoc +++ /dev/null @@ -1,553 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#copyBriefFromCopyBrief[`copyBriefFromCopyBrief`] -| This is the explicit brief. -| link:#copyBriefFromExplicitBrief[`copyBriefFromExplicitBrief`] -| This is the explicit brief. -| link:#copyBriefFromFirstSentenceAsBrief[`copyBriefFromFirstSentenceAsBrief`] -| -| link:#copyBriefFromFirstValid[`copyBriefFromFirstValid`] -| This is the explicit brief. -| link:#copyDetailsFromCopyBrief[`copyDetailsFromCopyBrief`] -| Details will be copied -| link:#copyDetailsFromDocNoBrief[`copyDetailsFromDocNoBrief`] -| Custom brief -| link:#copyDetailsFromExplicitBrief[`copyDetailsFromExplicitBrief`] -| -| link:#copyDetailsFromFirstSentenceAsBrief[`copyDetailsFromFirstSentenceAsBrief`] -| -| link:#copyDetailsFromNoDoc[`copyDetailsFromNoDoc`] -| Custom brief -| link:#copyDocFromCopyBrief[`copyDocFromCopyBrief`] -| This is the explicit brief. -| link:#copyDocFromExplicitBrief[`copyDocFromExplicitBrief`] -| This is the explicit brief. -| link:#copyDocFromFirstSentenceAsBrief[`copyDocFromFirstSentenceAsBrief`] -| -| link:#docNoBriefFunction[`docNoBriefFunction`] -| -| link:#explicitBriefFunction[`explicitBriefFunction`] -| This is the explicit brief. -| link:#explicitBriefFunction2[`explicitBriefFunction2`] -| This is the explicit brief. -| link:#failCircularReferenceCopyFunction[`failCircularReferenceCopyFunction`] -| -| link:#failCircularSourceFunctionA[`failCircularSourceFunctionA`] -| -| link:#failCircularSourceFunctionB[`failCircularSourceFunctionB`] -| -| link:#failCopyBriefFromDocNoBrief[`failCopyBriefFromDocNoBrief`] -| -| link:#failCopyBriefFromInvalidReference[`failCopyBriefFromInvalidReference`] -| -| link:#failCopyBriefFromNoDoc[`failCopyBriefFromNoDoc`] -| -| link:#failCopyDetailsFromInvalidReference[`failCopyDetailsFromInvalidReference`] -| -| link:#failCopyDocFromDocNoBrief[`failCopyDocFromDocNoBrief`] -| -| link:#failCopyDocFromInvalidReference[`failCopyDocFromInvalidReference`] -| -| link:#failCopyDocFromNoDoc[`failCopyDocFromNoDoc`] -| -| link:#failInvalidReferenceCopyFunctions[`failInvalidReferenceCopyFunctions`] -| -| link:#firstSentenceAsBriefFunction[`firstSentenceAsBriefFunction`] -| -| link:#noDocFunction[`noDocFunction`] -| -| link:#recursiveReferenceCopyFunction[`recursiveReferenceCopyFunction`] -| Final recursive brief -| link:#recursiveSourceFunctionA[`recursiveSourceFunctionA`] -| Final recursive brief -| link:#recursiveSourceFunctionB[`recursiveSourceFunctionB`] -| Final recursive brief -|=== - -[#copyBriefFromCopyBrief] -== copyBriefFromCopyBrief - -This is the explicit brief. - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyBriefFromCopyBrief(); ----- - -[#copyBriefFromExplicitBrief] -== copyBriefFromExplicitBrief - -This is the explicit brief. - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyBriefFromExplicitBrief(); ----- - -[#copyBriefFromFirstSentenceAsBrief] -== copyBriefFromFirstSentenceAsBrief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyBriefFromFirstSentenceAsBrief(); ----- - -[#copyBriefFromFirstValid] -== copyBriefFromFirstValid - -This is the explicit brief. - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyBriefFromFirstValid(); ----- - -[#copyDetailsFromCopyBrief] -== copyDetailsFromCopyBrief - -Details will be copied - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromCopyBrief(); ----- - -[#copyDetailsFromDocNoBrief] -== copyDetailsFromDocNoBrief - -Custom brief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromDocNoBrief(); ----- - -[#copyDetailsFromExplicitBrief] -== copyDetailsFromExplicitBrief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromExplicitBrief(); ----- - -=== Description - -This will not be copied. - -[#copyDetailsFromFirstSentenceAsBrief] -== copyDetailsFromFirstSentenceAsBrief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromFirstSentenceAsBrief(); ----- - -=== Description - -This is the brief. - -This is more documentation. - -[#copyDetailsFromNoDoc] -== copyDetailsFromNoDoc - -Custom brief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDetailsFromNoDoc(); ----- - -[#copyDocFromCopyBrief] -== copyDocFromCopyBrief - -This is the explicit brief. - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDocFromCopyBrief(); ----- - -=== Description - -This will not be copied. - -[#copyDocFromExplicitBrief] -== copyDocFromExplicitBrief - -This is the explicit brief. - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDocFromExplicitBrief(); ----- - -=== Description - -This will not be copied. - -[#copyDocFromFirstSentenceAsBrief] -== copyDocFromFirstSentenceAsBrief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -copyDocFromFirstSentenceAsBrief(); ----- - -=== Description - -This is the brief. - -This is more documentation. - -[#docNoBriefFunction] -== docNoBriefFunction - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -docNoBriefFunction(); ----- - -=== Description - -This function has documentation but no brief. - -[#explicitBriefFunction] -== explicitBriefFunction - -This is the explicit brief. - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -explicitBriefFunction(); ----- - -=== Description - -This will not be copied. - -[#explicitBriefFunction2] -== explicitBriefFunction2 - -This is the explicit brief. - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -explicitBriefFunction2(); ----- - -=== Description - -This will not be copied. - -[#failCircularReferenceCopyFunction] -== failCircularReferenceCopyFunction - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCircularReferenceCopyFunction(); ----- - -[#failCircularSourceFunctionA] -== failCircularSourceFunctionA - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCircularSourceFunctionA(); ----- - -[#failCircularSourceFunctionB] -== failCircularSourceFunctionB - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCircularSourceFunctionB(); ----- - -[#failCopyBriefFromDocNoBrief] -== failCopyBriefFromDocNoBrief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyBriefFromDocNoBrief(); ----- - -[#failCopyBriefFromInvalidReference] -== failCopyBriefFromInvalidReference - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyBriefFromInvalidReference(); ----- - -[#failCopyBriefFromNoDoc] -== failCopyBriefFromNoDoc - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyBriefFromNoDoc(); ----- - -[#failCopyDetailsFromInvalidReference] -== failCopyDetailsFromInvalidReference - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyDetailsFromInvalidReference(); ----- - -[#failCopyDocFromDocNoBrief] -== failCopyDocFromDocNoBrief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyDocFromDocNoBrief(); ----- - -=== Description - -This function has documentation but no brief. - -[#failCopyDocFromInvalidReference] -== failCopyDocFromInvalidReference - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyDocFromInvalidReference(); ----- - -[#failCopyDocFromNoDoc] -== failCopyDocFromNoDoc - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failCopyDocFromNoDoc(); ----- - -[#failInvalidReferenceCopyFunctions] -== failInvalidReferenceCopyFunctions - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -failInvalidReferenceCopyFunctions(); ----- - -[#firstSentenceAsBriefFunction] -== firstSentenceAsBriefFunction - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -firstSentenceAsBriefFunction(); ----- - -=== Description - -This is the brief. - -This is more documentation. - -[#noDocFunction] -== noDocFunction - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -noDocFunction(); ----- - -[#recursiveReferenceCopyFunction] -== recursiveReferenceCopyFunction - -Final recursive brief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -recursiveReferenceCopyFunction(); ----- - -[#recursiveSourceFunctionA] -== recursiveSourceFunctionA - -Final recursive brief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -recursiveSourceFunctionA(); ----- - -[#recursiveSourceFunctionB] -== recursiveSourceFunctionB - -Final recursive brief - -=== Synopsis - -Declared in `<no‐auto‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -recursiveSourceFunctionB(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-brief/no-auto-brief.cpp b/test-files/golden-tests/config/auto-brief/no-auto-brief.cpp deleted file mode 100644 index db7fd28bb..000000000 --- a/test-files/golden-tests/config/auto-brief/no-auto-brief.cpp +++ /dev/null @@ -1,174 +0,0 @@ -// No documentation -void noDocFunction(); - -// Documentation with no brief -/** - * This function has documentation but no brief. - */ -void docNoBriefFunction(); - -// Explicit brief -/** - * @brief This is the explicit brief. - * - * This will not be copied. - */ -void explicitBriefFunction(); - -/** - * This will not be copied. - * - * @brief This is the explicit brief. - */ -void explicitBriefFunction2(); - -// First sentence as brief and more documentation -/** - * This is the brief. - * - * This is more documentation. - */ -void firstSentenceAsBriefFunction(); - -// Copy brief -/** - * \copybrief noDocFunction - */ -void failCopyBriefFromNoDoc(); - -/** - * \copybrief docNoBriefFunction - */ -void failCopyBriefFromDocNoBrief(); - -/** - * \copybrief explicitBriefFunction - */ -void copyBriefFromExplicitBrief(); - -/** - * \copybrief noDocFunction - * \copybrief docNoBriefFunction - * \copybrief explicitBriefFunction - */ -void copyBriefFromFirstValid(); - -/** - * \copybrief firstSentenceAsBriefFunction - */ -void copyBriefFromFirstSentenceAsBrief(); - -/** - * \copybrief invalidReference - */ -void failCopyBriefFromInvalidReference(); - -/** - * \copybrief copyBriefFromExplicitBrief - */ -void copyBriefFromCopyBrief(); - -// Copy details -/** - * \brief Custom brief - * \copydetails noDocFunction - */ -void copyDetailsFromNoDoc(); - -/** - * \brief Custom brief - * \copydetails docNoBriefFunction - */ -void copyDetailsFromDocNoBrief(); - -/** - * \copydetails explicitBriefFunction - */ -void copyDetailsFromExplicitBrief(); - -/** - * \copydetails firstSentenceAsBriefFunction - */ -void copyDetailsFromFirstSentenceAsBrief(); - -/** - * \copydetails invalidReference - */ -void failCopyDetailsFromInvalidReference(); - -/** - * \brief Details will be copied - * \copydetails copyDetailsFromExplicitBrief - */ -void copyDetailsFromCopyBrief(); - -// Copy docs -/** - * \copydoc noDocFunction - */ -void failCopyDocFromNoDoc(); - -/** - * \copydoc docNoBriefFunction - */ -void failCopyDocFromDocNoBrief(); - -/** - * \copydoc explicitBriefFunction - */ -void copyDocFromExplicitBrief(); - -/** - * \copydoc firstSentenceAsBriefFunction - */ -void copyDocFromFirstSentenceAsBrief(); - -/** - * \copydoc invalidReference - */ -void failCopyDocFromInvalidReference(); - -/** - * \copydoc copyDocFromExplicitBrief - */ -void copyDocFromCopyBrief(); - -// Invalid reference for copy brief/details/docs -/** - * \copybrief invalidReference - * \copydetails invalidReference - * \copydoc invalidReference - */ -void failInvalidReferenceCopyFunctions(); - -// Recursive reference for copy brief/details/docs - -/** - * @brief Final recursive brief - */ -void recursiveSourceFunctionA(); - -/** - * \copybrief recursiveSourceFunctionA - */ -void recursiveSourceFunctionB(); - -/** - * \copybrief recursiveSourceFunctionB - */ -void recursiveReferenceCopyFunction(); - -/** - * \copybrief failCircularReferenceCopyFunction - */ -void failCircularSourceFunctionA(); - -/** - * \copybrief failCircularSourceFunctionA - */ -void failCircularSourceFunctionB(); - -/** - * \copybrief failCircularSourceFunctionB - */ -void failCircularReferenceCopyFunction(); diff --git a/test-files/golden-tests/config/auto-brief/no-auto-brief.html b/test-files/golden-tests/config/auto-brief/no-auto-brief.html deleted file mode 100644 index bfeb14222..000000000 --- a/test-files/golden-tests/config/auto-brief/no-auto-brief.html +++ /dev/null @@ -1,654 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
copyBriefFromCopyBrief This is the explicit brief.
copyBriefFromExplicitBrief This is the explicit brief.
copyBriefFromFirstSentenceAsBrief
copyBriefFromFirstValid This is the explicit brief.
copyDetailsFromCopyBrief Details will be copied
copyDetailsFromDocNoBrief Custom brief
copyDetailsFromExplicitBrief
copyDetailsFromFirstSentenceAsBrief
copyDetailsFromNoDoc Custom brief
copyDocFromCopyBrief This is the explicit brief.
copyDocFromExplicitBrief This is the explicit brief.
copyDocFromFirstSentenceAsBrief
docNoBriefFunction
explicitBriefFunction This is the explicit brief.
explicitBriefFunction2 This is the explicit brief.
failCircularReferenceCopyFunction
failCircularSourceFunctionA
failCircularSourceFunctionB
failCopyBriefFromDocNoBrief
failCopyBriefFromInvalidReference
failCopyBriefFromNoDoc
failCopyDetailsFromInvalidReference
failCopyDocFromDocNoBrief
failCopyDocFromInvalidReference
failCopyDocFromNoDoc
failInvalidReferenceCopyFunctions
firstSentenceAsBriefFunction
noDocFunction
recursiveReferenceCopyFunction Final recursive brief
recursiveSourceFunctionA Final recursive brief
recursiveSourceFunctionB Final recursive brief
- -
-
-
-

copyBriefFromCopyBrief

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyBriefFromCopyBrief();
-
-
-
-
-
-
-
-

copyBriefFromExplicitBrief

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyBriefFromExplicitBrief();
-
-
-
-
-
-
-
-

copyBriefFromFirstSentenceAsBrief

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyBriefFromFirstSentenceAsBrief();
-
-
-
-
-
-
-
-

copyBriefFromFirstValid

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyBriefFromFirstValid();
-
-
-
-
-
-
-
-

copyDetailsFromCopyBrief

-
-Details will be copied - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyDetailsFromCopyBrief();
-
-
-
-
-
-
-
-

copyDetailsFromDocNoBrief

-
-Custom brief - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyDetailsFromDocNoBrief();
-
-
-
-
-
-
-
-

copyDetailsFromExplicitBrief

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyDetailsFromExplicitBrief();
-
-
-
-
-
-

Description

-

This will not be copied.

-
-
-
-
-

copyDetailsFromFirstSentenceAsBrief

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyDetailsFromFirstSentenceAsBrief();
-
-
-
-
-
-

Description

-

This is the brief.

-

This is more documentation.

-
-
-
-
-

copyDetailsFromNoDoc

-
-Custom brief - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyDetailsFromNoDoc();
-
-
-
-
-
-
-
-

copyDocFromCopyBrief

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyDocFromCopyBrief();
-
-
-
-
-
-

Description

-

This will not be copied.

-
-
-
-
-

copyDocFromExplicitBrief

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyDocFromExplicitBrief();
-
-
-
-
-
-

Description

-

This will not be copied.

-
-
-
-
-

copyDocFromFirstSentenceAsBrief

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-copyDocFromFirstSentenceAsBrief();
-
-
-
-
-
-

Description

-

This is the brief.

-

This is more documentation.

-
-
-
-
-

docNoBriefFunction

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-docNoBriefFunction();
-
-
-
-
-
-

Description

-

This function has documentation but no brief.

-
-
-
-
-

explicitBriefFunction

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-explicitBriefFunction();
-
-
-
-
-
-

Description

-

This will not be copied.

-
-
-
-
-

explicitBriefFunction2

-
-This is the explicit brief. - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-explicitBriefFunction2();
-
-
-
-
-
-

Description

-

This will not be copied.

-
-
-
-
-

failCircularReferenceCopyFunction

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCircularReferenceCopyFunction();
-
-
-
-
-
-
-
-

failCircularSourceFunctionA

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCircularSourceFunctionA();
-
-
-
-
-
-
-
-

failCircularSourceFunctionB

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCircularSourceFunctionB();
-
-
-
-
-
-
-
-

failCopyBriefFromDocNoBrief

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCopyBriefFromDocNoBrief();
-
-
-
-
-
-
-
-

failCopyBriefFromInvalidReference

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCopyBriefFromInvalidReference();
-
-
-
-
-
-
-
-

failCopyBriefFromNoDoc

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCopyBriefFromNoDoc();
-
-
-
-
-
-
-
-

failCopyDetailsFromInvalidReference

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCopyDetailsFromInvalidReference();
-
-
-
-
-
-
-
-

failCopyDocFromDocNoBrief

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCopyDocFromDocNoBrief();
-
-
-
-
-
-

Description

-

This function has documentation but no brief.

-
-
-
-
-

failCopyDocFromInvalidReference

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCopyDocFromInvalidReference();
-
-
-
-
-
-
-
-

failCopyDocFromNoDoc

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failCopyDocFromNoDoc();
-
-
-
-
-
-
-
-

failInvalidReferenceCopyFunctions

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-failInvalidReferenceCopyFunctions();
-
-
-
-
-
-
-
-

firstSentenceAsBriefFunction

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-firstSentenceAsBriefFunction();
-
-
-
-
-
-

Description

-

This is the brief.

-

This is more documentation.

-
-
-
-
-

noDocFunction

-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-noDocFunction();
-
-
-
-
-
-
-
-

recursiveReferenceCopyFunction

-
-Final recursive brief - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-recursiveReferenceCopyFunction();
-
-
-
-
-
-
-
-

recursiveSourceFunctionA

-
-Final recursive brief - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-recursiveSourceFunctionA();
-
-
-
-
-
-
-
-

recursiveSourceFunctionB

-
-Final recursive brief - -
-
-
-

Synopsis

-
-Declared in <no-auto-brief.cpp>
-
-void
-recursiveSourceFunctionB();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-brief/no-auto-brief.xml b/test-files/golden-tests/config/auto-brief/no-auto-brief.xml deleted file mode 100644 index 14eaf504a..000000000 --- a/test-files/golden-tests/config/auto-brief/no-auto-brief.xml +++ /dev/null @@ -1,261 +0,0 @@ - - - - - - - - This is the explicit brief. - - - - - - - - This is the explicit brief. - - - - - - - - - - - - - - - This is the explicit brief. - - - - - - - - Details will be copied - - - - - - - - Custom brief - - - - - - - - This will not be copied. - - - - - - - - This is the brief. - - - This is more documentation. - - - - - - - - Custom brief - - - - - - - - This is the explicit brief. - - - This will not be copied. - - - - - - - - This is the explicit brief. - - - This will not be copied. - - - - - - - - - - This is the brief. - - - This is more documentation. - - - - - - - - This function has documentation but no brief. - - - - - - - - This is the explicit brief. - - - This will not be copied. - - - - - - - - This is the explicit brief. - - - This will not be copied. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This function has documentation but no brief. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - This is the brief. - - - This is more documentation. - - - - - - - - - - - Final recursive brief - - - - - - - - Final recursive brief - - - - - - - - Final recursive brief - - - - - diff --git a/test-files/golden-tests/config/auto-brief/no-auto-brief.yml b/test-files/golden-tests/config/auto-brief/no-auto-brief.yml deleted file mode 100644 index daec9b492..000000000 --- a/test-files/golden-tests/config/auto-brief/no-auto-brief.yml +++ /dev/null @@ -1,2 +0,0 @@ -auto-brief: false -warn-broken-ref: false \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.adoc b/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.adoc deleted file mode 100644 index 37c4a3747..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.adoc +++ /dev/null @@ -1,323 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A helper tag -| link:#X[`X`] -| Test class -|=== - -[#A] -== A - -A helper tag - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#X] -== X - -Test class - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct X; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#X-2constructor-08[`X`] [.small]#[constructor]# -| Constructors -| link:#X-2destructor[`~X`] [.small]#[destructor]# -| Destructor -| link:#X-2conversion-00[`operator A`] -| Conversion to `A` -| link:#X-2conversion-0b[`operator int`] -| Conversion to `int` -|=== - -[#X-2constructor-08] -== link:#X[X]::X - -Constructors - -=== Synopses - -Declared in `<brief‐from‐function‐class.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -constexpr -link:#X-2constructor-0e8[X]() = default; ----- - -[.small]#link:#X-2constructor-0e8[_» more..._]# - -Copy constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -constexpr -link:#X-2constructor-0e0[X](link:#X[X] const& other) = default; ----- - -[.small]#link:#X-2constructor-0e0[_» more..._]# - -Move constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -constexpr -link:#X-2constructor-06[X](link:#X[X]&& other) = default; ----- - -[.small]#link:#X-2constructor-06[_» more..._]# - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-07[X](int value); ----- - -[.small]#link:#X-2constructor-07[_» more..._]# - -Construct from `A` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-0b[X](link:#A[A] const& value); ----- - -[.small]#link:#X-2constructor-0b[_» more..._]# - -Construct from `A` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-00[X](link:#A[A]&& value); ----- - -[.small]#link:#X-2constructor-00[_» more..._]# - -[#X-2constructor-0e8] -== link:#X[X]::X - -Default constructor - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -constexpr -X() = default; ----- - -[#X-2constructor-0e0] -== link:#X[X]::X - -Copy constructor - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -constexpr -X(link:#X[X] const& other) = default; ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy construct from -|=== - -[#X-2constructor-06] -== link:#X[X]::X - -Move constructor - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -constexpr -X(link:#X[X]&& other) = default; ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move construct from -|=== - -[#X-2constructor-07] -== link:#X[X]::X - -Construct from `int` - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#X-2constructor-0b] -== link:#X[X]::X - -Construct from `A` - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(link:#A[A] const& value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to copy construct from -|=== - -[#X-2constructor-00] -== link:#X[X]::X - -Construct from `A` - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(link:#A[A]&& value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to move construct from -|=== - -[#X-2destructor] -== link:#X[X]::~X - -Destructor - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~X(); ----- - -[#X-2conversion-00] -== link:#X[X]::operator link:#A[A] - -Conversion to `A` - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator link:#A[A]() const; ----- - -=== Return Value - -A helper tag - -[#X-2conversion-0b] -== link:#X[X]::operator int - -Conversion to `int` - -=== Synopsis - -Declared in `<brief‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator int() const; ----- - -=== Return Value - -The object converted to `int` - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.cpp b/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.cpp deleted file mode 100644 index efa711cba..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.cpp +++ /dev/null @@ -1,17 +0,0 @@ -/// A helper tag -struct A -{}; - -/// Test class -struct X -{ - X() = default; - X(X const&) = default; - X(X&&) = default; - X(A const&); - X(A&&); - X(int); - ~X(); - operator int() const; - operator A() const; -}; \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.html b/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.html deleted file mode 100644 index c805d70c3..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.html +++ /dev/null @@ -1,420 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - -
NameDescription
A A helper tag
X Test class
- -
-
-
-

A

-
-A helper tag - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

X

-
-Test class - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-struct X;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - -
NameDescription
X [constructor]Constructors
~X [destructor]Destructor
operator A Conversion to A
operator int Conversion to int
- - - -
-
-
-

X::X

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <brief-from-function-class.cpp>
-Default constructor -
-constexpr
-X() = default;
-
-
-
» more... - -Copy constructor -
-constexpr
-X(X const& other) = default;
-
-
-
» more... - -Move constructor -
-constexpr
-X(X&& other) = default;
-
-
-
» more... - -Construct from int -
-X(int value);
-
-
-
» more... - -Construct from A -
-X(A const& value);
-
-
-
» more... - -Construct from A -
-X(A&& value);
-
-
-
» more... - - -
-
-
-
-

X::X

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-constexpr
-X() = default;
-
-
-
-
-
-
-
-

X::X

-
-Copy constructor - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-constexpr
-X(X const& other) = default;
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy construct from
-
-
-
-
-

X::X

-
-Move constructor - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-constexpr
-X(X&& other) = default;
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move construct from
-
-
-
-
-

X::X

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-X(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

X::X

-
-Construct from A - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-X(A const& value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to copy construct from
-
-
-
-
-

X::X

-
-Construct from A - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-X(A&& value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to move construct from
-
-
-
-
-

X::~X

-
-Destructor - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-~X();
-
-
-
-
-
-
-
-

X::operator A

-
-Conversion to A - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-operator A() const;
-
-
-
-
-
-

Return Value

-A helper tag -
-
-
-
-

X::operator int

-
-Conversion to int - -
-
-
-

Synopsis

-
-Declared in <brief-from-function-class.cpp>
-
-operator int() const;
-
-
-
-
-
-

Return Value

-The object converted to int -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.xml b/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.xml deleted file mode 100644 index b5be0885a..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - - A helper tag - - - - - - - - Test class - - - - - - - - - - Default constructor - - - - - - - - - - - - - - - - Copy constructor - - - The object to copy construct from - - - - - - - - - - - - - - - - Move constructor - - - The object to move construct from - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - - - - - - Construct from - A - - - The object to copy construct from - - - - - - - - - - - - - Construct from - A - - - The object to move construct from - - - - - - - - Destructor - - - - - - - - - - - - Conversion to - A - - - A helper tag - - - - - - - - - - - - Conversion to - int - - - The object converted to - int - - - - - - diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.yml b/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.yml deleted file mode 100644 index 2bdf9b1c4..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-function-class.yml +++ /dev/null @@ -1 +0,0 @@ -auto-function-metadata: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.adoc b/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.adoc deleted file mode 100644 index 8fb246f40..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.adoc +++ /dev/null @@ -1,277 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A helper tag -| link:#X[`X`] -| Test class -| link:#ostream[`ostream`] -| A dumb ostream class -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#operator_lshift[`operator<<`] -| Stream insertion operator -|=== - -[#A] -== A - -A helper tag - -=== Synopsis - -Declared in `<brief‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#X] -== X - -Test class - -=== Synopsis - -Declared in `<brief‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct X; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#X-operator_assign-0a[`operator=`] -| Assignment operators -| link:#X-operator_plus_eq[`operator+=`] -| Addition assignment operator -|=== - -[#X-operator_assign-0a] -== link:#X[X]::operator= - -Assignment operators - -=== Synopses - -Declared in `<brief‐from‐operator.cpp>` - -Copy assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-06[operator=](link:#X[X] const& other); ----- - -[.small]#link:#X-operator_assign-06[_» more..._]# - -Move assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-0e[operator=](link:#X[X]&& other); ----- - -[.small]#link:#X-operator_assign-0e[_» more..._]# - -Assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-0d[operator=](link:#A[A] const& value); ----- - -[.small]#link:#X-operator_assign-0d[_» more..._]# - -[#X-operator_assign-06] -== link:#X[X]::operator= - -Copy assignment operator - -=== Synopsis - -Declared in `<brief‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(link:#X[X] const& other); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy assign from -|=== - -[#X-operator_assign-0e] -== link:#X[X]::operator= - -Move assignment operator - -=== Synopsis - -Declared in `<brief‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(link:#X[X]&& other); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move assign from -|=== - -[#X-operator_assign-0d] -== link:#X[X]::operator= - -Assignment operator - -=== Synopsis - -Declared in `<brief‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(link:#A[A] const& value); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to copy assign from -|=== - -[#X-operator_plus_eq] -== link:#X[X]::operator+= - -Addition assignment operator - -=== Synopsis - -Declared in `<brief‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator+=(link:#X[X] const& rhs); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#ostream] -== ostream - -A dumb ostream class - -=== Synopsis - -Declared in `<brief‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct ostream; ----- - -[#operator_lshift] -== operator<< - -Stream insertion operator - -=== Synopsis - -Declared in `<brief‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#ostream[ostream]& -operator<<( - link:#ostream[ostream]& os, - link:#X[X] const& x); ----- - -=== Return Value - -Reference to the current output stream - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *os* -| An output stream -| *x* -| The object to output -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.cpp b/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.cpp deleted file mode 100644 index da1ccb30b..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.cpp +++ /dev/null @@ -1,28 +0,0 @@ -/// A helper tag -struct A -{}; - -/// A dumb ostream class -struct ostream {}; - -/// Test class -struct X -{ - X& - operator=(X const&); - - X& - operator=(X&&); - - X& - operator=(A const&); - - X& - operator+=(X const&); -}; - -ostream& -operator<<(ostream& os, X const& x) -{ - return os; -} diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.html b/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.html deleted file mode 100644 index e494d0fcd..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.html +++ /dev/null @@ -1,377 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - -
NameDescription
A A helper tag
X Test class
ostream A dumb ostream class
- -

Functions

- - - - - - - - - - - -
NameDescription
operator<< Stream insertion operator
- -
-
-
-

A

-
-A helper tag - -
-
-
-

Synopsis

-
-Declared in <brief-from-operator.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

X

-
-Test class - -
-
-
-

Synopsis

-
-Declared in <brief-from-operator.cpp>
-
-struct X;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
operator= Assignment operators
operator+= Addition assignment operator
- - - -
-
-
-

X::operator=

-
-Assignment operators - -
-
-
-

Synopses

-
-Declared in <brief-from-operator.cpp>
-Copy assignment operator -
-X&
-operator=(X const& other);
-
-
-
» more... - -Move assignment operator -
-X&
-operator=(X&& other);
-
-
-
» more... - -Assignment operator -
-X&
-operator=(A const& value);
-
-
-
» more... - - -
-
-
-
-

X::operator=

-
-Copy assignment operator - -
-
-
-

Synopsis

-
-Declared in <brief-from-operator.cpp>
-
-X&
-operator=(X const& other);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy assign from
-
-
-
-
-

X::operator=

-
-Move assignment operator - -
-
-
-

Synopsis

-
-Declared in <brief-from-operator.cpp>
-
-X&
-operator=(X&& other);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move assign from
-
-
-
-
-

X::operator=

-
-Assignment operator - -
-
-
-

Synopsis

-
-Declared in <brief-from-operator.cpp>
-
-X&
-operator=(A const& value);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to copy assign from
-
-
-
-
-

X::operator+=

-
-Addition assignment operator - -
-
-
-

Synopsis

-
-Declared in <brief-from-operator.cpp>
-
-X&
-operator+=(X const& rhs);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

ostream

-
-A dumb ostream class - -
-
-
-

Synopsis

-
-Declared in <brief-from-operator.cpp>
-
-struct ostream;
-
-
-
-
- - -
-
-
-

operator<<

-
-Stream insertion operator - -
-
-
-

Synopsis

-
-Declared in <brief-from-operator.cpp>
-
-ostream&
-operator<<(
-    ostream& os,
-    X const& x);
-
-
-
-
-
-

Return Value

-Reference to the current output stream -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
osAn output stream
xThe object to output
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.xml b/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.xml deleted file mode 100644 index 7acdca1ae..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - - A helper tag - - - - - - - - Test class - - - - - - - - - - - - - - - - - - Copy assignment operator - - - Reference to the current object - - - The object to copy assign from - - - - - - - - - - - - - - - - - - - Move assignment operator - - - Reference to the current object - - - The object to move assign from - - - - - - - - - - - - - - - - - - - Assignment operator - - - Reference to the current object - - - The object to copy assign from - - - - - - - - - - - - - - - - - - - Addition assignment operator - - - Reference to the current object - - - The right operand - - - - - - - - - A dumb ostream class - - - - - - - - - - - - - - - - - - - - - - - - Stream insertion operator - - - Reference to the current output stream - - - An output stream - - - The object to output - - - - - diff --git a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.yml b/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.yml deleted file mode 100644 index 2bdf9b1c4..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/brief-from-operator.yml +++ /dev/null @@ -1 +0,0 @@ -auto-function-metadata: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.adoc b/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.adoc deleted file mode 100644 index 9d407284c..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.adoc +++ /dev/null @@ -1,448 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A helper tag -| link:#X[`X`] -| Test class -|=== - -[#A] -== A - -A helper tag - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#X] -== X - -Test class - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct X; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#X-2constructor-08[`X`] [.small]#[constructor]# -| Constructors -| link:#X-operator_assign-0a[`operator=`] -| Assignment operators -|=== - -[#X-2constructor-08] -== link:#X[X]::X - -Constructors - -=== Synopses - -Declared in `<param‐from‐function‐class.cpp>` - -Copy constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-0e[X](link:#X[X] const& other); ----- - -[.small]#link:#X-2constructor-0e[_» more..._]# - -Move constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-06[X](link:#X[X]&& other); ----- - -[.small]#link:#X-2constructor-06[_» more..._]# - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-07[X](int value); ----- - -[.small]#link:#X-2constructor-07[_» more..._]# - -Construct from `A` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-0b[X](link:#A[A] const& value); ----- - -[.small]#link:#X-2constructor-0b[_» more..._]# - -Construct from `A` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-00[X](link:#A[A]&& value); ----- - -[.small]#link:#X-2constructor-00[_» more..._]# - -[#X-2constructor-0e] -== link:#X[X]::X - -Copy constructor - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(link:#X[X] const& other); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy construct from -|=== - -[#X-2constructor-06] -== link:#X[X]::X - -Move constructor - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(link:#X[X]&& other); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move construct from -|=== - -[#X-2constructor-07] -== link:#X[X]::X - -Construct from `int` - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#X-2constructor-0b] -== link:#X[X]::X - -Construct from `A` - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(link:#A[A] const& value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to copy construct from -|=== - -[#X-2constructor-00] -== link:#X[X]::X - -Construct from `A` - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(link:#A[A]&& value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to move construct from -|=== - -[#X-operator_assign-0a] -== link:#X[X]::operator= - -Assignment operators - -=== Synopses - -Declared in `<param‐from‐function‐class.cpp>` - -Copy assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-06[operator=](link:#X[X] const& other); ----- - -[.small]#link:#X-operator_assign-06[_» more..._]# - -Move assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-0e[operator=](link:#X[X]&& other); ----- - -[.small]#link:#X-operator_assign-0e[_» more..._]# - -Assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-07f[operator=](int value); ----- - -[.small]#link:#X-operator_assign-07f[_» more..._]# - -Assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-0d[operator=](link:#A[A] const& value); ----- - -[.small]#link:#X-operator_assign-0d[_» more..._]# - -Assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-07e[operator=](link:#A[A]&& value); ----- - -[.small]#link:#X-operator_assign-07e[_» more..._]# - -[#X-operator_assign-06] -== link:#X[X]::operator= - -Copy assignment operator - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(link:#X[X] const& other); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy assign from -|=== - -[#X-operator_assign-0e] -== link:#X[X]::operator= - -Move assignment operator - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(link:#X[X]&& other); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move assign from -|=== - -[#X-operator_assign-07f] -== link:#X[X]::operator= - -Assignment operator - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(int value); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to assign from -|=== - -[#X-operator_assign-0d] -== link:#X[X]::operator= - -Assignment operator - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(link:#A[A] const& value); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to copy assign from -|=== - -[#X-operator_assign-07e] -== link:#X[X]::operator= - -Assignment operator - -=== Synopsis - -Declared in `<param‐from‐function‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(link:#A[A]&& value); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to move assign from -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.cpp b/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.cpp deleted file mode 100644 index 326ecf5e8..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.cpp +++ /dev/null @@ -1,32 +0,0 @@ -/// A helper tag -struct A -{}; - -/// Test class -struct X -{ - X(X const& other); - - X(X&& other); - - X(A const& value); - - X(A&& value); - - X(int value); - - X& - operator=(X const& other); - - X& - operator=(X&& other); - - X& - operator=(A const& value); - - X& - operator=(A&& value); - - X& - operator=(int value); -}; diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.html b/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.html deleted file mode 100644 index bdcfd1f52..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.html +++ /dev/null @@ -1,581 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - -
NameDescription
A A helper tag
X Test class
- -
-
-
-

A

-
-A helper tag - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

X

-
-Test class - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-struct X;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
X [constructor]Constructors
operator= Assignment operators
- - - -
-
-
-

X::X

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <param-from-function-class.cpp>
-Copy constructor -
-X(X const& other);
-
-
-
» more... - -Move constructor -
-X(X&& other);
-
-
-
» more... - -Construct from int -
-X(int value);
-
-
-
» more... - -Construct from A -
-X(A const& value);
-
-
-
» more... - -Construct from A -
-X(A&& value);
-
-
-
» more... - - -
-
-
-
-

X::X

-
-Copy constructor - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X(X const& other);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy construct from
-
-
-
-
-

X::X

-
-Move constructor - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X(X&& other);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move construct from
-
-
-
-
-

X::X

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

X::X

-
-Construct from A - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X(A const& value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to copy construct from
-
-
-
-
-

X::X

-
-Construct from A - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X(A&& value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to move construct from
-
-
-
-
-

X::operator=

-
-Assignment operators - -
-
-
-

Synopses

-
-Declared in <param-from-function-class.cpp>
-Copy assignment operator -
-X&
-operator=(X const& other);
-
-
-
» more... - -Move assignment operator -
-X&
-operator=(X&& other);
-
-
-
» more... - -Assignment operator -
-X&
-operator=(int value);
-
-
-
» more... - -Assignment operator -
-X&
-operator=(A const& value);
-
-
-
» more... - -Assignment operator -
-X&
-operator=(A&& value);
-
-
-
» more... - - -
-
-
-
-

X::operator=

-
-Copy assignment operator - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X&
-operator=(X const& other);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy assign from
-
-
-
-
-

X::operator=

-
-Move assignment operator - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X&
-operator=(X&& other);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move assign from
-
-
-
-
-

X::operator=

-
-Assignment operator - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X&
-operator=(int value);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to assign from
-
-
-
-
-

X::operator=

-
-Assignment operator - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X&
-operator=(A const& value);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to copy assign from
-
-
-
-
-

X::operator=

-
-Assignment operator - -
-
-
-

Synopsis

-
-Declared in <param-from-function-class.cpp>
-
-X&
-operator=(A&& value);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to move assign from
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.xml b/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.xml deleted file mode 100644 index 09bd6cf95..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.xml +++ /dev/null @@ -1,226 +0,0 @@ - - - - - - - - A helper tag - - - - - - - - Test class - - - - - - - - - - - - Copy constructor - - - The object to copy construct from - - - - - - - - - - - - - Move constructor - - - The object to move construct from - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - - - - - - Construct from - A - - - The object to copy construct from - - - - - - - - - - - - - Construct from - A - - - The object to move construct from - - - - - - - - - - - - - - - - - - - Copy assignment operator - - - Reference to the current object - - - The object to copy assign from - - - - - - - - - - - - - - - - - - - Move assignment operator - - - Reference to the current object - - - The object to move assign from - - - - - - - - - - - - - - - - - Assignment operator - - - Reference to the current object - - - The value to assign from - - - - - - - - - - - - - - - - - - - Assignment operator - - - Reference to the current object - - - The object to copy assign from - - - - - - - - - - - - - - - - - - - Assignment operator - - - Reference to the current object - - - The object to move assign from - - - - - - diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.yml b/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.yml deleted file mode 100644 index 2bdf9b1c4..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-function-class.yml +++ /dev/null @@ -1 +0,0 @@ -auto-function-metadata: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.adoc b/test-files/golden-tests/config/auto-function-metadata/param-from-operator.adoc deleted file mode 100644 index 2814e9be7..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.adoc +++ /dev/null @@ -1,212 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A helper tag -| link:#X[`X`] -| Test class -| link:#ostream[`ostream`] -| A dumb ostream class -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#operator_minus[`operator‐`] -| Subtraction operator -| link:#operator_lshift[`operator<<`] -| Stream insertion operator -| link:#operator_not[`operator!`] -| Negation operator -|=== - -[#A] -== A - -A helper tag - -=== Synopsis - -Declared in `<param‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#X] -== X - -Test class - -=== Synopsis - -Declared in `<param‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct X; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#X-operator_plus[`operator+`] -| Addition operator -|=== - -[#X-operator_plus] -== link:#X[X]::operator+ - -Addition operator - -=== Synopsis - -Declared in `<param‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X] -operator+(link:#X[X] const& x) const; ----- - -=== Return Value - -Another instance of the object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *x* -| The right operand -|=== - -[#ostream] -== ostream - -A dumb ostream class - -=== Synopsis - -Declared in `<param‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct ostream; ----- - -[#operator_minus] -== operator‐ - -Subtraction operator - -=== Synopsis - -Declared in `<param‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X] -operator‐( - link:#X[X] const& x, - link:#X[X] const& y); ----- - -=== Return Value - -Test class - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *x* -| The left operand -| *y* -| The right operand -|=== - -[#operator_lshift] -== operator<< - -Stream insertion operator - -=== Synopsis - -Declared in `<param‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#ostream[ostream]& -operator<<( - link:#ostream[ostream]& os, - link:#X[X] const& x); ----- - -=== Return Value - -Reference to the current output stream - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *os* -| An output stream -| *x* -| The object to output -|=== - -[#operator_not] -== operator! - -Negation operator - -=== Synopsis - -Declared in `<param‐from‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X] -operator!(link:#X[X] const& x); ----- - -=== Return Value - -Test class - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *x* -| The operand -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.cpp b/test-files/golden-tests/config/auto-function-metadata/param-from-operator.cpp deleted file mode 100644 index edc902e1e..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.cpp +++ /dev/null @@ -1,25 +0,0 @@ -/// A helper tag -struct A -{}; - -/// A dumb ostream class -struct ostream {}; - -/// Test class -struct X -{ - X - operator+(X const& x) const; -}; - -X -operator-(X const& x, X const& y); - -X -operator!(X const& x); - -ostream& -operator<<(ostream& os, X const& x) -{ - return os; -} diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.html b/test-files/golden-tests/config/auto-function-metadata/param-from-operator.html deleted file mode 100644 index 02d6797e8..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.html +++ /dev/null @@ -1,304 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - -
NameDescription
A A helper tag
X Test class
ostream A dumb ostream class
- -

Functions

- - - - - - - - - - - - - -
NameDescription
operator- Subtraction operator
operator<< Stream insertion operator
operator! Negation operator
- -
-
-
-

A

-
-A helper tag - -
-
-
-

Synopsis

-
-Declared in <param-from-operator.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

X

-
-Test class - -
-
-
-

Synopsis

-
-Declared in <param-from-operator.cpp>
-
-struct X;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
operator+ Addition operator
- - - -
-
-
-

X::operator+

-
-Addition operator - -
-
-
-

Synopsis

-
-Declared in <param-from-operator.cpp>
-
-X
-operator+(X const& x) const;
-
-
-
-
-
-

Return Value

-Another instance of the object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
xThe right operand
-
-
-
-
-

ostream

-
-A dumb ostream class - -
-
-
-

Synopsis

-
-Declared in <param-from-operator.cpp>
-
-struct ostream;
-
-
-
-
- - -
-
-
-

operator-

-
-Subtraction operator - -
-
-
-

Synopsis

-
-Declared in <param-from-operator.cpp>
-
-X
-operator-(
-    X const& x,
-    X const& y);
-
-
-
-
-
-

Return Value

-Test class -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
xThe left operand
yThe right operand
-
-
-
-
-

operator<<

-
-Stream insertion operator - -
-
-
-

Synopsis

-
-Declared in <param-from-operator.cpp>
-
-ostream&
-operator<<(
-    ostream& os,
-    X const& x);
-
-
-
-
-
-

Return Value

-Reference to the current output stream -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
osAn output stream
xThe object to output
-
-
-
-
-

operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <param-from-operator.cpp>
-
-X
-operator!(X const& x);
-
-
-
-
-
-

Return Value

-Test class -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
xThe operand
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.xml b/test-files/golden-tests/config/auto-function-metadata/param-from-operator.xml deleted file mode 100644 index 534f8bc38..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.xml +++ /dev/null @@ -1,141 +0,0 @@ - - - - - - - - A helper tag - - - - - - - - Test class - - - - - - - - - - - - - - - - - Addition operator - - - Another instance of the object - - - The right operand - - - - - - - - - A dumb ostream class - - - - - - - - - - - - - - - - - - - - - - Subtraction operator - - - Test class - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - - - Stream insertion operator - - - Reference to the current output stream - - - An output stream - - - The object to output - - - - - - - - - - - - - - - - - Negation operator - - - Test class - - - The operand - - - - - diff --git a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.yml b/test-files/golden-tests/config/auto-function-metadata/param-from-operator.yml deleted file mode 100644 index 2bdf9b1c4..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/param-from-operator.yml +++ /dev/null @@ -1 +0,0 @@ -auto-function-metadata: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.adoc b/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.adoc deleted file mode 100644 index de356cb5e..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.adoc +++ /dev/null @@ -1,103 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#X[`X`] -| Test class -|=== - -[#X] -== X - -Test class - -=== Synopsis - -Declared in `<returns‐from‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct X; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#X-empty[`empty`] -| Determines whether the range is empty. -| link:#X-front[`front`] -| Returns the first element of the range. -| link:#X-size[`size`] -| Get the range size. -|=== - -[#X-empty] -== link:#X[X]::empty - -Determines whether the range is empty. - -=== Synopsis - -Declared in `<returns‐from‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -empty(); ----- - -=== Return Value - -whether the range is empty. - -[#X-front] -== link:#X[X]::front - -Returns the first element of the range. - -=== Synopsis - -Declared in `<returns‐from‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -front() const; ----- - -=== Return Value - -the first element of the range. - -[#X-size] -== link:#X[X]::size - -Get the range size. - -=== Synopsis - -Declared in `<returns‐from‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -size() const; ----- - -=== Return Value - -the range size. - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.cpp b/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.cpp deleted file mode 100644 index 21e38134d..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.cpp +++ /dev/null @@ -1,15 +0,0 @@ -/// Test class -struct X -{ - /// Returns the first element of the range. - int - front() const; - - /// Determines whether the range is empty. - bool - empty(); - - /// Get the range size. - int - size() const; -}; diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.html b/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.html deleted file mode 100644 index a96ba4557..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.html +++ /dev/null @@ -1,142 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
NameDescription
X Test class
- -
-
-
-

X

-
-Test class - -
-
-
-

Synopsis

-
-Declared in <returns-from-brief.cpp>
-
-struct X;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - -
NameDescription
empty Determines whether the range is empty.
front Returns the first element of the range.
size Get the range size.
- - - -
-
-
-

X::empty

-
-Determines whether the range is empty. - -
-
-
-

Synopsis

-
-Declared in <returns-from-brief.cpp>
-
-bool
-empty();
-
-
-
-
-
-

Return Value

-whether the range is empty. -
-
-
-
-

X::front

-
-Returns the first element of the range. - -
-
-
-

Synopsis

-
-Declared in <returns-from-brief.cpp>
-
-int
-front() const;
-
-
-
-
-
-

Return Value

-the first element of the range. -
-
-
-
-

X::size

-
-Get the range size. - -
-
-
-

Synopsis

-
-Declared in <returns-from-brief.cpp>
-
-int
-size() const;
-
-
-
-
-
-

Return Value

-the range size. -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.xml b/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.xml deleted file mode 100644 index bbd3682d2..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.xml +++ /dev/null @@ -1,58 +0,0 @@ - - - - - - - - Test class - - - - - - - - - - Determines whether the range is empty. - - - whether the range is empty. - - - - - - - - - - - - Returns the first element of the range. - - - the first element of the range. - - - - - - - - - - - - Get the range size. - - - the range size. - - - - - - diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.yml b/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.yml deleted file mode 100644 index 2bdf9b1c4..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-brief.yml +++ /dev/null @@ -1 +0,0 @@ -auto-function-metadata: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.adoc b/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.adoc deleted file mode 100644 index 3b959da7b..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.adoc +++ /dev/null @@ -1,71 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#R[`R`] -| The return type of the function -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#getR[`getR`] -| Test function -|=== - -[#R] -== R - -The return type of the function - -=== Synopsis - -Declared in `<returns‐from‐return‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct R; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#getR[`getR`] -| Test function -|=== - -[#getR] -== getR - -Test function - -=== Synopsis - -Declared in `<returns‐from‐return‐brief.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#R[R] -getR(); ----- - -=== Return Value - -The return type of the function - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.cpp b/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.cpp deleted file mode 100644 index dd535ea8d..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.cpp +++ /dev/null @@ -1,6 +0,0 @@ -/// The return type of the function -struct R; - -/// Test function -R -getR(); \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.html b/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.html deleted file mode 100644 index 9c628cf83..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.html +++ /dev/null @@ -1,106 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
NameDescription
R The return type of the function
- -

Functions

- - - - - - - - - - - -
NameDescription
getR Test function
- -
-
-
-

R

-
-The return type of the function - -
-
-
-

Synopsis

-
-Declared in <returns-from-return-brief.cpp>
-
-struct R;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - -
NameDescription
getRTest function
-
-
-
-
-

getR

-
-Test function - -
-
-
-

Synopsis

-
-Declared in <returns-from-return-brief.cpp>
-
-R
-getR();
-
-
-
-
-
-

Return Value

-The return type of the function -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.xml b/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.xml deleted file mode 100644 index 53bf51ec3..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - The return type of the function - - - getR - - - - - - - - - - - Test function - - - The return type of the function - - - R - - - - - diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.yml b/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.yml deleted file mode 100644 index 2bdf9b1c4..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-return-brief.yml +++ /dev/null @@ -1 +0,0 @@ -auto-function-metadata: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.adoc b/test-files/golden-tests/config/auto-function-metadata/returns-from-special.adoc deleted file mode 100644 index d753647a4..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.adoc +++ /dev/null @@ -1,826 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A helper class -| link:#Undoc[`Undoc`] -| -| link:#X[`X`] -| Test class -| link:#ostream[`ostream`] -| A fake output stream -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#operator_lshift[`operator<<`] -| Stream insertion operator -| link:#operator_not[`operator!`] -| Negation operator -| link:#operator_eq[`operator==`] -| Equality operator -| link:#operator_not_eq[`operator!=`] -| Inequality operator -| link:#operator_lt[`operator<`] -| Less‐than operator -| link:#operator_le[`operator<=`] -| Less‐than‐or‐equal operator -| link:#operator_gt[`operator>`] -| Greater‐than operator -| link:#operator_ge[`operator>=`] -| Greater‐than‐or‐equal operator -| link:#operator_3way[`operator<=>`] -| Three‐way comparison operator -|=== - -[#A] -== A - -A helper class - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#Undoc] -== Undoc - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Undoc; ----- - -[#X] -== X - -Test class - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct X; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#X-operator_assign-0a[`operator=`] -| Assignment operators -| link:#X-operator_plus[`operator+`] -| Addition operator -| link:#X-operator_ptr[`operator‐>`] -| Member access operator -| link:#X-2conversion-00[`operator A`] -| Conversion to `A` -| link:#X-2conversion-03[`operator Undoc`] -| Conversion to `Undoc` -| link:#X-operator_not[`operator!`] -| Negation operator -| link:#X-operator_eq[`operator==`] -| Equality operator -| link:#X-operator_not_eq[`operator!=`] -| Inequality operator -| link:#X-operator_lt[`operator<`] -| Less‐than operator -| link:#X-operator_le[`operator<=`] -| Less‐than‐or‐equal operator -| link:#X-operator_gt[`operator>`] -| Greater‐than operator -| link:#X-operator_ge[`operator>=`] -| Greater‐than‐or‐equal operator -| link:#X-operator_3way[`operator<=>`] -| Three‐way comparison operator -|=== - -[#X-operator_assign-0a] -== link:#X[X]::operator= - -Assignment operators - -=== Synopses - -Declared in `<returns‐from‐special.cpp>` - -Assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -link:#X-operator_assign-0d[operator=](link:#A[A] const& value); ----- - -[.small]#link:#X-operator_assign-0d[_» more..._]# - -Assignment operator - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]&& -link:#X-operator_assign-07[operator=](link:#A[A]&& value); ----- - -[.small]#link:#X-operator_assign-07[_» more..._]# - -[#X-operator_assign-0d] -== link:#X[X]::operator= - -Assignment operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]& -operator=(link:#A[A] const& value); ----- - -=== Return Value - -Reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to copy assign from -|=== - -[#X-operator_assign-07] -== link:#X[X]::operator= - -Assignment operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]&& -operator=(link:#A[A]&& value); ----- - -=== Return Value - -Rvalue reference to the current object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The object to move assign from -|=== - -[#X-operator_plus] -== link:#X[X]::operator+ - -Addition operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X] -operator+(link:#X[X] const& rhs) const; ----- - -=== Return Value - -Another instance of the object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#X-operator_ptr] -== link:#X[X]::operator‐> - -Member access operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X[X]* -operator‐>(); ----- - -=== Return Value - -Pointer to the current object - -[#X-2conversion-00] -== link:#X[X]::operator link:#A[A] - -Conversion to `A` - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator link:#A[A]() const; ----- - -=== Return Value - -A helper class - -[#X-2conversion-03] -== link:#X[X]::operator link:#Undoc[Undoc] - -Conversion to `Undoc` - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator link:#Undoc[Undoc]() const; ----- - -=== Return Value - -The object converted to `Undoc` - -[#X-operator_not] -== link:#X[X]::operator! - -Negation operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!() const; ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -[#X-operator_eq] -== link:#X[X]::operator== - -Equality operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==(link:#X[X] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#X-operator_not_eq] -== link:#X[X]::operator!= - -Inequality operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=(link:#X[X] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#X-operator_lt] -== link:#X[X]::operator< - -Less‐than operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator<(link:#X[X] const& rhs) const; ----- - -=== Return Value - -`true` if the left object is less than the right object, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#X-operator_le] -== link:#X[X]::operator<= - -Less‐than‐or‐equal operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator<=(link:#X[X] const& rhs) const; ----- - -=== Return Value - -`true` if the left object is less than or equal to the right object, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#X-operator_gt] -== link:#X[X]::operator> - -Greater‐than operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator>(link:#X[X] const& rhs) const; ----- - -=== Return Value - -`true` if the left object is greater than the right object, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#X-operator_ge] -== link:#X[X]::operator>= - -Greater‐than‐or‐equal operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator>=(link:#X[X] const& rhs) const; ----- - -=== Return Value - -`true` if the left object is greater than or equal to the right object, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#X-operator_3way] -== link:#X[X]::operator<=> - -Three‐way comparison operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -auto -operator<=>(link:#X[X] const& rhs) const; ----- - -=== Return Value - -The relative order of the objects - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#ostream] -== ostream - -A fake output stream - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct ostream; ----- - -[#operator_lshift] -== operator<< - -Stream insertion operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#ostream[ostream]& -operator<<( - link:#ostream[ostream]& os, - link:#A[A] const& value); ----- - -=== Return Value - -Reference to the current output stream - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *os* -| An output stream -| *value* -| The object to output -|=== - -[#operator_not] -== operator! - -Negation operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!(link:#A[A] const& value); ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The operand -|=== - -[#operator_eq] -== operator== - -Equality operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_not_eq] -== operator!= - -Inequality operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_lt] -== operator< - -Less‐than operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator<( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the left object is less than the right object, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_le] -== operator<= - -Less‐than‐or‐equal operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator<=( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the left object is less than or equal to the right object, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_gt] -== operator> - -Greater‐than operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator>( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the left object is greater than the right object, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_ge] -== operator>= - -Greater‐than‐or‐equal operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator>=( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the left object is greater than or equal to the right object, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_3way] -== operator<=> - -Three‐way comparison operator - -=== Synopsis - -Declared in `<returns‐from‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -auto -operator<=>( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -The relative order of the objects - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.cpp b/test-files/golden-tests/config/auto-function-metadata/returns-from-special.cpp deleted file mode 100644 index 1dbf33008..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.cpp +++ /dev/null @@ -1,78 +0,0 @@ -/// A helper class -struct A {}; - -bool -operator==(A const&, A const&); - -bool -operator!=(A const&, A const&); - -bool -operator<(A const&, A const&); - -bool -operator<=(A const&, A const&); - -bool -operator>(A const&, A const&); - -bool -operator>=(A const&, A const&); - -bool -operator!(A const&); - -auto -operator<=>(A const&, A const&); - -struct Undoc {}; - -/// Test class -struct X -{ - operator A() const; - - operator Undoc() const; - - X& - operator=(A const&); - - X&& - operator=(A&&); - - X - operator+(X const&) const; - - X* - operator->(); - - bool - operator==(X const&) const; - - bool - operator!=(X const&) const; - - bool - operator<(X const&) const; - - bool - operator<=(X const&) const; - - bool - operator>(X const&) const; - - bool - operator>=(X const&) const; - - bool - operator!() const; - - auto - operator<=>(X const&) const; -}; - -/// A fake output stream -struct ostream; - -ostream& -operator<<(ostream&, A const&); diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.html b/test-files/golden-tests/config/auto-function-metadata/returns-from-special.html deleted file mode 100644 index 98024861f..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.html +++ /dev/null @@ -1,1116 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - -
NameDescription
A A helper class
Undoc
X Test class
ostream A fake output stream
- -

Functions

- - - - - - - - - - - - - - - - - - - -
NameDescription
operator<< Stream insertion operator
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
operator< Less-than operator
operator<= Less-than-or-equal operator
operator> Greater-than operator
operator>= Greater-than-or-equal operator
operator<=> Three-way comparison operator
- -
-
-
-

A

-
-A helper class - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

Undoc

-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-struct Undoc;
-
-
-
-
- - -
-
-
-

X

-
-Test class - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-struct X;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
operator= Assignment operators
operator+ Addition operator
operator-> Member access operator
operator A Conversion to A
operator Undoc Conversion to Undoc
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
operator< Less-than operator
operator<= Less-than-or-equal operator
operator> Greater-than operator
operator>= Greater-than-or-equal operator
operator<=> Three-way comparison operator
- - - -
-
-
-

X::operator=

-
-Assignment operators - -
-
-
-

Synopses

-
-Declared in <returns-from-special.cpp>
-Assignment operator -
-X&
-operator=(A const& value);
-
-
-
» more... - -Assignment operator -
-X&&
-operator=(A&& value);
-
-
-
» more... - - -
-
-
-
-

X::operator=

-
-Assignment operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-X&
-operator=(A const& value);
-
-
-
-
-
-

Return Value

-Reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to copy assign from
-
-
-
-
-

X::operator=

-
-Assignment operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-X&&
-operator=(A&& value);
-
-
-
-
-
-

Return Value

-Rvalue reference to the current object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe object to move assign from
-
-
-
-
-

X::operator+

-
-Addition operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-X
-operator+(X const& rhs) const;
-
-
-
-
-
-

Return Value

-Another instance of the object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

X::operator->

-
-Member access operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-X*
-operator->();
-
-
-
-
-
-

Return Value

-Pointer to the current object -
-
-
-
-

X::operator A

-
-Conversion to A - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-operator A() const;
-
-
-
-
-
-

Return Value

-A helper class -
-
-
-
-

X::operator Undoc

-
-Conversion to Undoc - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-operator Undoc() const;
-
-
-
-
-
-

Return Value

-The object converted to Undoc -
-
-
-
-

X::operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator!() const;
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-
-
-

X::operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator==(X const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

X::operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator!=(X const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

X::operator<

-
-Less-than operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator<(X const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the left object is less than the right object, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

X::operator<=

-
-Less-than-or-equal operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator<=(X const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the left object is less than or equal to the right object, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

X::operator>

-
-Greater-than operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator>(X const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the left object is greater than the right object, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

X::operator>=

-
-Greater-than-or-equal operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator>=(X const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the left object is greater than or equal to the right object, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

X::operator<=>

-
-Three-way comparison operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-auto
-operator<=>(X const& rhs) const;
-
-
-
-
-
-

Return Value

-The relative order of the objects -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

ostream

-
-A fake output stream - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-struct ostream;
-
-
-
-
- - -
-
-
-

operator<<

-
-Stream insertion operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-ostream&
-operator<<(
-    ostream& os,
-    A const& value);
-
-
-
-
-
-

Return Value

-Reference to the current output stream -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
osAn output stream
valueThe object to output
-
-
-
-
-

operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator!(A const& value);
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe operand
-
-
-
-
-

operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator==(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator!=(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator<

-
-Less-than operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator<(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the left object is less than the right object, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator<=

-
-Less-than-or-equal operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator<=(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the left object is less than or equal to the right object, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator>

-
-Greater-than operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator>(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the left object is greater than the right object, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator>=

-
-Greater-than-or-equal operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-bool
-operator>=(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the left object is greater than or equal to the right object, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator<=>

-
-Three-way comparison operator - -
-
-
-

Synopsis

-
-Declared in <returns-from-special.cpp>
-
-auto
-operator<=>(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-The relative order of the objects -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.xml b/test-files/golden-tests/config/auto-function-metadata/returns-from-special.xml deleted file mode 100644 index 91b8ee830..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.xml +++ /dev/null @@ -1,658 +0,0 @@ - - - - - - - - A helper class - - - - - - - - - - - Test class - - - - - - - - - - - - - - - - - - Assignment operator - - - Reference to the current object - - - The object to copy assign from - - - - - - - - - - - - - - - - - - - Assignment operator - - - Rvalue reference to the current object - - - The object to move assign from - - - - - - - - - - - - - - - - - - Addition operator - - - Another instance of the object - - - The right operand - - - - - - - - - - - - - - Member access operator - - - Pointer to the current object - - - - - - - - - - - - Conversion to - A - - - A helper class - - - - - - - - - - - - Conversion to - Undoc - - - The object converted to - Undoc - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Less-than operator - - - true - if the left object is less than the right object, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Less-than-or-equal operator - - - true - if the left object is less than or equal to the right object, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Greater-than operator - - - true - if the left object is greater than the right object, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Greater-than-or-equal operator - - - true - if the left object is greater than or equal to the right object, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - - Three-way comparison operator - - - The relative order of the objects - - - The right operand - - - - - - - - - A fake output stream - - - - - - - - - - - - - - - - - - - - - - - - Stream insertion operator - - - Reference to the current output stream - - - An output stream - - - The object to output - - - - - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - The operand - - - - - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Less-than operator - - - true - if the left object is less than the right object, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Less-than-or-equal operator - - - true - if the left object is less than or equal to the right object, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Greater-than operator - - - true - if the left object is greater than the right object, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Greater-than-or-equal operator - - - true - if the left object is greater than or equal to the right object, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - - Three-way comparison operator - - - The relative order of the objects - - - The left operand - - - The right operand - - - - - diff --git a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.yml b/test-files/golden-tests/config/auto-function-metadata/returns-from-special.yml deleted file mode 100644 index 2bdf9b1c4..000000000 --- a/test-files/golden-tests/config/auto-function-metadata/returns-from-special.yml +++ /dev/null @@ -1 +0,0 @@ -auto-function-metadata: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/auto-relates.adoc b/test-files/golden-tests/config/auto-relates/auto-relates.adoc deleted file mode 100644 index 8897caa94..000000000 --- a/test-files/golden-tests/config/auto-relates/auto-relates.adoc +++ /dev/null @@ -1,162 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A class with non‐member functions -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of A -| link:#f2[`f2`] -| A non‐member function of A -| link:#f3[`f3`] -| A non‐member function of A -| link:#f4[`f4`] -| A non‐member function of A -| link:#f5[`f5`] -| A non‐member function of A -| link:#f6[`f6`] -| A non‐member function of A -|=== - -[#A] -== A - -A class with non‐member functions - -=== Synopsis - -Declared in `<auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class A; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of A -| link:#f2[`f2`] -| A non‐member function of A -| link:#f3[`f3`] -| A non‐member function of A -| link:#f4[`f4`] -| A non‐member function of A -| link:#f5[`f5`] -| A non‐member function of A -| link:#f6[`f6`] -| A non‐member function of A -|=== - -[#f1] -== f1 - -A non‐member function of A - -=== Synopsis - -Declared in `<auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1(link:#A[A]); ----- - -[#f2] -== f2 - -A non‐member function of A - -=== Synopsis - -Declared in `<auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f2(link:#A[A]&); ----- - -[#f3] -== f3 - -A non‐member function of A - -=== Synopsis - -Declared in `<auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f3(link:#A[A] const&); ----- - -[#f4] -== f4 - -A non‐member function of A - -=== Synopsis - -Declared in `<auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f4(link:#A[A]*); ----- - -[#f5] -== f5 - -A non‐member function of A - -=== Synopsis - -Declared in `<auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f5(link:#A[A] const*); ----- - -[#f6] -== f6 - -A non‐member function of A - -=== Synopsis - -Declared in `<auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f6(link:#A[A] const*); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-relates/auto-relates.cpp b/test-files/golden-tests/config/auto-relates/auto-relates.cpp deleted file mode 100644 index a0a168f1a..000000000 --- a/test-files/golden-tests/config/auto-relates/auto-relates.cpp +++ /dev/null @@ -1,27 +0,0 @@ -/** A class with non-member functions -*/ -class A {}; - -/** A non-member function of A - */ -void f1(A); - -/** A non-member function of A - */ -void f2(A&); - -/** A non-member function of A - */ -void f3(A const&); - -/** A non-member function of A - */ -void f4(A*); - -/** A non-member function of A - */ -void f5(A* const); - -/** A non-member function of A - */ -void f6(A const*); diff --git a/test-files/golden-tests/config/auto-relates/auto-relates.html b/test-files/golden-tests/config/auto-relates/auto-relates.html deleted file mode 100644 index fc7d27d70..000000000 --- a/test-files/golden-tests/config/auto-relates/auto-relates.html +++ /dev/null @@ -1,212 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
NameDescription
A A class with non-member functions
- -

Functions

- - - - - - - - - - - - - - - - -
NameDescription
f1 A non-member function of A
f2 A non-member function of A
f3 A non-member function of A
f4 A non-member function of A
f5 A non-member function of A
f6 A non-member function of A
- -
-
-
-

A

-
-A class with non-member functions - -
-
-
-

Synopsis

-
-Declared in <auto-relates.cpp>
-
-class A;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - - - - - - -
NameDescription
f1A non-member function of A
f2A non-member function of A
f3A non-member function of A
f4A non-member function of A
f5A non-member function of A
f6A non-member function of A
-
-
-
-
-

f1

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <auto-relates.cpp>
-
-void
-f1(A);
-
-
-
-
-
-
-
-

f2

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <auto-relates.cpp>
-
-void
-f2(A&);
-
-
-
-
-
-
-
-

f3

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <auto-relates.cpp>
-
-void
-f3(A const&);
-
-
-
-
-
-
-
-

f4

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <auto-relates.cpp>
-
-void
-f4(A*);
-
-
-
-
-
-
-
-

f5

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <auto-relates.cpp>
-
-void
-f5(A const*);
-
-
-
-
-
-
-
-

f6

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <auto-relates.cpp>
-
-void
-f6(A const*);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/auto-relates.xml b/test-files/golden-tests/config/auto-relates/auto-relates.xml deleted file mode 100644 index 3fe4f624f..000000000 --- a/test-files/golden-tests/config/auto-relates/auto-relates.xml +++ /dev/null @@ -1,116 +0,0 @@ - - - - - - - - A class with non-member functions - - - f1 - f2 - f3 - f4 - f5 - f6 - - - - - - - - - - - A non-member function of A - - - A - - - - - - - - - - - - - A non-member function of A - - - A - - - - - - - - - - - - - A non-member function of A - - - A - - - - - - - - - - - - - A non-member function of A - - - A - - - - - - - - - - - - - A non-member function of A - - - A - - - - - - - - - - - - - A non-member function of A - - - A - - - - - diff --git a/test-files/golden-tests/config/auto-relates/auto-relates.yml b/test-files/golden-tests/config/auto-relates/auto-relates.yml deleted file mode 100644 index 6244665d9..000000000 --- a/test-files/golden-tests/config/auto-relates/auto-relates.yml +++ /dev/null @@ -1 +0,0 @@ -auto-relates: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/derived.adoc b/test-files/golden-tests/config/auto-relates/derived.adoc deleted file mode 100644 index b1a101fc8..000000000 --- a/test-files/golden-tests/config/auto-relates/derived.adoc +++ /dev/null @@ -1,323 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A concrete implementation for ABase -| link:#ABase[`ABase`] -| A base class for non‐member functions -| link:#AView[`AView`] -| A view of A -| link:#AView2[`AView2`] -| Another view of A -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of ABase -| link:#f2[`f2`] -| A non‐member function of ABase -| link:#f3[`f3`] -| A non‐member function of ABase -| link:#f4[`f4`] -| A non‐member function of ABase -| link:#f5[`f5`] -| A non‐member function of ABase -| link:#n[`n`] -| A non‐member function of ABase only -|=== - -[#A] -== A - -A concrete implementation for ABase - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A - : link:#ABase[ABase] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#ABase[ABase]` -| A base class for non‐member functions -|=== - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of ABase -| link:#f2[`f2`] -| A non‐member function of ABase -| link:#f3[`f3`] -| A non‐member function of ABase -| link:#f4[`f4`] -| A non‐member function of ABase -| link:#f5[`f5`] -| A non‐member function of ABase -|=== - -[#ABase] -== ABase - -A base class for non‐member functions - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct ABase; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of ABase -| link:#f2[`f2`] -| A non‐member function of ABase -| link:#f3[`f3`] -| A non‐member function of ABase -| link:#f4[`f4`] -| A non‐member function of ABase -| link:#f5[`f5`] -| A non‐member function of ABase -| link:#n[`n`] -| A non‐member function of ABase only -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A concrete implementation for ABase -| link:#AView[`AView`] -| A view of A -|=== - -[#AView] -== AView - -A view of A - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct AView - : link:#ABase[ABase] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#ABase[ABase]` -| A base class for non‐member functions -|=== - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of ABase -| link:#f2[`f2`] -| A non‐member function of ABase -| link:#f3[`f3`] -| A non‐member function of ABase -| link:#f4[`f4`] -| A non‐member function of ABase -| link:#f5[`f5`] -| A non‐member function of ABase -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#AView2[`AView2`] -| Another view of A -|=== - -[#AView2] -== AView2 - -Another view of A - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct AView2 - : link:#AView[AView] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#AView[AView]` -| A view of A -|=== - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of ABase -| link:#f2[`f2`] -| A non‐member function of ABase -| link:#f3[`f3`] -| A non‐member function of ABase -| link:#f4[`f4`] -| A non‐member function of ABase -| link:#f5[`f5`] -| A non‐member function of ABase -|=== - -=== Description - -Used to test indirect derived classes - -[#f1] -== f1 - -A non‐member function of ABase - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1(link:#ABase[ABase] const&); ----- - -[#f2] -== f2 - -A non‐member function of ABase - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f2(link:#ABase[ABase]&); ----- - -[#f3] -== f3 - -A non‐member function of ABase - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f3(link:#ABase[ABase] const*); ----- - -[#f4] -== f4 - -A non‐member function of ABase - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f4(link:#ABase[ABase]*); ----- - -[#f5] -== f5 - -A non‐member function of ABase - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f5(link:#ABase[ABase] const*); ----- - -[#n] -== n - -A non‐member function of ABase only - -=== Synopsis - -Declared in `<derived.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -n(link:#ABase[ABase]); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-relates/derived.cpp b/test-files/golden-tests/config/auto-relates/derived.cpp deleted file mode 100644 index 341a0f16c..000000000 --- a/test-files/golden-tests/config/auto-relates/derived.cpp +++ /dev/null @@ -1,43 +0,0 @@ -/** A base class for non-member functions - */ -struct ABase {}; - -/** A concrete implementation for ABase - */ -struct A : ABase {}; - -/** A view of A - */ -struct AView : ABase {}; - -/** Another view of A - - Used to test indirect derived classes -*/ -struct AView2 : AView {}; - -/** A non-member function of ABase - */ -void f1(ABase const&); - -/** A non-member function of ABase - */ -void f2(ABase&); - -/** A non-member function of ABase - */ -void f3(ABase const*); - -/** A non-member function of ABase - */ -void f4(ABase*); - -/** A non-member function of ABase - */ -void f5(ABase* const); - -/** A non-member function of ABase only - */ -void n(ABase); - - diff --git a/test-files/golden-tests/config/auto-relates/derived.html b/test-files/golden-tests/config/auto-relates/derived.html deleted file mode 100644 index d4789cb95..000000000 --- a/test-files/golden-tests/config/auto-relates/derived.html +++ /dev/null @@ -1,413 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - -
NameDescription
A A concrete implementation for ABase
ABase A base class for non-member functions
AView A view of A
AView2 Another view of A
- -

Functions

- - - - - - - - - - - - - - - - -
NameDescription
f1 A non-member function of ABase
f2 A non-member function of ABase
f3 A non-member function of ABase
f4 A non-member function of ABase
f5 A non-member function of ABase
n A non-member function of ABase only
- -
-
-
-

A

-
-A concrete implementation for ABase - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-struct A
-    : ABase
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
ABaseA base class for non-member functions
-
- - -
-

Non-Member Functions

- - - - - - - - - - - - - - -
NameDescription
f1A non-member function of ABase
f2A non-member function of ABase
f3A non-member function of ABase
f4A non-member function of ABase
f5A non-member function of ABase
-
-
-
-
-

ABase

-
-A base class for non-member functions - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-struct ABase;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - - - - - - -
NameDescription
f1A non-member function of ABase
f2A non-member function of ABase
f3A non-member function of ABase
f4A non-member function of ABase
f5A non-member function of ABase
nA non-member function of ABase only
-
-
-

Derived Classes

- - - - - - - - - - - -
NameDescription
A - A concrete implementation for ABase
AView - A view of A
-
-
-
-
-

AView

-
-A view of A - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-struct AView
-    : ABase
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
ABaseA base class for non-member functions
-
- - -
-

Non-Member Functions

- - - - - - - - - - - - - - -
NameDescription
f1A non-member function of ABase
f2A non-member function of ABase
f3A non-member function of ABase
f4A non-member function of ABase
f5A non-member function of ABase
-
-
-

Derived Classes

- - - - - - - - - - -
NameDescription
AView2 - Another view of A
-
-
-
-
-

AView2

-
-Another view of A - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-struct AView2
-    : AView
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
AViewA view of A
-
- - -
-

Non-Member Functions

- - - - - - - - - - - - - - -
NameDescription
f1A non-member function of ABase
f2A non-member function of ABase
f3A non-member function of ABase
f4A non-member function of ABase
f5A non-member function of ABase
-
-
-

Description

-

Used to test indirect derived classes

-
-
-
-
-

f1

-
-A non-member function of ABase - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-void
-f1(ABase const&);
-
-
-
-
-
-
-
-

f2

-
-A non-member function of ABase - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-void
-f2(ABase&);
-
-
-
-
-
-
-
-

f3

-
-A non-member function of ABase - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-void
-f3(ABase const*);
-
-
-
-
-
-
-
-

f4

-
-A non-member function of ABase - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-void
-f4(ABase*);
-
-
-
-
-
-
-
-

f5

-
-A non-member function of ABase - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-void
-f5(ABase const*);
-
-
-
-
-
-
-
-

n

-
-A non-member function of ABase only - -
-
-
-

Synopsis

-
-Declared in <derived.cpp>
-
-void
-n(ABase);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/derived.xml b/test-files/golden-tests/config/auto-relates/derived.xml deleted file mode 100644 index 771e44d91..000000000 --- a/test-files/golden-tests/config/auto-relates/derived.xml +++ /dev/null @@ -1,188 +0,0 @@ - - - - - - - - - - - A concrete implementation for ABase - - - f1 - f2 - f3 - f4 - f5 - - - - - - - - A base class for non-member functions - - - f1 - f2 - f3 - f4 - f5 - n - - - - - - - - - - - A view of A - - - f1 - f2 - f3 - f4 - f5 - - - - - - - - - - - Another view of A - - - Used to test indirect derived classes - - - f1 - f2 - f3 - f4 - f5 - - - - - - - - - - - - - A non-member function of ABase - - - A - ABase - AView - AView2 - - - - - - - - - - - - - A non-member function of ABase - - - A - ABase - AView - AView2 - - - - - - - - - - - - - A non-member function of ABase - - - A - ABase - AView - AView2 - - - - - - - - - - - - - A non-member function of ABase - - - A - ABase - AView - AView2 - - - - - - - - - - - - - A non-member function of ABase - - - A - ABase - AView - AView2 - - - - - - - - - - - A non-member function of ABase only - - - ABase - - - - - diff --git a/test-files/golden-tests/config/auto-relates/derived.yml b/test-files/golden-tests/config/auto-relates/derived.yml deleted file mode 100644 index 6244665d9..000000000 --- a/test-files/golden-tests/config/auto-relates/derived.yml +++ /dev/null @@ -1 +0,0 @@ -auto-relates: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/enum.adoc b/test-files/golden-tests/config/auto-relates/enum.adoc deleted file mode 100644 index a24ed2e68..000000000 --- a/test-files/golden-tests/config/auto-relates/enum.adoc +++ /dev/null @@ -1,181 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#Result[`Result`] -| Helper result class -| link:#SmallVector[`SmallVector`] -| Helper result class -|=== - -=== Enums - -[cols=2] -|=== -| Name -| Description -| link:#E[`E`] -| An enum with non‐member functions -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#makeE[`makeE`] -| Function that returns A -| link:#makeEs[`makeEs`] -| Function that returns template on A -| link:#tryMakeE[`tryMakeE`] -| Function that returns template on A -|=== - -[#Result] -== Result - -Helper result class - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -class Result; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#tryMakeE[`tryMakeE`] -| Function that returns template on A -|=== - -[#SmallVector] -== SmallVector - -Helper result class - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - unsigned long N> -class SmallVector; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#makeEs[`makeEs`] -| Function that returns template on A -|=== - -[#E] -== E - -An enum with non‐member functions - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -enum class E : int; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#makeE[`makeE`] -| Function that returns A -| link:#makeEs[`makeEs`] -| Function that returns template on A -| link:#tryMakeE[`tryMakeE`] -| Function that returns template on A -|=== - -[#makeE] -== makeE - -Function that returns A - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#E[E] -makeE(); ----- - -=== Return Value - -An instance of A - -[#makeEs] -== makeEs - -Function that returns template on A - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#SmallVector[SmallVector<E, 3>] -makeEs(); ----- - -=== Return Value - -A vector of As - -[#tryMakeE] -== tryMakeE - -Function that returns template on A - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Result[Result<E>] -tryMakeE(); ----- - -=== Return Value - -An instance of A or an error - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-relates/enum.cpp b/test-files/golden-tests/config/auto-relates/enum.cpp deleted file mode 100644 index 39ca2348a..000000000 --- a/test-files/golden-tests/config/auto-relates/enum.cpp +++ /dev/null @@ -1,32 +0,0 @@ -/** An enum with non-member functions - */ -enum class E {}; - -/** Helper result class - */ -template -class Result {}; - -/** Helper result class - */ -template -class SmallVector {}; - -/** Function that returns A - - @return An instance of A - */ -E makeE(); - -/** Function that returns template on A - - @return An instance of A or an error - */ -Result tryMakeE(); - -/** Function that returns template on A - - @return A vector of As - */ -SmallVector makeEs(); - diff --git a/test-files/golden-tests/config/auto-relates/enum.html b/test-files/golden-tests/config/auto-relates/enum.html deleted file mode 100644 index 3cab62b65..000000000 --- a/test-files/golden-tests/config/auto-relates/enum.html +++ /dev/null @@ -1,258 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - -
NameDescription
Result Helper result class
SmallVector Helper result class
- -

Enums

- - - - - - - - - - - -
NameDescription
E An enum with non-member functions
- -

Functions

- - - - - - - - - - - - - -
NameDescription
makeE Function that returns A
makeEs Function that returns template on A
tryMakeE Function that returns template on A
- -
-
-
-

Result

-
-Helper result class - -
-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-template<class T>
-class Result;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - -
NameDescription
tryMakeEFunction that returns template on A
-
-
-
-
-

SmallVector

-
-Helper result class - -
-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-template<
-    class T,
-    unsigned long N>
-class SmallVector;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - -
NameDescription
makeEsFunction that returns template on A
-
-
-
-
-

E

-
-An enum with non-member functions - -
-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-enum class E : int;
-
-
-
-
-
-

Members

- - - - - - - - - -
NameDescription
-
-
-

Non-Member Functions

- - - - - - - - - - - - -
NameDescription
makeEFunction that returns A
makeEsFunction that returns template on A
tryMakeEFunction that returns template on A
-
-
-
-
-

makeE

-
-Function that returns A - -
-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-E
-makeE();
-
-
-
-
-
-

Return Value

-An instance of A -
-
-
-
-

makeEs

-
-Function that returns template on A - -
-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-SmallVector<E, 3>
-makeEs();
-
-
-
-
-
-

Return Value

-A vector of As -
-
-
-
-

tryMakeE

-
-Function that returns template on A - -
-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-Result<E>
-tryMakeE();
-
-
-
-
-
-

Return Value

-An instance of A or an error -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/enum.xml b/test-files/golden-tests/config/auto-relates/enum.xml deleted file mode 100644 index 5667f16fc..000000000 --- a/test-files/golden-tests/config/auto-relates/enum.xml +++ /dev/null @@ -1,104 +0,0 @@ - - - - - - - - - - - - - An enum with non-member functions - - - makeE - makeEs - tryMakeE - - - - - - - - - - - Function that returns A - - - An instance of A - - - E - - - - - - - - - - - Function that returns template on A - - - A vector of As - - - E - SmallVector - - - - - - - - - - - Function that returns template on A - - - An instance of A or an error - - - E - Result - - - - - diff --git a/test-files/golden-tests/config/auto-relates/enum.yml b/test-files/golden-tests/config/auto-relates/enum.yml deleted file mode 100644 index 6244665d9..000000000 --- a/test-files/golden-tests/config/auto-relates/enum.yml +++ /dev/null @@ -1 +0,0 @@ -auto-relates: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/no-auto-relates.adoc b/test-files/golden-tests/config/auto-relates/no-auto-relates.adoc deleted file mode 100644 index 2b0e76b16..000000000 --- a/test-files/golden-tests/config/auto-relates/no-auto-relates.adoc +++ /dev/null @@ -1,142 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A class with non‐member functions -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of A -| link:#f2[`f2`] -| A non‐member function of A -| link:#f3[`f3`] -| A non‐member function of A -| link:#f4[`f4`] -| A non‐member function of A -| link:#f5[`f5`] -| A non‐member function of A -| link:#f6[`f6`] -| A non‐member function of A -|=== - -[#A] -== A - -A class with non‐member functions - -=== Synopsis - -Declared in `<no‐auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class A; ----- - -[#f1] -== f1 - -A non‐member function of A - -=== Synopsis - -Declared in `<no‐auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1(link:#A[A]); ----- - -[#f2] -== f2 - -A non‐member function of A - -=== Synopsis - -Declared in `<no‐auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f2(link:#A[A]&); ----- - -[#f3] -== f3 - -A non‐member function of A - -=== Synopsis - -Declared in `<no‐auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f3(link:#A[A] const&); ----- - -[#f4] -== f4 - -A non‐member function of A - -=== Synopsis - -Declared in `<no‐auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f4(link:#A[A]*); ----- - -[#f5] -== f5 - -A non‐member function of A - -=== Synopsis - -Declared in `<no‐auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f5(link:#A[A] const*); ----- - -[#f6] -== f6 - -A non‐member function of A - -=== Synopsis - -Declared in `<no‐auto‐relates.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f6(link:#A[A] const*); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-relates/no-auto-relates.cpp b/test-files/golden-tests/config/auto-relates/no-auto-relates.cpp deleted file mode 100644 index a0a168f1a..000000000 --- a/test-files/golden-tests/config/auto-relates/no-auto-relates.cpp +++ /dev/null @@ -1,27 +0,0 @@ -/** A class with non-member functions -*/ -class A {}; - -/** A non-member function of A - */ -void f1(A); - -/** A non-member function of A - */ -void f2(A&); - -/** A non-member function of A - */ -void f3(A const&); - -/** A non-member function of A - */ -void f4(A*); - -/** A non-member function of A - */ -void f5(A* const); - -/** A non-member function of A - */ -void f6(A const*); diff --git a/test-files/golden-tests/config/auto-relates/no-auto-relates.html b/test-files/golden-tests/config/auto-relates/no-auto-relates.html deleted file mode 100644 index 53634c315..000000000 --- a/test-files/golden-tests/config/auto-relates/no-auto-relates.html +++ /dev/null @@ -1,193 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
NameDescription
A A class with non-member functions
- -

Functions

- - - - - - - - - - - - - - - - -
NameDescription
f1 A non-member function of A
f2 A non-member function of A
f3 A non-member function of A
f4 A non-member function of A
f5 A non-member function of A
f6 A non-member function of A
- -
-
-
-

A

-
-A class with non-member functions - -
-
-
-

Synopsis

-
-Declared in <no-auto-relates.cpp>
-
-class A;
-
-
-
-
- - -
-
-
-

f1

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <no-auto-relates.cpp>
-
-void
-f1(A);
-
-
-
-
-
-
-
-

f2

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <no-auto-relates.cpp>
-
-void
-f2(A&);
-
-
-
-
-
-
-
-

f3

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <no-auto-relates.cpp>
-
-void
-f3(A const&);
-
-
-
-
-
-
-
-

f4

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <no-auto-relates.cpp>
-
-void
-f4(A*);
-
-
-
-
-
-
-
-

f5

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <no-auto-relates.cpp>
-
-void
-f5(A const*);
-
-
-
-
-
-
-
-

f6

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <no-auto-relates.cpp>
-
-void
-f6(A const*);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/no-auto-relates.xml b/test-files/golden-tests/config/auto-relates/no-auto-relates.xml deleted file mode 100644 index 9b85a05bb..000000000 --- a/test-files/golden-tests/config/auto-relates/no-auto-relates.xml +++ /dev/null @@ -1,90 +0,0 @@ - - - - - - - - A class with non-member functions - - - - - - - - - - - A non-member function of A - - - - - - - - - - - - - A non-member function of A - - - - - - - - - - - - - A non-member function of A - - - - - - - - - - - - - A non-member function of A - - - - - - - - - - - - - A non-member function of A - - - - - - - - - - - - - A non-member function of A - - - - - diff --git a/test-files/golden-tests/config/auto-relates/no-auto-relates.yml b/test-files/golden-tests/config/auto-relates/no-auto-relates.yml deleted file mode 100644 index 362565607..000000000 --- a/test-files/golden-tests/config/auto-relates/no-auto-relates.yml +++ /dev/null @@ -1 +0,0 @@ -auto-relates: false \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/qualified.adoc b/test-files/golden-tests/config/auto-relates/qualified.adoc deleted file mode 100644 index 354b1c014..000000000 --- a/test-files/golden-tests/config/auto-relates/qualified.adoc +++ /dev/null @@ -1,244 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#N[`N`] -| link:#O[`O`] -|=== - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A class with non‐member functions -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of A -| link:#f5[`f5`] -| A non‐member function of ::N::B -|=== - -[#N] -== N - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#N-M[`M`] -|=== - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#N-B[`B`] -| A nested class with non‐member functions -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#N-f2[`f2`] -| A non‐member function of A -| link:#N-f3[`f3`] -| A non‐member function of B -|=== - -[#N-M] -== link:#N[N]::M - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#N-M-f4[`f4`] -| A non‐member function of ::N::B -|=== - -[#N-M-f4] -== link:#N[N]::link:#N-M[M]::f4 - -A non‐member function of ::N::B - -=== Synopsis - -Declared in `<qualified.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f4(link:#N-B[N::B] const&); ----- - -[#N-B] -== link:#N[N]::B - -A nested class with non‐member functions - -=== Synopsis - -Declared in `<qualified.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct B; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#N-f3[`f3`] -| A non‐member function of B -| link:#N-M-f4[`M::f4`] -| A non‐member function of ::N::B -| link:#f5[`::f5`] -| A non‐member function of ::N::B -| link:#O-f6[`::O::f6`] -| A non‐member function of ::N::B -|=== - -[#N-f2] -== link:#N[N]::f2 - -A non‐member function of A - -=== Synopsis - -Declared in `<qualified.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f2(link:#A[A]&); ----- - -[#N-f3] -== link:#N[N]::f3 - -A non‐member function of B - -=== Synopsis - -Declared in `<qualified.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f3(link:#N-B[N::B] const&); ----- - -[#O] -== O - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#O-f6[`f6`] -| A non‐member function of ::N::B -|=== - -[#O-f6] -== link:#O[O]::f6 - -A non‐member function of ::N::B - -=== Synopsis - -Declared in `<qualified.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f6(link:#N-B[N::B] const&); ----- - -[#A] -== A - -A class with non‐member functions - -=== Synopsis - -Declared in `<qualified.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#f1[`f1`] -| A non‐member function of A -| link:#N-f2[`N::f2`] -| A non‐member function of A -|=== - -[#f1] -== f1 - -A non‐member function of A - -=== Synopsis - -Declared in `<qualified.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1(link:#A[A] const&); ----- - -[#f5] -== f5 - -A non‐member function of ::N::B - -=== Synopsis - -Declared in `<qualified.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f5(link:#N-B[N::B] const&); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-relates/qualified.cpp b/test-files/golden-tests/config/auto-relates/qualified.cpp deleted file mode 100644 index d737e41ef..000000000 --- a/test-files/golden-tests/config/auto-relates/qualified.cpp +++ /dev/null @@ -1,37 +0,0 @@ -/** A class with non-member functions - */ -struct A {}; - -/** A non-member function of A - */ -void f1(A const&); - -namespace N { - /** A non-member function of A - */ - void f2(A&); - - /** A nested class with non-member functions - */ - struct B {}; - - /** A non-member function of B - */ - void f3(::N::B const&); - - namespace M { - /** A non-member function of ::N::B - */ - void f4(::N::B const&); - } -} - -/** A non-member function of ::N::B - */ -void f5(::N::B const&); - -namespace O { - /** A non-member function of ::N::B - */ - void f6(::N::B const&); -} \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/qualified.html b/test-files/golden-tests/config/auto-relates/qualified.html deleted file mode 100644 index 7accb4138..000000000 --- a/test-files/golden-tests/config/auto-relates/qualified.html +++ /dev/null @@ -1,341 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - - -
Name
N
O
- -

Types

- - - - - - - - - - - -
NameDescription
A A class with non-member functions
- -

Functions

- - - - - - - - - - - - -
NameDescription
f1 A non-member function of A
f5 A non-member function of ::N::B
- -
-
-
-

N

-
-

Namespaces

- - - - - - - - - - -
Name
M
- -

Types

- - - - - - - - - - - -
NameDescription
B A nested class with non-member functions
- -

Functions

- - - - - - - - - - - - -
NameDescription
f2 A non-member function of A
f3 A non-member function of B
- -
-
-
-

N::M

-
-

Functions

- - - - - - - - - - - -
NameDescription
f4 A non-member function of ::N::B
- -
-
-
-

N::M::f4

-
-A non-member function of ::N::B - -
-
-
-

Synopsis

-
-Declared in <qualified.cpp>
-
-void
-f4(N::B const&);
-
-
-
-
-
-
-
-

N::B

-
-A nested class with non-member functions - -
-
-
-

Synopsis

-
-Declared in <qualified.cpp>
-
-struct B;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - - - - -
NameDescription
f3A non-member function of B
M::f4A non-member function of ::N::B
::f5A non-member function of ::N::B
::O::f6A non-member function of ::N::B
-
-
-
-
-

N::f2

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <qualified.cpp>
-
-void
-f2(A&);
-
-
-
-
-
-
-
-

N::f3

-
-A non-member function of B - -
-
-
-

Synopsis

-
-Declared in <qualified.cpp>
-
-void
-f3(N::B const&);
-
-
-
-
-
-
-
-

O

-
-

Functions

- - - - - - - - - - - -
NameDescription
f6 A non-member function of ::N::B
- -
-
-
-

O::f6

-
-A non-member function of ::N::B - -
-
-
-

Synopsis

-
-Declared in <qualified.cpp>
-
-void
-f6(N::B const&);
-
-
-
-
-
-
-
-

A

-
-A class with non-member functions - -
-
-
-

Synopsis

-
-Declared in <qualified.cpp>
-
-struct A;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - - -
NameDescription
f1A non-member function of A
N::f2A non-member function of A
-
-
-
-
-

f1

-
-A non-member function of A - -
-
-
-

Synopsis

-
-Declared in <qualified.cpp>
-
-void
-f1(A const&);
-
-
-
-
-
-
-
-

f5

-
-A non-member function of ::N::B - -
-
-
-

Synopsis

-
-Declared in <qualified.cpp>
-
-void
-f5(N::B const&);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/qualified.xml b/test-files/golden-tests/config/auto-relates/qualified.xml deleted file mode 100644 index c510ae982..000000000 --- a/test-files/golden-tests/config/auto-relates/qualified.xml +++ /dev/null @@ -1,134 +0,0 @@ - - - - - - - - - - - - - - - A non-member function of ::N::B - - - B - - - - - - - - - A nested class with non-member functions - - - f3 - M::f4 - ::f5 - ::O::f6 - - - - - - - - - - - - - A non-member function of A - - - A - - - - - - - - - - - - - A non-member function of B - - - B - - - - - - - - - - - - - - - A non-member function of ::N::B - - - B - - - - - - - - - A class with non-member functions - - - f1 - N::f2 - - - - - - - - - - - - - A non-member function of A - - - A - - - - - - - - - - - - - A non-member function of ::N::B - - - B - - - - - diff --git a/test-files/golden-tests/config/auto-relates/qualified.yml b/test-files/golden-tests/config/auto-relates/qualified.yml deleted file mode 100644 index 6244665d9..000000000 --- a/test-files/golden-tests/config/auto-relates/qualified.yml +++ /dev/null @@ -1 +0,0 @@ -auto-relates: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/remove-friend.adoc b/test-files/golden-tests/config/auto-relates/remove-friend.adoc deleted file mode 100644 index 2dc687683..000000000 --- a/test-files/golden-tests/config/auto-relates/remove-friend.adoc +++ /dev/null @@ -1,130 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A record with non‐member functions -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#to_string[`to_string`] -| Non‐member function of A -| link:#operator_eq[`operator==`] -| Friend function not listed as non‐member -|=== - -[#A] -== A - -A record with non‐member functions - -=== Synopsis - -Declared in `<remove‐friend.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class A; ----- - -=== Friends - -[cols=2] -|=== -| Name -| Description -| `link:#operator_eq[operator==]` -| Friend function not listed as non‐member -|=== - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#to_string[`to_string`] -| Non‐member function of A -|=== - -[#to_string] -== to_string - -Non‐member function of A - -=== Synopsis - -Declared in `<remove‐friend.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char const* -to_string(link:#A[A] const& a); ----- - -=== Return Value - -The string representation of the object - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *a* -| The object to stringify -|=== - -[#operator_eq] -== operator== - -Friend function not listed as non‐member - -=== Synopsis - -Declared in `<remove‐friend.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Description - -Friends are already listed in the class definition. - -=== Return Value - -`true` if the objects are equal - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left‐hand side of the comparison -| *rhs* -| The right‐hand side of the comparison -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-relates/remove-friend.cpp b/test-files/golden-tests/config/auto-relates/remove-friend.cpp deleted file mode 100644 index 18674408a..000000000 --- a/test-files/golden-tests/config/auto-relates/remove-friend.cpp +++ /dev/null @@ -1,24 +0,0 @@ -/** A record with non-member functions - */ -class A { -public: - /** Friend function not listed as non-member - - Friends are already listed in the class definition. - - @param lhs The left-hand side of the comparison - @param rhs The right-hand side of the comparison - @return `true` if the objects are equal - */ - friend - bool - operator==(A const& lhs, A const& rhs); -}; - -/** Non-member function of A - - @param a The object to stringify - @return The string representation of the object - */ -char const* -to_string(A const& a); \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/remove-friend.html b/test-files/golden-tests/config/auto-relates/remove-friend.html deleted file mode 100644 index 241554ef4..000000000 --- a/test-files/golden-tests/config/auto-relates/remove-friend.html +++ /dev/null @@ -1,193 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
NameDescription
A A record with non-member functions
- -

Functions

- - - - - - - - - - - - -
NameDescription
to_string Non-member function of A
operator== Friend function not listed as non-member
- -
-
-
-

A

-
-A record with non-member functions - -
-
-
-

Synopsis

-
-Declared in <remove-friend.cpp>
-
-class A;
-
-
-
-
- - -
-

Friends

- - - - - - - - - - - - -|=== - -
NameDescription
operator==Friend function not listed as non-member
-
-
-

Non-Member Functions

- - - - - - - - - - -
NameDescription
to_stringNon-member function of A
-
-
-
-
-

to_string

-
-Non-member function of A - -
-
-
-

Synopsis

-
-Declared in <remove-friend.cpp>
-
-char const*
-to_string(A const& a);
-
-
-
-
-
-

Return Value

-The string representation of the object -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
aThe object to stringify
-
-
-
-
-

operator==

-
-Friend function not listed as non-member - -
-
-
-

Synopsis

-
-Declared in <remove-friend.cpp>
-
-bool
-operator==(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Description

-

Friends are already listed in the class definition.

-
-
-

Return Value

-true if the objects are equal -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left-hand side of the comparison
rhsThe right-hand side of the comparison
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/remove-friend.xml b/test-files/golden-tests/config/auto-relates/remove-friend.xml deleted file mode 100644 index f5c8163f5..000000000 --- a/test-files/golden-tests/config/auto-relates/remove-friend.xml +++ /dev/null @@ -1,82 +0,0 @@ - - - - - - - - - - - A record with non-member functions - - - to_string - - - - - - - - - - - - - - - - - - Non-member function of A - - - The string representation of the object - - - The object to stringify - - - A - - - - - - - - - - - - - - - - - - - - - - Friend function not listed as non-member - - - Friends are already listed in the class definition. - - - true - if the objects are equal - - - The left-hand side of the comparison - - - The right-hand side of the comparison - - - - - diff --git a/test-files/golden-tests/config/auto-relates/remove-friend.yml b/test-files/golden-tests/config/auto-relates/remove-friend.yml deleted file mode 100644 index 6244665d9..000000000 --- a/test-files/golden-tests/config/auto-relates/remove-friend.yml +++ /dev/null @@ -1 +0,0 @@ -auto-relates: true \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/return-type.adoc b/test-files/golden-tests/config/auto-relates/return-type.adoc deleted file mode 100644 index 93d2191ba..000000000 --- a/test-files/golden-tests/config/auto-relates/return-type.adoc +++ /dev/null @@ -1,173 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| A class with non‐member functions -| link:#Result[`Result`] -| Helper result class -| link:#SmallVector[`SmallVector`] -| Helper result class -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#makeA[`makeA`] -| Function that returns A -| link:#makeAs[`makeAs`] -| Function that returns template on A -| link:#tryMakeA[`tryMakeA`] -| Function that returns template on A -|=== - -[#A] -== A - -A class with non‐member functions - -=== Synopsis - -Declared in `<return‐type.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class A; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#makeA[`makeA`] -| Function that returns A -| link:#makeAs[`makeAs`] -| Function that returns template on A -| link:#tryMakeA[`tryMakeA`] -| Function that returns template on A -|=== - -[#Result] -== Result - -Helper result class - -=== Synopsis - -Declared in `<return‐type.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -class Result; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#tryMakeA[`tryMakeA`] -| Function that returns template on A -|=== - -[#SmallVector] -== SmallVector - -Helper result class - -=== Synopsis - -Declared in `<return‐type.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - unsigned long N> -class SmallVector; ----- - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#makeAs[`makeAs`] -| Function that returns template on A -|=== - -[#makeA] -== makeA - -Function that returns A - -=== Synopsis - -Declared in `<return‐type.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#A[A] -makeA(); ----- - -=== Return Value - -An instance of A - -[#makeAs] -== makeAs - -Function that returns template on A - -=== Synopsis - -Declared in `<return‐type.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#SmallVector[SmallVector<A, 3>] -makeAs(); ----- - -=== Return Value - -A vector of As - -[#tryMakeA] -== tryMakeA - -Function that returns template on A - -=== Synopsis - -Declared in `<return‐type.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Result[Result<A>] -tryMakeA(); ----- - -=== Return Value - -An instance of A or an error - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/auto-relates/return-type.cpp b/test-files/golden-tests/config/auto-relates/return-type.cpp deleted file mode 100644 index 46c5eda02..000000000 --- a/test-files/golden-tests/config/auto-relates/return-type.cpp +++ /dev/null @@ -1,32 +0,0 @@ -/** A class with non-member functions - */ -class A {}; - -/** Helper result class - */ -template -class Result {}; - -/** Helper result class - */ -template -class SmallVector {}; - -/** Function that returns A - - @return An instance of A - */ -A makeA(); - -/** Function that returns template on A - - @return An instance of A or an error - */ -Result tryMakeA(); - -/** Function that returns template on A - - @return A vector of As - */ -SmallVector makeAs(); - diff --git a/test-files/golden-tests/config/auto-relates/return-type.html b/test-files/golden-tests/config/auto-relates/return-type.html deleted file mode 100644 index 5144ec6fb..000000000 --- a/test-files/golden-tests/config/auto-relates/return-type.html +++ /dev/null @@ -1,234 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - -
NameDescription
A A class with non-member functions
Result Helper result class
SmallVector Helper result class
- -

Functions

- - - - - - - - - - - - - -
NameDescription
makeA Function that returns A
makeAs Function that returns template on A
tryMakeA Function that returns template on A
- -
-
-
-

A

-
-A class with non-member functions - -
-
-
-

Synopsis

-
-Declared in <return-type.cpp>
-
-class A;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - - - -
NameDescription
makeAFunction that returns A
makeAsFunction that returns template on A
tryMakeAFunction that returns template on A
-
-
-
-
-

Result

-
-Helper result class - -
-
-
-

Synopsis

-
-Declared in <return-type.cpp>
-
-template<class T>
-class Result;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - -
NameDescription
tryMakeAFunction that returns template on A
-
-
-
-
-

SmallVector

-
-Helper result class - -
-
-
-

Synopsis

-
-Declared in <return-type.cpp>
-
-template<
-    class T,
-    unsigned long N>
-class SmallVector;
-
-
-
-
- - -
-

Non-Member Functions

- - - - - - - - - - -
NameDescription
makeAsFunction that returns template on A
-
-
-
-
-

makeA

-
-Function that returns A - -
-
-
-

Synopsis

-
-Declared in <return-type.cpp>
-
-A
-makeA();
-
-
-
-
-
-

Return Value

-An instance of A -
-
-
-
-

makeAs

-
-Function that returns template on A - -
-
-
-

Synopsis

-
-Declared in <return-type.cpp>
-
-SmallVector<A, 3>
-makeAs();
-
-
-
-
-
-

Return Value

-A vector of As -
-
-
-
-

tryMakeA

-
-Function that returns template on A - -
-
-
-

Synopsis

-
-Declared in <return-type.cpp>
-
-Result<A>
-tryMakeA();
-
-
-
-
-
-

Return Value

-An instance of A or an error -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/auto-relates/return-type.xml b/test-files/golden-tests/config/auto-relates/return-type.xml deleted file mode 100644 index 28170572e..000000000 --- a/test-files/golden-tests/config/auto-relates/return-type.xml +++ /dev/null @@ -1,101 +0,0 @@ - - - - - - - - A class with non-member functions - - - makeA - makeAs - tryMakeA - - - - - - - - - - - - - Function that returns A - - - An instance of A - - - A - - - - - - - - - - - Function that returns template on A - - - A vector of As - - - A - SmallVector - - - - - - - - - - - Function that returns template on A - - - An instance of A or an error - - - A - Result - - - - - diff --git a/test-files/golden-tests/config/auto-relates/return-type.yml b/test-files/golden-tests/config/auto-relates/return-type.yml deleted file mode 100644 index 6244665d9..000000000 --- a/test-files/golden-tests/config/auto-relates/return-type.yml +++ /dev/null @@ -1 +0,0 @@ -auto-relates: true \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-all/no-extract-all.adoc b/test-files/golden-tests/config/extract-all/no-extract-all.adoc deleted file mode 100644 index 99127f68b..000000000 --- a/test-files/golden-tests/config/extract-all/no-extract-all.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#docFunction[`docFunction`] -| Documented function -| link:#sometimesDocFunction[`sometimesDocFunction`] -| Sometimes documented function -|=== - -[#docFunction] -== docFunction - -Documented function - -=== Synopsis - -Declared in `<no‐extract‐all.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -docFunction(); ----- - -[#sometimesDocFunction] -== sometimesDocFunction - -Sometimes documented function - -=== Synopsis - -Declared in `<no‐extract‐all.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -sometimesDocFunction(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-all/no-extract-all.cpp b/test-files/golden-tests/config/extract-all/no-extract-all.cpp deleted file mode 100644 index 190a91ff9..000000000 --- a/test-files/golden-tests/config/extract-all/no-extract-all.cpp +++ /dev/null @@ -1,9 +0,0 @@ -void undocFunction(); - -/// Documented function -void docFunction(); - -void sometimesDocFunction(); - -/// Sometimes documented function -void sometimesDocFunction(); \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-all/no-extract-all.html b/test-files/golden-tests/config/extract-all/no-extract-all.html deleted file mode 100644 index c3cc86fa6..000000000 --- a/test-files/golden-tests/config/extract-all/no-extract-all.html +++ /dev/null @@ -1,74 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - - -
NameDescription
docFunction Documented function
sometimesDocFunction Sometimes documented function
- -
-
-
-

docFunction

-
-Documented function - -
-
-
-

Synopsis

-
-Declared in <no-extract-all.cpp>
-
-void
-docFunction();
-
-
-
-
-
-
-
-

sometimesDocFunction

-
-Sometimes documented function - -
-
-
-

Synopsis

-
-Declared in <no-extract-all.cpp>
-
-void
-sometimesDocFunction();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-all/no-extract-all.xml b/test-files/golden-tests/config/extract-all/no-extract-all.xml deleted file mode 100644 index b376d1ac2..000000000 --- a/test-files/golden-tests/config/extract-all/no-extract-all.xml +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - Documented function - - - - - - - - Sometimes documented function - - - - - diff --git a/test-files/golden-tests/config/extract-all/no-extract-all.yml b/test-files/golden-tests/config/extract-all/no-extract-all.yml deleted file mode 100644 index f5fd13a70..000000000 --- a/test-files/golden-tests/config/extract-all/no-extract-all.yml +++ /dev/null @@ -1,2 +0,0 @@ -extract-all: false -warn-if-undocumented: false \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.adoc b/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.adoc deleted file mode 100644 index f1c9a99fb..000000000 --- a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.adoc +++ /dev/null @@ -1,207 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=2] -|=== -| Name -| Description -| link:#documented_ns[`documented_ns`] -| Namespace documentation -| link:#mixed_ns[`mixed_ns`] -| Should decay to see‐below -| link:#mixed_regular_ns[`mixed_regular_ns`] -| Should decay to regular -| link:#regular_ns[`regular_ns`] -| Regular namespace -| link:#see_below_ns[`see_below_ns`] -| Should decay to see‐below -|=== - -=== Namespace Aliases - -[cols=2] -|=== -| Name -| Description -| link:#empty_ns_alias[`empty_ns_alias`] -| Should still work -| link:#regular_ns_alias[`regular_ns_alias`] -| Should work -|=== - -=== Using Namespace Directives - -[cols=1] -|=== -| Name -| link:#regular_ns[`regular_ns`] -| empty_ns -|=== - - -[#documented_ns] -== documented_ns - -Namespace documentation - -[#mixed_ns] -== mixed_ns - -Should decay to see‐below - -=== Types - -[cols=1] -|=== -| Name -| link:#mixed_ns-SeeBelowStructA[`SeeBelowStructA`] -|=== - -[#mixed_ns-SeeBelowStructA] -== link:#mixed_ns[mixed_ns]::SeeBelowStructA - -=== Synopsis - -Declared in `<no‐extract‐empty‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct SeeBelowStructA { /* see-below */ }; ----- - -[#mixed_regular_ns] -== mixed_regular_ns - -Should decay to regular - -=== Types - -[cols=1] -|=== -| Name -| link:#mixed_regular_ns-RegularStructA[`RegularStructA`] -| link:#mixed_regular_ns-SeeBelowStructB[`SeeBelowStructB`] -|=== - -[#mixed_regular_ns-RegularStructA] -== link:#mixed_regular_ns[mixed_regular_ns]::RegularStructA - -=== Synopsis - -Declared in `<no‐extract‐empty‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct RegularStructA; ----- - -[#mixed_regular_ns-SeeBelowStructB] -== link:#mixed_regular_ns[mixed_regular_ns]::SeeBelowStructB - -=== Synopsis - -Declared in `<no‐extract‐empty‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct SeeBelowStructB { /* see-below */ }; ----- - -[#regular_ns] -== regular_ns - -Regular namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#regular_ns-A[`A`] -|=== - -[#regular_ns-A] -== link:#regular_ns[regular_ns]::A - -=== Synopsis - -Declared in `<no‐extract‐empty‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#see_below_ns] -== see_below_ns - -Should decay to see‐below - -=== Types - -[cols=1] -|=== -| Name -| link:#see_below_ns-SeeBelowStructA[`SeeBelowStructA`] -| link:#see_below_ns-SeeBelowStructB[`SeeBelowStructB`] -|=== - -[#see_below_ns-SeeBelowStructA] -== link:#see_below_ns[see_below_ns]::SeeBelowStructA - -=== Synopsis - -Declared in `<no‐extract‐empty‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct SeeBelowStructA { /* see-below */ }; ----- - -[#see_below_ns-SeeBelowStructB] -== link:#see_below_ns[see_below_ns]::SeeBelowStructB - -=== Synopsis - -Declared in `<no‐extract‐empty‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct SeeBelowStructB { /* see-below */ }; ----- - -[#empty_ns_alias] -== empty_ns_alias - -Should still work - -=== Synopsis - -Declared in `<no‐extract‐empty‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -namespace empty_ns_alias = empty_ns; ----- - -[#regular_ns_alias] -== regular_ns_alias - -Should work - -=== Synopsis - -Declared in `<no‐extract‐empty‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -namespace regular_ns_alias = link:#regular_ns[regular_ns]; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.cpp b/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.cpp deleted file mode 100644 index 6ac3b2ac6..000000000 --- a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.cpp +++ /dev/null @@ -1,53 +0,0 @@ -namespace empty_ns {} - -// Symbols are excluded so the namespace should also be excluded -namespace excluded_members_ns { - struct ExcludedStructA {}; - struct ExcludedStructB {}; -} - -/// Regular namespace -namespace regular_ns { - struct A {}; -} - -/// Namespace documentation -namespace documented_ns {} - -/// Should decay to see-below -namespace see_below_ns { - struct SeeBelowStructA {}; - struct SeeBelowStructB {}; -} - -/// Should decay to implementation-defined -namespace implementation_defined_ns { - struct ImplementationDefinedStructA {}; - struct ImplementationDefinedStructB {}; -} - -/// Should decay to see-below -namespace mixed_ns { - struct SeeBelowStructA {}; - struct ImplementationDefinedStructB {}; -} - -/// Should decay to regular -namespace mixed_regular_ns { - struct RegularStructA {}; - struct SeeBelowStructB {}; - struct ImplementationDefinedStructC {}; -} - -/// Should work -using namespace regular_ns; - -/// Should work -namespace regular_ns_alias = regular_ns; - -/// Should work -using namespace empty_ns; - -/// Should still work -namespace empty_ns_alias = empty_ns; - diff --git a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.html b/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.html deleted file mode 100644 index e5c32d76a..000000000 --- a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.html +++ /dev/null @@ -1,309 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - - - - - - -
NameDescription
documented_ns Namespace documentation
mixed_ns Should decay to see-below
mixed_regular_ns Should decay to regular
regular_ns Regular namespace
see_below_ns Should decay to see-below
- -

Namespace Aliases

- - - - - - - - - - - - -
NameDescription
empty_ns_alias Should still work
regular_ns_alias Should work
- -
-

Using Namespace Directives

- - - - - - - - - - - -
Name
regular_ns
empty_ns
- - -
- -
-
-
-

documented_ns

-
-Namespace documentation - -
-
-
-
-
-

mixed_ns

-
-Should decay to see-below - -
-
-

Types

- - - - - - - - - - -
Name
SeeBelowStructA
- -
-
- -
-

Synopsis

-
-Declared in <no-extract-empty-namespaces.cpp>
-
-struct SeeBelowStructA { /* see-below */ };
-
-
-
-
- - -
-
-
-

mixed_regular_ns

-
-Should decay to regular - -
-
-

Types

- - - - - - - - - - - -
Name
RegularStructA
SeeBelowStructB
- -
-
- -
-

Synopsis

-
-Declared in <no-extract-empty-namespaces.cpp>
-
-struct RegularStructA;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <no-extract-empty-namespaces.cpp>
-
-struct SeeBelowStructB { /* see-below */ };
-
-
-
-
- - -
-
-
-

regular_ns

-
-Regular namespace - -
-
-

Types

- - - - - - - - - - -
Name
A
- -
-
- -
-

Synopsis

-
-Declared in <no-extract-empty-namespaces.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

see_below_ns

-
-Should decay to see-below - -
-
-

Types

- - - - - - - - - - - -
Name
SeeBelowStructA
SeeBelowStructB
- -
-
- -
-

Synopsis

-
-Declared in <no-extract-empty-namespaces.cpp>
-
-struct SeeBelowStructA { /* see-below */ };
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <no-extract-empty-namespaces.cpp>
-
-struct SeeBelowStructB { /* see-below */ };
-
-
-
-
- - -
-
-
-

empty_ns_alias

-
-Should still work - -
-
-
-

Synopsis

-
-Declared in <no-extract-empty-namespaces.cpp>
-
-namespace empty_ns_alias = empty_ns;
-
-
-
-
-
-
-
-

regular_ns_alias

-
-Should work - -
-
-
-

Synopsis

-
-Declared in <no-extract-empty-namespaces.cpp>
-
-namespace regular_ns_alias = regular_ns;
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.xml b/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.xml deleted file mode 100644 index cf3e3acc8..000000000 --- a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.xml +++ /dev/null @@ -1,91 +0,0 @@ - - - - - - - - Namespace documentation - - - - - - - Should decay to implementation-defined - - - - - - - Should decay to see-below - - - - - - - - - - - - - Should decay to regular - - - - - - - - - - - - - - - - Regular namespace - - - - - - - - - - Should decay to see-below - - - - - - - - - - - - - - Should still work - - - - - - - - - Should work - - - - - - diff --git a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.yml b/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.yml deleted file mode 100644 index 69b302286..000000000 --- a/test-files/golden-tests/config/extract-empty-namespaces/no-extract-empty-namespaces.yml +++ /dev/null @@ -1,11 +0,0 @@ -extract-empty-namespaces: false -exclude-symbols: - - excluded_members_ns::* -implementation-defined: - - implementation_defined_ns::* - - mixed_ns::ImplementationDefinedStructB - - mixed_regular_ns::ImplementationDefinedStructC -see-below: - - see_below_ns::* - - mixed_ns::SeeBelowStructA - - mixed_regular_ns::SeeBelowStructB \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-friends/extract-friends.adoc b/test-files/golden-tests/config/extract-friends/extract-friends.adoc deleted file mode 100644 index 3b91a36ef..000000000 --- a/test-files/golden-tests/config/extract-friends/extract-friends.adoc +++ /dev/null @@ -1,105 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#std[`std`] -|=== - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -|=== - -[#std] -== std - -=== Types - -[cols=1] -|=== -| Name -| link:#std-hash-03[`hash`] -| link:#std-hash-08[`hash<A>`] -|=== - -[#std-hash-03] -== link:#std[std]::hash - -=== Synopsis - -Declared in `<extract‐friends.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -class hash; ----- - -[#std-hash-08] -== link:#std[std]::link:#std-hash-03[hash]<link:#A[A]> - -=== Synopsis - -Declared in `<extract‐friends.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -class link:#std-hash-03[hash]<link:#A[A]>; ----- - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#std-hash-08-operator_call[`operator()`] -|=== - -[#std-hash-08-operator_call] -== link:#std[std]::link:#std-hash-08[hash<A>]::operator() - -=== Synopsis - -Declared in `<extract‐friends.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -unsigned long long -operator()(link:#A[A] const& rhs) const noexcept; ----- - -[#A] -== A - -=== Synopsis - -Declared in `<extract‐friends.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class A; ----- - -=== Friends - -[cols=2] -|=== -| Name -| Description -| `link:#std-hash-08[std::hash<A>]` -| -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-friends/extract-friends.cpp b/test-files/golden-tests/config/extract-friends/extract-friends.cpp deleted file mode 100644 index b2b2e91eb..000000000 --- a/test-files/golden-tests/config/extract-friends/extract-friends.cpp +++ /dev/null @@ -1,20 +0,0 @@ -namespace std { - template - class hash; -} - -class A { - friend std::hash; -}; - -namespace std { - template <> - class hash { - public: - unsigned long long - operator()(const A&) const noexcept - { - return 0; - } - }; -} \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-friends/extract-friends.html b/test-files/golden-tests/config/extract-friends/extract-friends.html deleted file mode 100644 index 742f55901..000000000 --- a/test-files/golden-tests/config/extract-friends/extract-friends.html +++ /dev/null @@ -1,164 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - -
Name
std
- -

Types

- - - - - - - - - - -
Name
A
- -
-
-
-

std

-
-

Types

- - - - - - - - - - - -
Name
hash
hash<A>
- -
-
- -
-

Synopsis

-
-Declared in <extract-friends.cpp>
-
-template<class T>
-class hash;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <extract-friends.cpp>
-
-template<>
-class hash<A>;
-
-
-
-
-

Member Functions

- - - - - - - - - - -
Name
operator()
- - - -
-
- -
-

Synopsis

-
-Declared in <extract-friends.cpp>
-
-unsigned long long
-operator()(A const& rhs) const noexcept;
-
-
-
-
-
-
-
-

A

-
-
-

Synopsis

-
-Declared in <extract-friends.cpp>
-
-class A;
-
-
-
-
- - -
-

Friends

- - - - - - - - - - - - -|=== - -
NameDescription
hash<A>
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-friends/extract-friends.xml b/test-files/golden-tests/config/extract-friends/extract-friends.xml deleted file mode 100644 index 579549227..000000000 --- a/test-files/golden-tests/config/extract-friends/extract-friends.xml +++ /dev/null @@ -1,39 +0,0 @@ - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/extract-friends/extract-friends.yml b/test-files/golden-tests/config/extract-friends/extract-friends.yml deleted file mode 100644 index cb59c43af..000000000 --- a/test-files/golden-tests/config/extract-friends/extract-friends.yml +++ /dev/null @@ -1,2 +0,0 @@ -extract-friends: true -warn-if-undocumented: false \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-friends/no-extract-friends.adoc b/test-files/golden-tests/config/extract-friends/no-extract-friends.adoc deleted file mode 100644 index 0b50695f0..000000000 --- a/test-files/golden-tests/config/extract-friends/no-extract-friends.adoc +++ /dev/null @@ -1,95 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#std[`std`] -|=== - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -|=== - -[#std] -== std - -=== Types - -[cols=1] -|=== -| Name -| link:#std-hash-03[`hash`] -| link:#std-hash-08[`hash<A>`] -|=== - -[#std-hash-03] -== link:#std[std]::hash - -=== Synopsis - -Declared in `<no‐extract‐friends.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -class hash; ----- - -[#std-hash-08] -== link:#std[std]::link:#std-hash-03[hash]<link:#A[A]> - -=== Synopsis - -Declared in `<no‐extract‐friends.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -class link:#std-hash-03[hash]<link:#A[A]>; ----- - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#std-hash-08-operator_call[`operator()`] -|=== - -[#std-hash-08-operator_call] -== link:#std[std]::link:#std-hash-08[hash<A>]::operator() - -=== Synopsis - -Declared in `<no‐extract‐friends.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -unsigned long long -operator()(link:#A[A] const& rhs) const noexcept; ----- - -[#A] -== A - -=== Synopsis - -Declared in `<no‐extract‐friends.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class A; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-friends/no-extract-friends.cpp b/test-files/golden-tests/config/extract-friends/no-extract-friends.cpp deleted file mode 100644 index bd0b658dd..000000000 --- a/test-files/golden-tests/config/extract-friends/no-extract-friends.cpp +++ /dev/null @@ -1,20 +0,0 @@ -namespace std { -template -class hash; -} - -class A { - friend std::hash; -}; - -namespace std { -template <> -class hash { -public: - unsigned long long - operator()(const A&) const noexcept - { - return 0; - } -}; -} \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-friends/no-extract-friends.html b/test-files/golden-tests/config/extract-friends/no-extract-friends.html deleted file mode 100644 index 3731e0aaf..000000000 --- a/test-files/golden-tests/config/extract-friends/no-extract-friends.html +++ /dev/null @@ -1,146 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - -
Name
std
- -

Types

- - - - - - - - - - -
Name
A
- -
-
-
-

std

-
-

Types

- - - - - - - - - - - -
Name
hash
hash<A>
- -
-
- -
-

Synopsis

-
-Declared in <no-extract-friends.cpp>
-
-template<class T>
-class hash;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <no-extract-friends.cpp>
-
-template<>
-class hash<A>;
-
-
-
-
-

Member Functions

- - - - - - - - - - -
Name
operator()
- - - -
-
- -
-

Synopsis

-
-Declared in <no-extract-friends.cpp>
-
-unsigned long long
-operator()(A const& rhs) const noexcept;
-
-
-
-
-
-
-
-

A

-
-
-

Synopsis

-
-Declared in <no-extract-friends.cpp>
-
-class A;
-
-
-
-
- - -
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-friends/no-extract-friends.xml b/test-files/golden-tests/config/extract-friends/no-extract-friends.xml deleted file mode 100644 index cfdb156a0..000000000 --- a/test-files/golden-tests/config/extract-friends/no-extract-friends.xml +++ /dev/null @@ -1,36 +0,0 @@ - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/extract-friends/no-extract-friends.yml b/test-files/golden-tests/config/extract-friends/no-extract-friends.yml deleted file mode 100644 index 7a2b9d529..000000000 --- a/test-files/golden-tests/config/extract-friends/no-extract-friends.yml +++ /dev/null @@ -1,2 +0,0 @@ -extract-friends: false -warn-if-undocumented: false \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-implicit-specializations/base.adoc b/test-files/golden-tests/config/extract-implicit-specializations/base.adoc deleted file mode 100644 index c497efcfc..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/base.adoc +++ /dev/null @@ -1,91 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -| link:#B[`B`] -|=== - -[#A] -== A - -=== Synopsis - -Declared in `<base.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A - : link:#B[B] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#B[B]` -| -|=== - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#B-value[`value`] -|=== - -[#B] -== B - -=== Synopsis - -Declared in `<base.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct B; ----- - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#B-value[`value`] -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| -|=== - -[#B-value] -== link:#B[B]::value - -=== Synopsis - -Declared in `<base.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -value(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-implicit-specializations/base.cpp b/test-files/golden-tests/config/extract-implicit-specializations/base.cpp deleted file mode 100644 index 00fb046d4..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/base.cpp +++ /dev/null @@ -1,5 +0,0 @@ -struct B { - int value(); -}; - -struct A : public B {}; diff --git a/test-files/golden-tests/config/extract-implicit-specializations/base.html b/test-files/golden-tests/config/extract-implicit-specializations/base.html deleted file mode 100644 index 5e2905ddd..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/base.html +++ /dev/null @@ -1,139 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
Name
A
B
- -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <base.cpp>
-
-struct A
-    : B
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
B
-
-

Member Functions

- - - - - - - - - - -
Name
value
- - - -
-
-
-

B

-
-
-

Synopsis

-
-Declared in <base.cpp>
-
-struct B;
-
-
-
-
-

Member Functions

- - - - - - - - - - -
Name
value
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
A -
-
-
-
- -
-

Synopsis

-
-Declared in <base.cpp>
-
-int
-value();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-implicit-specializations/base.xml b/test-files/golden-tests/config/extract-implicit-specializations/base.xml deleted file mode 100644 index 4e4171a9b..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/base.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/extract-implicit-specializations/base.yml b/test-files/golden-tests/config/extract-implicit-specializations/base.yml deleted file mode 100644 index d66e76923..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/base.yml +++ /dev/null @@ -1 +0,0 @@ -extract-implicit-specializations: true \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.adoc b/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.adoc deleted file mode 100644 index bd41f32de..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.adoc +++ /dev/null @@ -1,105 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -| link:#B-00[`B`] -|=== - -[#A] -== A - -=== Synopsis - -Declared in `<extract‐implicit‐specializations.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A - : link:#B-00[B<int>] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#B-00[B<int>]` -| -|=== - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#A-value[`value`] -|=== - -[#A-value] -== link:#A[A]::value - -=== Synopsis - -Declared in `<extract‐implicit‐specializations.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -value(); ----- - -[#B-00] -== B - -=== Synopsis - -Declared in `<extract‐implicit‐specializations.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -struct B; ----- - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#B-00-value[`value`] -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| -|=== - -[#B-00-value] -== link:#B-00[B]::value - -=== Synopsis - -Declared in `<extract‐implicit‐specializations.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -T& -value(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.cpp b/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.cpp deleted file mode 100644 index da7f56885..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.cpp +++ /dev/null @@ -1,6 +0,0 @@ -template -struct B { - T& value(); -}; - -struct A : public B {}; diff --git a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.html b/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.html deleted file mode 100644 index ad404c9c2..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.html +++ /dev/null @@ -1,156 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
Name
A
B
- -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <extract-implicit-specializations.cpp>
-
-struct A
-    : B<int>
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
B<int>
-
-

Member Functions

- - - - - - - - - - -
Name
value
- - - -
-
- -
-

Synopsis

-
-Declared in <extract-implicit-specializations.cpp>
-
-int&
-value();
-
-
-
-
-
-
-
-

B

-
-
-

Synopsis

-
-Declared in <extract-implicit-specializations.cpp>
-
-template<typename T>
-struct B;
-
-
-
-
-

Member Functions

- - - - - - - - - - -
Name
value
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
A -
-
-
-
- -
-

Synopsis

-
-Declared in <extract-implicit-specializations.cpp>
-
-T&
-value();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.xml b/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.xml deleted file mode 100644 index fb77b9641..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.yml b/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.yml deleted file mode 100644 index d66e76923..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/extract-implicit-specializations.yml +++ /dev/null @@ -1 +0,0 @@ -extract-implicit-specializations: true \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.adoc b/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.adoc deleted file mode 100644 index 65428e617..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.adoc +++ /dev/null @@ -1,92 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -| link:#B[`B`] -|=== - -[#A] -== A - -=== Synopsis - -Declared in `<no‐extract‐implicit‐specializations.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A - : link:#B[B<int>] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#B[B<int>]` -| -|=== - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#B-value[`value`] -|=== - -[#B] -== B - -=== Synopsis - -Declared in `<no‐extract‐implicit‐specializations.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -struct B; ----- - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#B-value[`value`] -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#A[`A`] -| -|=== - -[#B-value] -== link:#B[B]::value - -=== Synopsis - -Declared in `<no‐extract‐implicit‐specializations.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -T& -value(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.cpp b/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.cpp deleted file mode 100644 index da7f56885..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.cpp +++ /dev/null @@ -1,6 +0,0 @@ -template -struct B { - T& value(); -}; - -struct A : public B {}; diff --git a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.html b/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.html deleted file mode 100644 index 59225a6f8..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.html +++ /dev/null @@ -1,140 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
Name
A
B
- -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <no-extract-implicit-specializations.cpp>
-
-struct A
-    : B<int>
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
B<int>
-
-

Member Functions

- - - - - - - - - - -
Name
value
- - - -
-
-
-

B

-
-
-

Synopsis

-
-Declared in <no-extract-implicit-specializations.cpp>
-
-template<typename T>
-struct B;
-
-
-
-
-

Member Functions

- - - - - - - - - - -
Name
value
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
A -
-
-
-
- -
-

Synopsis

-
-Declared in <no-extract-implicit-specializations.cpp>
-
-T&
-value();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.xml b/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.xml deleted file mode 100644 index 4cc0a0212..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.xml +++ /dev/null @@ -1,34 +0,0 @@ - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.yml b/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.yml deleted file mode 100644 index 2b0d7ee74..000000000 --- a/test-files/golden-tests/config/extract-implicit-specializations/no-extract-implicit-specializations.yml +++ /dev/null @@ -1 +0,0 @@ -extract-implicit-specializations: false \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.adoc b/test-files/golden-tests/config/extract-local-classes/extract-local-classes.adoc deleted file mode 100644 index b65d3c7c1..000000000 --- a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.adoc +++ /dev/null @@ -1,62 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#local_class[`local_class`] -| link:#local_struct[`local_struct`] -|=== - -=== Functions - -[cols=1] -|=== -| Name -| link:#local_function[`local_function`] -|=== - -[#local_class] -== local_class - -=== Synopsis - -Declared in `<extract‐local‐classes.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class local_class; ----- - -[#local_struct] -== local_struct - -=== Synopsis - -Declared in `<extract‐local‐classes.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct local_struct; ----- - -[#local_function] -== local_function - -=== Synopsis - -Declared in `<extract‐local‐classes.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -local_function(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.cpp b/test-files/golden-tests/config/extract-local-classes/extract-local-classes.cpp deleted file mode 100644 index 989229f70..000000000 --- a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.cpp +++ /dev/null @@ -1,5 +0,0 @@ -// Already a cpp file so this is a local class -struct local_struct {}; -class local_class {}; -void local_function(); - diff --git a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.html b/test-files/golden-tests/config/extract-local-classes/extract-local-classes.html deleted file mode 100644 index ce9cb036d..000000000 --- a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.html +++ /dev/null @@ -1,96 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
Name
local_class
local_struct
- -

Functions

- - - - - - - - - - -
Name
local_function
- -
-
- -
-

Synopsis

-
-Declared in <extract-local-classes.cpp>
-
-class local_class;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <extract-local-classes.cpp>
-
-struct local_struct;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <extract-local-classes.cpp>
-
-void
-local_function();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.xml b/test-files/golden-tests/config/extract-local-classes/extract-local-classes.xml deleted file mode 100644 index 181122d33..000000000 --- a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.yml b/test-files/golden-tests/config/extract-local-classes/extract-local-classes.yml deleted file mode 100644 index 6e8913408..000000000 --- a/test-files/golden-tests/config/extract-local-classes/extract-local-classes.yml +++ /dev/null @@ -1 +0,0 @@ -extract-local-classes: true \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.adoc b/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.adoc deleted file mode 100644 index 29993352c..000000000 --- a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.adoc +++ /dev/null @@ -1,29 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#local_function[`local_function`] -|=== - -[#local_function] -== local_function - -=== Synopsis - -Declared in `<no‐extract‐local‐classes.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -local_function(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.cpp b/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.cpp deleted file mode 100644 index 989229f70..000000000 --- a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.cpp +++ /dev/null @@ -1,5 +0,0 @@ -// Already a cpp file so this is a local class -struct local_struct {}; -class local_class {}; -void local_function(); - diff --git a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.html b/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.html deleted file mode 100644 index 1d1fbd801..000000000 --- a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.html +++ /dev/null @@ -1,48 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - -
Name
local_function
- -
-
- -
-

Synopsis

-
-Declared in <no-extract-local-classes.cpp>
-
-void
-local_function();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.xml b/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.xml deleted file mode 100644 index 08df5f32a..000000000 --- a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.xml +++ /dev/null @@ -1,9 +0,0 @@ - - - - - - - - diff --git a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.yml b/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.yml deleted file mode 100644 index a0dd405a3..000000000 --- a/test-files/golden-tests/config/extract-local-classes/no-extract-local-classes.yml +++ /dev/null @@ -1 +0,0 @@ -extract-local-classes: false \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.adoc b/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.adoc deleted file mode 100644 index d37dd9300..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.adoc +++ /dev/null @@ -1,72 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -|=== - -[#A] -== A - -=== Synopsis - -Declared in `<extract‐private‐virtual.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class A; ----- - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#A-f[`f`] [.small]#[virtual]# -|=== - -=== Private Member Functions - -[cols=1] -|=== -| Name -| link:#A-g[`g`] [.small]#[virtual]# -|=== - -[#A-f] -== link:#A[A]::f - -=== Synopsis - -Declared in `<extract‐private‐virtual.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -virtual -void -f(); ----- - -[#A-g] -== link:#A[A]::g - -=== Synopsis - -Declared in `<extract‐private‐virtual.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -virtual -void -g(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.cpp b/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.cpp deleted file mode 100644 index 8fa855aa8..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.cpp +++ /dev/null @@ -1,6 +0,0 @@ -class A { -public: - virtual void f() {} -private: - virtual void g() {} -}; \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.html b/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.html deleted file mode 100644 index 2395664d6..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.html +++ /dev/null @@ -1,109 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
A
- -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <extract-private-virtual.cpp>
-
-class A;
-
-
-
-
-

Member Functions

- - - - - - - - - - -
Name
f [virtual]
- - - -

Private Member Functions

- - - - - - - - - - -
Name
g [virtual]
- -
-
-
-

A::f

-
-
-

Synopsis

-
-Declared in <extract-private-virtual.cpp>
-
-virtual
-void
-f();
-
-
-
-
-
-
-
-

A::g

-
-
-

Synopsis

-
-Declared in <extract-private-virtual.cpp>
-
-virtual
-void
-g();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.xml b/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.xml deleted file mode 100644 index b8b465a8f..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.yml b/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.yml deleted file mode 100644 index fe1a06434..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/extract-private-virtual.yml +++ /dev/null @@ -1 +0,0 @@ -extract-private-virtual: true \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.adoc b/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.adoc deleted file mode 100644 index a36c155e7..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -|=== - -[#A] -== A - -=== Synopsis - -Declared in `<no‐extract‐private‐virtual.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class A; ----- - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#A-f[`f`] [.small]#[virtual]# -|=== - -[#A-f] -== link:#A[A]::f - -=== Synopsis - -Declared in `<no‐extract‐private‐virtual.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -virtual -void -f(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.cpp b/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.cpp deleted file mode 100644 index 8fa855aa8..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.cpp +++ /dev/null @@ -1,6 +0,0 @@ -class A { -public: - virtual void f() {} -private: - virtual void g() {} -}; \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.html b/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.html deleted file mode 100644 index cae3b7be9..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.html +++ /dev/null @@ -1,79 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
A
- -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <no-extract-private-virtual.cpp>
-
-class A;
-
-
-
-
-

Member Functions

- - - - - - - - - - -
Name
f [virtual]
- - - -
-
-
-

A::f

-
-
-

Synopsis

-
-Declared in <no-extract-private-virtual.cpp>
-
-virtual
-void
-f();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.xml b/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.xml deleted file mode 100644 index 012ecce05..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.yml b/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.yml deleted file mode 100644 index 29e25140d..000000000 --- a/test-files/golden-tests/config/extract-private-virtual/no-extract-private-virtual.yml +++ /dev/null @@ -1 +0,0 @@ -extract-private-virtual: false \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/base-overload-set.adoc b/test-files/golden-tests/config/inherit-base-members/base-overload-set.adoc deleted file mode 100644 index 2d333005a..000000000 --- a/test-files/golden-tests/config/inherit-base-members/base-overload-set.adoc +++ /dev/null @@ -1,188 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#Base[`Base`] -| link:#C[`C`] -| link:#ConstBase[`ConstBase`] -|=== - -[#Base] -== Base - -=== Synopsis - -Declared in `<base‐overload‐set.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class Base - : public link:#ConstBase[ConstBase] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#ConstBase[ConstBase]` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Base-foo-04[`foo`] -| -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#C[`C`] -| -|=== - -[#Base-foo-04] -== link:#Base[Base]::foo - -=== Synopses - -Declared in `<base‐overload‐set.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -link:#Base-foo-0a[foo](); ----- - -[.small]#link:#Base-foo-0a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -link:#Base-foo-08[foo]() const; ----- - -[.small]#link:#Base-foo-08[_» more..._]# - -[#Base-foo-0a] -== link:#Base[Base]::foo - -=== Synopsis - -Declared in `<base‐overload‐set.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -foo(); ----- - -[#Base-foo-08] -== link:#Base[Base]::foo - -=== Synopsis - -Declared in `<base‐overload‐set.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -foo() const; ----- - -[#C] -== C - -=== Synopsis - -Declared in `<base‐overload‐set.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class C - : public link:#Base[Base] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#Base[Base]` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Base-foo-04[`foo`] -| -|=== - -[#ConstBase] -== ConstBase - -=== Synopsis - -Declared in `<base‐overload‐set.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class ConstBase; ----- - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#ConstBase-foo[`foo`] -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#Base[`Base`] -| -|=== - -[#ConstBase-foo] -== link:#ConstBase[ConstBase]::foo - -=== Synopsis - -Declared in `<base‐overload‐set.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -foo() const; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/inherit-base-members/base-overload-set.cpp b/test-files/golden-tests/config/inherit-base-members/base-overload-set.cpp deleted file mode 100644 index 6b24ec67e..000000000 --- a/test-files/golden-tests/config/inherit-base-members/base-overload-set.cpp +++ /dev/null @@ -1,13 +0,0 @@ -class ConstBase { -public: - int& foo() const; -}; - -class Base - : public ConstBase { -public: - int& foo(); - int& foo() const; -}; - -class C : public Base {}; \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/base-overload-set.html b/test-files/golden-tests/config/inherit-base-members/base-overload-set.html deleted file mode 100644 index b03a96e25..000000000 --- a/test-files/golden-tests/config/inherit-base-members/base-overload-set.html +++ /dev/null @@ -1,261 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - -
Name
Base
C
ConstBase
- -
-
-
-

Base

-
-
-

Synopsis

-
-Declared in <base-overload-set.cpp>
-
-class Base
-    : public ConstBase
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
ConstBase
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
foo
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
C -
-
-
-
- -
-

Synopses

-
-Declared in <base-overload-set.cpp>
- -
-int&
-foo();
-
-
-
» more... - - -
-int&
-foo() const;
-
-
-
» more... - - -
-
-
- -
-

Synopsis

-
-Declared in <base-overload-set.cpp>
-
-int&
-foo();
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <base-overload-set.cpp>
-
-int&
-foo() const;
-
-
-
-
-
-
-
-

C

-
-
-

Synopsis

-
-Declared in <base-overload-set.cpp>
-
-class C
-    : public Base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
Base
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
foo
- - - -
-
- -
-

Synopsis

-
-Declared in <base-overload-set.cpp>
-
-class ConstBase;
-
-
-
-
-

Member Functions

- - - - - - - - - - -
Name
foo
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
Base -
-
-
-
- -
-

Synopsis

-
-Declared in <base-overload-set.cpp>
-
-int&
-foo() const;
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/base-overload-set.xml b/test-files/golden-tests/config/inherit-base-members/base-overload-set.xml deleted file mode 100644 index 050fe0279..000000000 --- a/test-files/golden-tests/config/inherit-base-members/base-overload-set.xml +++ /dev/null @@ -1,64 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.adoc b/test-files/golden-tests/config/inherit-base-members/copy-dependencies.adoc deleted file mode 100644 index c09ad5f58..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.adoc +++ /dev/null @@ -1,651 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| A base class to test inheritance and shadowing -| link:#base_base[`base_base`] -| A second‐order base class to test indirect inheritance -| link:#derived[`derived`] -| A class that derives from base and excluded_base -| link:#private_derived[`private_derived`] -| A class that uses private inheritance only -| link:#protected_derived[`protected_derived`] -| A class that should inherit functions as protected. -|=== - -[#base] -== base - -A base class to test inheritance and shadowing - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base - : public link:#base_base[base_base] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base_base[base_base]` -| A second‐order base class to test indirect inheritance -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-derived_shadowed[`derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#derived[`derived`] -| A class that derives from base and excluded_base -|=== - -[#base-base_inherited] -== link:#base[base]::base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-base_shadowed] -== link:#base[base]::base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-derived_shadowed] -== link:#base[base]::derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_base_inherited] -== link:#base[base]::do_base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_base_shadowed] -== link:#base[base]::do_base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_derived_shadowed] -== link:#base[base]::do_derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base_base] -== base_base - -A second‐order base class to test indirect inheritance - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base_base; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| A base class to test inheritance and shadowing -|=== - -[#base_base-base_base_inherited] -== link:#base_base[base_base]::base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#base_base-do_base_base_inherited] -== link:#base_base[base_base]::do_base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -do_base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#derived] -== derived - -A class that derives from base and excluded_base - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class derived - : public link:#base[base] - , public excluded_base ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| A base class to test inheritance and shadowing -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -| link:#derived-excluded_inherited[`excluded_inherited`] -| This function should be inherited by derived classes. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#derived-do_excluded_inherited[`do_excluded_inherited`] -| This function should be inherited by derived classes. -| link:#derived-do_shadowed[`do_shadowed`] -| This function should be shadowed by derived classes. -|=== - -[#derived-derived_shadowed] -== link:#derived[derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that derives from base and excluded_base - -[#derived-do_derived_shadowed] -== link:#derived[derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that derives from base and excluded_base - -[#derived-excluded_inherited] -== link:#derived[derived]::excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -excluded_inherited(); ----- - -[#derived-do_excluded_inherited] -== link:#derived[derived]::do_excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_excluded_inherited(); ----- - -[#derived-do_shadowed] -== link:#derived[derived]::do_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_shadowed(); ----- - -[#private_derived] -== private_derived - -A class that uses private inheritance only - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class private_derived - : link:#base[base] - , excluded_base ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#private_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#private_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -[#private_derived-derived_shadowed] -== link:#private_derived[private_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that uses private inheritance only - -[#private_derived-do_derived_shadowed] -== link:#private_derived[private_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that uses private inheritance only - -[#protected_derived] -== protected_derived - -A class that should inherit functions as protected. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class protected_derived - : protected link:#base[base] - , protected excluded_base ----- - -=== Protected Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| A base class to test inheritance and shadowing -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#protected_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#protected_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-derived_shadowed[`derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#protected_derived-do_excluded_inherited[`do_excluded_inherited`] -| This function should be inherited by derived classes. -| link:#protected_derived-do_shadowed[`do_shadowed`] -| This function should be shadowed by derived classes. -| link:#protected_derived-excluded_inherited[`excluded_inherited`] -| This function should be inherited by derived classes. -|=== - -[#protected_derived-derived_shadowed] -== link:#protected_derived[protected_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that should inherit functions as protected. - -[#protected_derived-do_derived_shadowed] -== link:#protected_derived[protected_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that should inherit functions as protected. - -[#protected_derived-do_excluded_inherited] -== link:#protected_derived[protected_derived]::do_excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_excluded_inherited(); ----- - -[#protected_derived-do_shadowed] -== link:#protected_derived[protected_derived]::do_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_shadowed(); ----- - -[#protected_derived-excluded_inherited] -== link:#protected_derived[protected_derived]::excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy‐dependencies.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -excluded_inherited(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.cpp b/test-files/golden-tests/config/inherit-base-members/copy-dependencies.cpp deleted file mode 100644 index eff6deaf5..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.cpp +++ /dev/null @@ -1,86 +0,0 @@ -/// A base class excluded from the documentation -class excluded_base { -public: - /// This function should be shadowed by derived classes. - excluded_base& derived_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& excluded_inherited(); -protected: - /// This function should be shadowed by derived classes. - excluded_base& do_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& do_base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& do_excluded_inherited(); -}; - -/// A second-order base class to test indirect inheritance -class base_base { -public: - /// This function should be indirectly inherited by derived classes. - base_base& base_base_inherited(); -public: - /// This function should be indirectly inherited by derived classes. - base_base& do_base_base_inherited(); -}; - -/// A base class to test inheritance and shadowing -class base : - public base_base -{ -public: - /// This function should be shadowed by derived classes. - base& derived_shadowed(); - /// This function should shadow the excluded_base function. - base& base_shadowed(); - /// This function should be inherited by derived classes. - base& base_inherited(); -protected: - /// This function should be shadowed by derived classes. - base& do_derived_shadowed(); - /// This function should shadow the excluded_base function. - base& do_base_shadowed(); - /// This function should be inherited by derived classes. - base& do_base_inherited(); -}; - -/// A class that derives from base and excluded_base -class derived - : public base - , public excluded_base -{ -public: - /// This function should shadow the base class function. - derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - derived& do_derived_shadowed(); -}; - -/// A class that should inherit functions as protected. -class protected_derived - : protected base - , protected excluded_base -{ -public: - /// This function should shadow the base class function. - protected_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - protected_derived& do_derived_shadowed(); -}; - -/// A class that uses private inheritance only -class private_derived - : private base - , private excluded_base -{ -public: - /// This function should shadow the base class function. - private_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - private_derived& do_derived_shadowed(); -}; diff --git a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.html b/test-files/golden-tests/config/inherit-base-members/copy-dependencies.html deleted file mode 100644 index a1576424a..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.html +++ /dev/null @@ -1,820 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - -
NameDescription
base A base class to test inheritance and shadowing
base_base A second-order base class to test indirect inheritance
derived A class that derives from base and excluded_base
private_derived A class that uses private inheritance only
protected_derived A class that should inherit functions as protected.
- -
-
-
-

base

-
-A base class to test inheritance and shadowing - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-class base
-    : public base_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
base_baseA second-order base class to test indirect inheritance
-
-

Member Functions

- - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - -

Protected Member Functions

- - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
- - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
derived - A class that derives from base and excluded_base
-
-
-
-
-

base::base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-base&
-base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-base&
-base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-base&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-base&
-do_base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-base&
-do_base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-base&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base_base

-
-A second-order base class to test indirect inheritance - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-class base_base;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
base - A base class to test inheritance and shadowing
-
-
-
-
-

base_base::base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-base_base&
-base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

base_base::do_base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-base_base&
-do_base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

derived

-
-A class that derives from base and excluded_base - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-class derived
-    : public base
-    , public excluded_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - - -
NameDescription
baseA base class to test inheritance and shadowing
excluded_base
-
-

Member Functions

- - - - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should shadow the base class function.
do_base_base_inherited This function should be indirectly inherited by derived classes.
do_derived_shadowed This function should shadow the base class function.
excluded_inherited This function should be inherited by derived classes.
- - -

Protected Member Functions

- - - - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
do_excluded_inherited This function should be inherited by derived classes.
do_shadowed This function should be shadowed by derived classes.
- - -
-
-
-

derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that derives from base and excluded_base -
-
-
-
-

derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that derives from base and excluded_base -
-
-
-
-

derived::excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-excluded_base&
-excluded_inherited();
-
-
-
-
-
-
-
-

derived::do_excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-excluded_base&
-do_excluded_inherited();
-
-
-
-
-
-
-
-

derived::do_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-excluded_base&
-do_shadowed();
-
-
-
-
-
-
-
-

private_derived

-
-A class that uses private inheritance only - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-class private_derived
-    : base
-    , excluded_base
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - - -
-
-
-

private_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-private_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that uses private inheritance only -
-
-
-
-

private_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-private_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that uses private inheritance only -
-
-
-
-

protected_derived

-
-A class that should inherit functions as protected. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-class protected_derived
-    : protected base
-    , protected excluded_base
-
-
-
-
-
-

Protected Base Classes

- - - - - - - - - - - -
NameDescription
baseA base class to test inheritance and shadowing
excluded_base
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - -

Protected Member Functions

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
do_excluded_inherited This function should be inherited by derived classes.
do_shadowed This function should be shadowed by derived classes.
excluded_inherited This function should be inherited by derived classes.
- - -
-
-
-

protected_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-protected_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that should inherit functions as protected. -
-
-
-
-

protected_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-protected_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that should inherit functions as protected. -
-
-
-
-

protected_derived::do_excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-excluded_base&
-do_excluded_inherited();
-
-
-
-
-
-
-
-

protected_derived::do_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-excluded_base&
-do_shadowed();
-
-
-
-
-
-
-
-

protected_derived::excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy-dependencies.cpp>
-
-excluded_base&
-excluded_inherited();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.xml b/test-files/golden-tests/config/inherit-base-members/copy-dependencies.xml deleted file mode 100644 index 518a2a8f4..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.xml +++ /dev/null @@ -1,641 +0,0 @@ - - - - - - - - - - - A base class to test inheritance and shadowing - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - - - A class that derives from base and excluded_base - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that derives from base and excluded_base - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that derives from base and excluded_base - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - - - A class that uses private inheritance only - - - - - - - - - - - - This function should shadow the base class function. - - - A class that uses private inheritance only - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that uses private inheritance only - - - - - - - - - - - - - - - A class that should inherit functions as protected. - - - - - - - - - - - - This function should shadow the base class function. - - - A class that should inherit functions as protected. - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that should inherit functions as protected. - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - diff --git a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.yml b/test-files/golden-tests/config/inherit-base-members/copy-dependencies.yml deleted file mode 100644 index 9d5f26010..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy-dependencies.yml +++ /dev/null @@ -1,5 +0,0 @@ -inherit-base-members: copy-dependencies -exclude-symbols: - - excluded_base -extract-private-bases: true -warn-no-paramdoc: false diff --git a/test-files/golden-tests/config/inherit-base-members/copy.adoc b/test-files/golden-tests/config/inherit-base-members/copy.adoc deleted file mode 100644 index 3f9cabdfc..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy.adoc +++ /dev/null @@ -1,974 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| A base class to test inheritance and shadowing -| link:#base_base[`base_base`] -| A second‐order base class to test indirect inheritance -| link:#derived[`derived`] -| A class that derives from base and excluded_base -| link:#private_derived[`private_derived`] -| A class that uses private inheritance only -| link:#protected_derived[`protected_derived`] -| A class that should inherit functions as protected. -|=== - -[#base] -== base - -A base class to test inheritance and shadowing - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base - : public link:#base_base[base_base] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base_base[base_base]` -| A second‐order base class to test indirect inheritance -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-derived_shadowed[`derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#derived[`derived`] -| A class that derives from base and excluded_base -|=== - -[#base-base_base_inherited] -== link:#base[base]::base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#base-base_inherited] -== link:#base[base]::base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-base_shadowed] -== link:#base[base]::base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-derived_shadowed] -== link:#base[base]::derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_base_base_inherited] -== link:#base[base]::do_base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -do_base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#base-do_base_inherited] -== link:#base[base]::do_base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_base_shadowed] -== link:#base[base]::do_base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_derived_shadowed] -== link:#base[base]::do_derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base_base] -== base_base - -A second‐order base class to test indirect inheritance - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base_base; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| A base class to test inheritance and shadowing -|=== - -[#base_base-base_base_inherited] -== link:#base_base[base_base]::base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#base_base-do_base_base_inherited] -== link:#base_base[base_base]::do_base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -do_base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#derived] -== derived - -A class that derives from base and excluded_base - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class derived - : public link:#base[base] - , public excluded_base ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| A base class to test inheritance and shadowing -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#derived-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#derived-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#derived-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#derived-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#derived-do_derived_shadowed-0a[`do_derived_shadowed`] -| This function should shadow the base class function. -| link:#derived-excluded_inherited[`excluded_inherited`] -| This function should be inherited by derived classes. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#derived-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#derived-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#derived-do_derived_shadowed-0d[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#derived-do_excluded_inherited[`do_excluded_inherited`] -| This function should be inherited by derived classes. -| link:#derived-do_shadowed[`do_shadowed`] -| This function should be shadowed by derived classes. -|=== - -[#derived-base_base_inherited] -== link:#derived[derived]::base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#derived-base_inherited] -== link:#derived[derived]::base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#derived-base_shadowed] -== link:#derived[derived]::base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#derived-derived_shadowed] -== link:#derived[derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that derives from base and excluded_base - -[#derived-do_base_base_inherited] -== link:#derived[derived]::do_base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -do_base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#derived-do_derived_shadowed-0a] -== link:#derived[derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that derives from base and excluded_base - -[#derived-excluded_inherited] -== link:#derived[derived]::excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -excluded_inherited(); ----- - -[#derived-do_base_inherited] -== link:#derived[derived]::do_base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#derived-do_base_shadowed] -== link:#derived[derived]::do_base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#derived-do_derived_shadowed-0d] -== link:#derived[derived]::do_derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#derived-do_excluded_inherited] -== link:#derived[derived]::do_excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_excluded_inherited(); ----- - -[#derived-do_shadowed] -== link:#derived[derived]::do_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_shadowed(); ----- - -[#private_derived] -== private_derived - -A class that uses private inheritance only - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class private_derived - : link:#base[base] - , excluded_base ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#private_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#private_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -[#private_derived-derived_shadowed] -== link:#private_derived[private_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that uses private inheritance only - -[#private_derived-do_derived_shadowed] -== link:#private_derived[private_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that uses private inheritance only - -[#protected_derived] -== protected_derived - -A class that should inherit functions as protected. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class protected_derived - : protected link:#base[base] - , protected excluded_base ----- - -=== Protected Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| A base class to test inheritance and shadowing -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#protected_derived-derived_shadowed-0a[`derived_shadowed`] -| This function should shadow the base class function. -| link:#protected_derived-do_derived_shadowed-0e[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#protected_derived-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#protected_derived-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#protected_derived-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#protected_derived-derived_shadowed-0f[`derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#protected_derived-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#protected_derived-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#protected_derived-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#protected_derived-do_derived_shadowed-06[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#protected_derived-do_excluded_inherited[`do_excluded_inherited`] -| This function should be inherited by derived classes. -| link:#protected_derived-do_shadowed[`do_shadowed`] -| This function should be shadowed by derived classes. -| link:#protected_derived-excluded_inherited[`excluded_inherited`] -| This function should be inherited by derived classes. -|=== - -[#protected_derived-derived_shadowed-0a] -== link:#protected_derived[protected_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that should inherit functions as protected. - -[#protected_derived-do_derived_shadowed-0e] -== link:#protected_derived[protected_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that should inherit functions as protected. - -[#protected_derived-base_base_inherited] -== link:#protected_derived[protected_derived]::base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#protected_derived-base_inherited] -== link:#protected_derived[protected_derived]::base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#protected_derived-base_shadowed] -== link:#protected_derived[protected_derived]::base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#protected_derived-derived_shadowed-0f] -== link:#protected_derived[protected_derived]::derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#protected_derived-do_base_base_inherited] -== link:#protected_derived[protected_derived]::do_base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -do_base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#protected_derived-do_base_inherited] -== link:#protected_derived[protected_derived]::do_base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#protected_derived-do_base_shadowed] -== link:#protected_derived[protected_derived]::do_base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#protected_derived-do_derived_shadowed-06] -== link:#protected_derived[protected_derived]::do_derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#protected_derived-do_excluded_inherited] -== link:#protected_derived[protected_derived]::do_excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_excluded_inherited(); ----- - -[#protected_derived-do_shadowed] -== link:#protected_derived[protected_derived]::do_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_shadowed(); ----- - -[#protected_derived-excluded_inherited] -== link:#protected_derived[protected_derived]::excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<copy.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -excluded_inherited(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/inherit-base-members/copy.cpp b/test-files/golden-tests/config/inherit-base-members/copy.cpp deleted file mode 100644 index eff6deaf5..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy.cpp +++ /dev/null @@ -1,86 +0,0 @@ -/// A base class excluded from the documentation -class excluded_base { -public: - /// This function should be shadowed by derived classes. - excluded_base& derived_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& excluded_inherited(); -protected: - /// This function should be shadowed by derived classes. - excluded_base& do_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& do_base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& do_excluded_inherited(); -}; - -/// A second-order base class to test indirect inheritance -class base_base { -public: - /// This function should be indirectly inherited by derived classes. - base_base& base_base_inherited(); -public: - /// This function should be indirectly inherited by derived classes. - base_base& do_base_base_inherited(); -}; - -/// A base class to test inheritance and shadowing -class base : - public base_base -{ -public: - /// This function should be shadowed by derived classes. - base& derived_shadowed(); - /// This function should shadow the excluded_base function. - base& base_shadowed(); - /// This function should be inherited by derived classes. - base& base_inherited(); -protected: - /// This function should be shadowed by derived classes. - base& do_derived_shadowed(); - /// This function should shadow the excluded_base function. - base& do_base_shadowed(); - /// This function should be inherited by derived classes. - base& do_base_inherited(); -}; - -/// A class that derives from base and excluded_base -class derived - : public base - , public excluded_base -{ -public: - /// This function should shadow the base class function. - derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - derived& do_derived_shadowed(); -}; - -/// A class that should inherit functions as protected. -class protected_derived - : protected base - , protected excluded_base -{ -public: - /// This function should shadow the base class function. - protected_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - protected_derived& do_derived_shadowed(); -}; - -/// A class that uses private inheritance only -class private_derived - : private base - , private excluded_base -{ -public: - /// This function should shadow the base class function. - private_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - private_derived& do_derived_shadowed(); -}; diff --git a/test-files/golden-tests/config/inherit-base-members/copy.html b/test-files/golden-tests/config/inherit-base-members/copy.html deleted file mode 100644 index 781fd9edf..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy.html +++ /dev/null @@ -1,1228 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - -
NameDescription
base A base class to test inheritance and shadowing
base_base A second-order base class to test indirect inheritance
derived A class that derives from base and excluded_base
private_derived A class that uses private inheritance only
protected_derived A class that should inherit functions as protected.
- -
-
-
-

base

-
-A base class to test inheritance and shadowing - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-class base
-    : public base_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
base_baseA second-order base class to test indirect inheritance
-
-

Member Functions

- - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - -

Protected Member Functions

- - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
- - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
derived - A class that derives from base and excluded_base
-
-
-
-
-

base::base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base_base&
-base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

base::base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base_base&
-do_base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

base::do_base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base_base

-
-A second-order base class to test indirect inheritance - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-class base_base;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
base - A base class to test inheritance and shadowing
-
-
-
-
-

base_base::base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base_base&
-base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

base_base::do_base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base_base&
-do_base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

derived

-
-A class that derives from base and excluded_base - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-class derived
-    : public base
-    , public excluded_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - - -
NameDescription
baseA base class to test inheritance and shadowing
excluded_base
-
-

Member Functions

- - - - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should shadow the base class function.
do_base_base_inherited This function should be indirectly inherited by derived classes.
do_derived_shadowed This function should shadow the base class function.
excluded_inherited This function should be inherited by derived classes.
- - -

Protected Member Functions

- - - - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
do_excluded_inherited This function should be inherited by derived classes.
do_shadowed This function should be shadowed by derived classes.
- - -
-
-
-

derived::base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base_base&
-base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

derived::base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

derived::base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that derives from base and excluded_base -
-
-
-
-

derived::do_base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base_base&
-do_base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that derives from base and excluded_base -
-
-
-
-

derived::excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-excluded_base&
-excluded_inherited();
-
-
-
-
-
-
-
-

derived::do_base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

derived::do_base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

derived::do_derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

derived::do_excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-excluded_base&
-do_excluded_inherited();
-
-
-
-
-
-
-
-

derived::do_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-excluded_base&
-do_shadowed();
-
-
-
-
-
-
-
-

private_derived

-
-A class that uses private inheritance only - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-class private_derived
-    : base
-    , excluded_base
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - - -
-
-
-

private_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-private_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that uses private inheritance only -
-
-
-
-

private_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-private_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that uses private inheritance only -
-
-
-
-

protected_derived

-
-A class that should inherit functions as protected. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-class protected_derived
-    : protected base
-    , protected excluded_base
-
-
-
-
-
-

Protected Base Classes

- - - - - - - - - - - -
NameDescription
baseA base class to test inheritance and shadowing
excluded_base
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - -

Protected Member Functions

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
do_excluded_inherited This function should be inherited by derived classes.
do_shadowed This function should be shadowed by derived classes.
excluded_inherited This function should be inherited by derived classes.
- - -
-
-
-

protected_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-protected_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that should inherit functions as protected. -
-
-
-
-

protected_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-protected_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that should inherit functions as protected. -
-
-
-
-

protected_derived::base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base_base&
-base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

protected_derived::base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

protected_derived::base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

protected_derived::derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

protected_derived::do_base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base_base&
-do_base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

protected_derived::do_base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

protected_derived::do_base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

protected_derived::do_derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-base&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

protected_derived::do_excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-excluded_base&
-do_excluded_inherited();
-
-
-
-
-
-
-
-

protected_derived::do_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-excluded_base&
-do_shadowed();
-
-
-
-
-
-
-
-

protected_derived::excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <copy.cpp>
-
-excluded_base&
-excluded_inherited();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/copy.xml b/test-files/golden-tests/config/inherit-base-members/copy.xml deleted file mode 100644 index e2a9fdb77..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy.xml +++ /dev/null @@ -1,641 +0,0 @@ - - - - - - - - - - - A base class to test inheritance and shadowing - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - - - A class that derives from base and excluded_base - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that derives from base and excluded_base - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that derives from base and excluded_base - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - - - A class that uses private inheritance only - - - - - - - - - - - - This function should shadow the base class function. - - - A class that uses private inheritance only - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that uses private inheritance only - - - - - - - - - - - - - - - A class that should inherit functions as protected. - - - - - - - - - - - - This function should shadow the base class function. - - - A class that should inherit functions as protected. - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that should inherit functions as protected. - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - diff --git a/test-files/golden-tests/config/inherit-base-members/copy.yml b/test-files/golden-tests/config/inherit-base-members/copy.yml deleted file mode 100644 index 5a9766d7f..000000000 --- a/test-files/golden-tests/config/inherit-base-members/copy.yml +++ /dev/null @@ -1,5 +0,0 @@ -inherit-base-members: copy-all -exclude-symbols: - - excluded_base -extract-private-bases: true -warn-no-paramdoc: false \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/never.adoc b/test-files/golden-tests/config/inherit-base-members/never.adoc deleted file mode 100644 index 12603fb45..000000000 --- a/test-files/golden-tests/config/inherit-base-members/never.adoc +++ /dev/null @@ -1,499 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| A base class to test inheritance and shadowing -| link:#base_base[`base_base`] -| A second‐order base class to test indirect inheritance -| link:#derived[`derived`] -| A class that derives from base and excluded_base -| link:#private_derived[`private_derived`] -| A class that uses private inheritance only -| link:#protected_derived[`protected_derived`] -| A class that should inherit functions as protected. -|=== - -[#base] -== base - -A base class to test inheritance and shadowing - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base - : public link:#base_base[base_base] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base_base[base_base]` -| A second‐order base class to test indirect inheritance -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-derived_shadowed[`derived_shadowed`] -| This function should be shadowed by derived classes. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#derived[`derived`] -| A class that derives from base and excluded_base -|=== - -[#base-base_inherited] -== link:#base[base]::base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-base_shadowed] -== link:#base[base]::base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-derived_shadowed] -== link:#base[base]::derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_base_inherited] -== link:#base[base]::do_base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_base_shadowed] -== link:#base[base]::do_base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_derived_shadowed] -== link:#base[base]::do_derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base_base] -== base_base - -A second‐order base class to test indirect inheritance - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base_base; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| A base class to test inheritance and shadowing -|=== - -[#base_base-base_base_inherited] -== link:#base_base[base_base]::base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#base_base-do_base_base_inherited] -== link:#base_base[base_base]::do_base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -do_base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#derived] -== derived - -A class that derives from base and excluded_base - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class derived - : public link:#base[base] - , public excluded_base ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| A base class to test inheritance and shadowing -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -[#derived-derived_shadowed] -== link:#derived[derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that derives from base and excluded_base - -[#derived-do_derived_shadowed] -== link:#derived[derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that derives from base and excluded_base - -[#private_derived] -== private_derived - -A class that uses private inheritance only - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class private_derived - : link:#base[base] - , excluded_base ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#private_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#private_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -[#private_derived-derived_shadowed] -== link:#private_derived[private_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that uses private inheritance only - -[#private_derived-do_derived_shadowed] -== link:#private_derived[private_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that uses private inheritance only - -[#protected_derived] -== protected_derived - -A class that should inherit functions as protected. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class protected_derived - : protected link:#base[base] - , protected excluded_base ----- - -=== Protected Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| A base class to test inheritance and shadowing -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#protected_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#protected_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -[#protected_derived-derived_shadowed] -== link:#protected_derived[protected_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that should inherit functions as protected. - -[#protected_derived-do_derived_shadowed] -== link:#protected_derived[protected_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<never.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that should inherit functions as protected. - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/inherit-base-members/never.cpp b/test-files/golden-tests/config/inherit-base-members/never.cpp deleted file mode 100644 index eff6deaf5..000000000 --- a/test-files/golden-tests/config/inherit-base-members/never.cpp +++ /dev/null @@ -1,86 +0,0 @@ -/// A base class excluded from the documentation -class excluded_base { -public: - /// This function should be shadowed by derived classes. - excluded_base& derived_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& excluded_inherited(); -protected: - /// This function should be shadowed by derived classes. - excluded_base& do_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& do_base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& do_excluded_inherited(); -}; - -/// A second-order base class to test indirect inheritance -class base_base { -public: - /// This function should be indirectly inherited by derived classes. - base_base& base_base_inherited(); -public: - /// This function should be indirectly inherited by derived classes. - base_base& do_base_base_inherited(); -}; - -/// A base class to test inheritance and shadowing -class base : - public base_base -{ -public: - /// This function should be shadowed by derived classes. - base& derived_shadowed(); - /// This function should shadow the excluded_base function. - base& base_shadowed(); - /// This function should be inherited by derived classes. - base& base_inherited(); -protected: - /// This function should be shadowed by derived classes. - base& do_derived_shadowed(); - /// This function should shadow the excluded_base function. - base& do_base_shadowed(); - /// This function should be inherited by derived classes. - base& do_base_inherited(); -}; - -/// A class that derives from base and excluded_base -class derived - : public base - , public excluded_base -{ -public: - /// This function should shadow the base class function. - derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - derived& do_derived_shadowed(); -}; - -/// A class that should inherit functions as protected. -class protected_derived - : protected base - , protected excluded_base -{ -public: - /// This function should shadow the base class function. - protected_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - protected_derived& do_derived_shadowed(); -}; - -/// A class that uses private inheritance only -class private_derived - : private base - , private excluded_base -{ -public: - /// This function should shadow the base class function. - private_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - private_derived& do_derived_shadowed(); -}; diff --git a/test-files/golden-tests/config/inherit-base-members/never.html b/test-files/golden-tests/config/inherit-base-members/never.html deleted file mode 100644 index dd80b4f49..000000000 --- a/test-files/golden-tests/config/inherit-base-members/never.html +++ /dev/null @@ -1,651 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - -
NameDescription
base A base class to test inheritance and shadowing
base_base A second-order base class to test indirect inheritance
derived A class that derives from base and excluded_base
private_derived A class that uses private inheritance only
protected_derived A class that should inherit functions as protected.
- -
-
-
-

base

-
-A base class to test inheritance and shadowing - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-class base
-    : public base_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
base_baseA second-order base class to test indirect inheritance
-
-

Member Functions

- - - - - - - - - - - - - -
NameDescription
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
- - -

Protected Member Functions

- - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
- - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
derived - A class that derives from base and excluded_base
-
-
-
-
-

base::base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-base&
-base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-base&
-base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-base&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-base&
-do_base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-base&
-do_base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-base&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base_base

-
-A second-order base class to test indirect inheritance - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-class base_base;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
base - A base class to test inheritance and shadowing
-
-
-
-
-

base_base::base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-base_base&
-base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

base_base::do_base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-base_base&
-do_base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

derived

-
-A class that derives from base and excluded_base - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-class derived
-    : public base
-    , public excluded_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - - -
NameDescription
baseA base class to test inheritance and shadowing
excluded_base
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - - -
-
-
-

derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that derives from base and excluded_base -
-
-
-
-

derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that derives from base and excluded_base -
-
-
-
-

private_derived

-
-A class that uses private inheritance only - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-class private_derived
-    : base
-    , excluded_base
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - - -
-
-
-

private_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-private_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that uses private inheritance only -
-
-
-
-

private_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-private_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that uses private inheritance only -
-
-
-
-

protected_derived

-
-A class that should inherit functions as protected. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-class protected_derived
-    : protected base
-    , protected excluded_base
-
-
-
-
-
-

Protected Base Classes

- - - - - - - - - - - -
NameDescription
baseA base class to test inheritance and shadowing
excluded_base
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - - -
-
-
-

protected_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-protected_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that should inherit functions as protected. -
-
-
-
-

protected_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <never.cpp>
-
-protected_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that should inherit functions as protected. -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/never.xml b/test-files/golden-tests/config/inherit-base-members/never.xml deleted file mode 100644 index f34168d4d..000000000 --- a/test-files/golden-tests/config/inherit-base-members/never.xml +++ /dev/null @@ -1,291 +0,0 @@ - - - - - - - - - - - A base class to test inheritance and shadowing - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - - - A class that derives from base and excluded_base - - - - - - - - - - - - This function should shadow the base class function. - - - A class that derives from base and excluded_base - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that derives from base and excluded_base - - - - - - - - - - - - - - - A class that uses private inheritance only - - - - - - - - - - - - This function should shadow the base class function. - - - A class that uses private inheritance only - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that uses private inheritance only - - - - - - - - - - - - - - - A class that should inherit functions as protected. - - - - - - - - - - - - This function should shadow the base class function. - - - A class that should inherit functions as protected. - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that should inherit functions as protected. - - - - - - diff --git a/test-files/golden-tests/config/inherit-base-members/never.yml b/test-files/golden-tests/config/inherit-base-members/never.yml deleted file mode 100644 index 8ece8048c..000000000 --- a/test-files/golden-tests/config/inherit-base-members/never.yml +++ /dev/null @@ -1,5 +0,0 @@ -inherit-base-members: never -exclude-symbols: - - excluded_base -extract-private-bases: true -warn-no-paramdoc: false \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/reference.adoc b/test-files/golden-tests/config/inherit-base-members/reference.adoc deleted file mode 100644 index 4970145c6..000000000 --- a/test-files/golden-tests/config/inherit-base-members/reference.adoc +++ /dev/null @@ -1,549 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| A base class to test inheritance and shadowing -| link:#base_base[`base_base`] -| A second‐order base class to test indirect inheritance -| link:#derived[`derived`] -| A class that derives from base and excluded_base -| link:#private_derived[`private_derived`] -| A class that uses private inheritance only -| link:#protected_derived[`protected_derived`] -| A class that should inherit functions as protected. -|=== - -[#base] -== base - -A base class to test inheritance and shadowing - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base - : public link:#base_base[base_base] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base_base[base_base]` -| A second‐order base class to test indirect inheritance -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-derived_shadowed[`derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#derived[`derived`] -| A class that derives from base and excluded_base -|=== - -[#base-base_inherited] -== link:#base[base]::base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-base_shadowed] -== link:#base[base]::base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-derived_shadowed] -== link:#base[base]::derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_base_inherited] -== link:#base[base]::do_base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_inherited(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_base_shadowed] -== link:#base[base]::do_base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base-do_derived_shadowed] -== link:#base[base]::do_derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_derived_shadowed(); ----- - -=== Return Value - -A base class to test inheritance and shadowing - -[#base_base] -== base_base - -A second‐order base class to test indirect inheritance - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base_base; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| A base class to test inheritance and shadowing -|=== - -[#base_base-base_base_inherited] -== link:#base_base[base_base]::base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#base_base-do_base_base_inherited] -== link:#base_base[base_base]::do_base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -do_base_base_inherited(); ----- - -=== Return Value - -A second‐order base class to test indirect inheritance - -[#derived] -== derived - -A class that derives from base and excluded_base - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class derived - : public link:#base[base] - , public excluded_base ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| A base class to test inheritance and shadowing -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -|=== - -[#derived-derived_shadowed] -== link:#derived[derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that derives from base and excluded_base - -[#derived-do_derived_shadowed] -== link:#derived[derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that derives from base and excluded_base - -[#private_derived] -== private_derived - -A class that uses private inheritance only - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class private_derived - : link:#base[base] - , excluded_base ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#private_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#private_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -[#private_derived-derived_shadowed] -== link:#private_derived[private_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that uses private inheritance only - -[#private_derived-do_derived_shadowed] -== link:#private_derived[private_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that uses private inheritance only - -[#protected_derived] -== protected_derived - -A class that should inherit functions as protected. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class protected_derived - : protected link:#base[base] - , protected excluded_base ----- - -=== Protected Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| A base class to test inheritance and shadowing -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#protected_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#protected_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-derived_shadowed[`derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -|=== - -[#protected_derived-derived_shadowed] -== link:#protected_derived[protected_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -derived_shadowed(); ----- - -=== Return Value - -A class that should inherit functions as protected. - -[#protected_derived-do_derived_shadowed] -== link:#protected_derived[protected_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<reference.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -A class that should inherit functions as protected. - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/inherit-base-members/reference.cpp b/test-files/golden-tests/config/inherit-base-members/reference.cpp deleted file mode 100644 index eff6deaf5..000000000 --- a/test-files/golden-tests/config/inherit-base-members/reference.cpp +++ /dev/null @@ -1,86 +0,0 @@ -/// A base class excluded from the documentation -class excluded_base { -public: - /// This function should be shadowed by derived classes. - excluded_base& derived_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& excluded_inherited(); -protected: - /// This function should be shadowed by derived classes. - excluded_base& do_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& do_base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& do_excluded_inherited(); -}; - -/// A second-order base class to test indirect inheritance -class base_base { -public: - /// This function should be indirectly inherited by derived classes. - base_base& base_base_inherited(); -public: - /// This function should be indirectly inherited by derived classes. - base_base& do_base_base_inherited(); -}; - -/// A base class to test inheritance and shadowing -class base : - public base_base -{ -public: - /// This function should be shadowed by derived classes. - base& derived_shadowed(); - /// This function should shadow the excluded_base function. - base& base_shadowed(); - /// This function should be inherited by derived classes. - base& base_inherited(); -protected: - /// This function should be shadowed by derived classes. - base& do_derived_shadowed(); - /// This function should shadow the excluded_base function. - base& do_base_shadowed(); - /// This function should be inherited by derived classes. - base& do_base_inherited(); -}; - -/// A class that derives from base and excluded_base -class derived - : public base - , public excluded_base -{ -public: - /// This function should shadow the base class function. - derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - derived& do_derived_shadowed(); -}; - -/// A class that should inherit functions as protected. -class protected_derived - : protected base - , protected excluded_base -{ -public: - /// This function should shadow the base class function. - protected_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - protected_derived& do_derived_shadowed(); -}; - -/// A class that uses private inheritance only -class private_derived - : private base - , private excluded_base -{ -public: - /// This function should shadow the base class function. - private_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - private_derived& do_derived_shadowed(); -}; diff --git a/test-files/golden-tests/config/inherit-base-members/reference.html b/test-files/golden-tests/config/inherit-base-members/reference.html deleted file mode 100644 index 731d0faae..000000000 --- a/test-files/golden-tests/config/inherit-base-members/reference.html +++ /dev/null @@ -1,694 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - -
NameDescription
base A base class to test inheritance and shadowing
base_base A second-order base class to test indirect inheritance
derived A class that derives from base and excluded_base
private_derived A class that uses private inheritance only
protected_derived A class that should inherit functions as protected.
- -
-
-
-

base

-
-A base class to test inheritance and shadowing - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-class base
-    : public base_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
base_baseA second-order base class to test indirect inheritance
-
-

Member Functions

- - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - -

Protected Member Functions

- - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
- - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
derived - A class that derives from base and excluded_base
-
-
-
-
-

base::base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-base&
-base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-base&
-base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-base&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-base&
-do_base_inherited();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-base&
-do_base_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base::do_derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-base&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A base class to test inheritance and shadowing -
-
-
-
-

base_base

-
-A second-order base class to test indirect inheritance - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-class base_base;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
base - A base class to test inheritance and shadowing
-
-
-
-
-

base_base::base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-base_base&
-base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

base_base::do_base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-base_base&
-do_base_base_inherited();
-
-
-
-
-
-

Return Value

-A second-order base class to test indirect inheritance -
-
-
-
-

derived

-
-A class that derives from base and excluded_base - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-class derived
-    : public base
-    , public excluded_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - - -
NameDescription
baseA base class to test inheritance and shadowing
excluded_base
-
-

Member Functions

- - - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should shadow the base class function.
do_base_base_inherited This function should be indirectly inherited by derived classes.
do_derived_shadowed This function should shadow the base class function.
- - -

Protected Member Functions

- - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
- - -
-
-
-

derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that derives from base and excluded_base -
-
-
-
-

derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that derives from base and excluded_base -
-
-
-
-

private_derived

-
-A class that uses private inheritance only - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-class private_derived
-    : base
-    , excluded_base
-
-
-
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - - -
-
-
-

private_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-private_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that uses private inheritance only -
-
-
-
-

private_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-private_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that uses private inheritance only -
-
-
-
-

protected_derived

-
-A class that should inherit functions as protected. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-class protected_derived
-    : protected base
-    , protected excluded_base
-
-
-
-
-
-

Protected Base Classes

- - - - - - - - - - - -
NameDescription
baseA base class to test inheritance and shadowing
excluded_base
-
-

Member Functions

- - - - - - - - - - - - -
NameDescription
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - -

Protected Member Functions

- - - - - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
- - -
-
-
-

protected_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-protected_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that should inherit functions as protected. -
-
-
-
-

protected_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <reference.cpp>
-
-protected_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-A class that should inherit functions as protected. -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/reference.xml b/test-files/golden-tests/config/inherit-base-members/reference.xml deleted file mode 100644 index 6c1d01927..000000000 --- a/test-files/golden-tests/config/inherit-base-members/reference.xml +++ /dev/null @@ -1,563 +0,0 @@ - - - - - - - - - - - A base class to test inheritance and shadowing - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - - - A class that derives from base and excluded_base - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that derives from base and excluded_base - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that derives from base and excluded_base - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - - - A class that uses private inheritance only - - - - - - - - - - - - This function should shadow the base class function. - - - A class that uses private inheritance only - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that uses private inheritance only - - - - - - - - - - - - - - - A class that should inherit functions as protected. - - - - - - - - - - - - This function should shadow the base class function. - - - A class that should inherit functions as protected. - - - - - - - - - - - - - This function should shadow the base class function. - - - A class that should inherit functions as protected. - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - A second-order base class to test indirect inheritance - - - - - - - - - - - - - This function should be inherited by derived classes. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - A base class to test inheritance and shadowing - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - A base class to test inheritance and shadowing - - - - - - diff --git a/test-files/golden-tests/config/inherit-base-members/reference.yml b/test-files/golden-tests/config/inherit-base-members/reference.yml deleted file mode 100644 index 3bc703622..000000000 --- a/test-files/golden-tests/config/inherit-base-members/reference.yml +++ /dev/null @@ -1,5 +0,0 @@ -inherit-base-members: reference -exclude-symbols: - - excluded_base -extract-private-bases: true -warn-no-paramdoc: false \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/skip-special.adoc b/test-files/golden-tests/config/inherit-base-members/skip-special.adoc deleted file mode 100644 index ce79aba4d..000000000 --- a/test-files/golden-tests/config/inherit-base-members/skip-special.adoc +++ /dev/null @@ -1,755 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| -| link:#base_base[`base_base`] -| -| link:#derived[`derived`] -| -| link:#private_derived[`private_derived`] -| -| link:#protected_derived[`protected_derived`] -| Should inherit functions as protected. -|=== - -[#base] -== base - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base - : public link:#base_base[base_base] ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base_base[base_base]` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-2constructor[`base`] [.small]#[constructor]# -| Constructor should not be inherited -| link:#base-2destructor[`~base`] [.small]#[destructor]# -| Destructor should not be inherited -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-derived_shadowed[`derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#derived[`derived`] -| -|=== - -[#base-2constructor] -== link:#base[base]::base - -Constructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -base(); ----- - -[#base-2destructor] -== link:#base[base]::~base - -Destructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~base(); ----- - -[#base-base_inherited] -== link:#base[base]::base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_inherited(); ----- - -[#base-base_shadowed] -== link:#base[base]::base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -base_shadowed(); ----- - -[#base-derived_shadowed] -== link:#base[base]::derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -derived_shadowed(); ----- - -[#base-do_base_inherited] -== link:#base[base]::do_base_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_inherited(); ----- - -[#base-do_base_shadowed] -== link:#base[base]::do_base_shadowed - -This function should shadow the excluded_base function. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_base_shadowed(); ----- - -[#base-do_derived_shadowed] -== link:#base[base]::do_derived_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base[base]& -do_derived_shadowed(); ----- - -[#base_base] -== base_base - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class base_base; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-2constructor[`base_base`] [.small]#[constructor]# -| Constructor should not be inherited -| link:#base_base-2destructor[`~base_base`] [.small]#[destructor]# -| Destructor should not be inherited -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -|=== - -=== Derived Classes - -[cols=2] -|=== -| Name -| Description -| link:#base[`base`] -| -|=== - -[#base_base-2constructor] -== link:#base_base[base_base]::base_base - -Constructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -base_base(); ----- - -[#base_base-2destructor] -== link:#base_base[base_base]::~base_base - -Destructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~base_base(); ----- - -[#base_base-base_base_inherited] -== link:#base_base[base_base]::base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -base_base_inherited(); ----- - -[#base_base-do_base_base_inherited] -== link:#base_base[base_base]::do_base_base_inherited - -This function should be indirectly inherited by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#base_base[base_base]& -do_base_base_inherited(); ----- - -[#derived] -== derived - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class derived - : public link:#base[base] - , public excluded_base ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#derived-2constructor[`derived`] [.small]#[constructor]# -| Constructor should not be inherited -| link:#derived-2destructor[`~derived`] [.small]#[destructor]# -| Destructor should not be inherited -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -| link:#derived-excluded_inherited[`excluded_inherited`] -| This function should be inherited by derived classes. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#derived-do_excluded_inherited[`do_excluded_inherited`] -| This function should be inherited by derived classes. -| link:#derived-do_shadowed[`do_shadowed`] -| This function should be shadowed by derived classes. -|=== - -[#derived-2constructor] -== link:#derived[derived]::derived - -Constructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -derived(); ----- - -[#derived-2destructor] -== link:#derived[derived]::~derived - -Destructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~derived(); ----- - -[#derived-derived_shadowed] -== link:#derived[derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -derived_shadowed(); ----- - -[#derived-do_derived_shadowed] -== link:#derived[derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#derived[derived]& -do_derived_shadowed(); ----- - -[#derived-excluded_inherited] -== link:#derived[derived]::excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -excluded_inherited(); ----- - -[#derived-do_excluded_inherited] -== link:#derived[derived]::do_excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_excluded_inherited(); ----- - -[#derived-do_shadowed] -== link:#derived[derived]::do_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_shadowed(); ----- - -[#private_derived] -== private_derived - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class private_derived - : link:#base[base] - , excluded_base ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#private_derived-2constructor[`private_derived`] [.small]#[constructor]# -| Constructor should not be inherited -| link:#private_derived-2destructor[`~private_derived`] [.small]#[destructor]# -| Destructor should not be inherited -| link:#private_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#private_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -[#private_derived-2constructor] -== link:#private_derived[private_derived]::private_derived - -Constructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -private_derived(); ----- - -[#private_derived-2destructor] -== link:#private_derived[private_derived]::~private_derived - -Destructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~private_derived(); ----- - -[#private_derived-derived_shadowed] -== link:#private_derived[private_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -derived_shadowed(); ----- - -[#private_derived-do_derived_shadowed] -== link:#private_derived[private_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#private_derived[private_derived]& -do_derived_shadowed(); ----- - -[#protected_derived] -== protected_derived - -Should inherit functions as protected. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class protected_derived - : protected link:#base[base] - , protected excluded_base ----- - -=== Protected Base Classes - -[cols=2] -|=== -| Name -| Description -| `link:#base[base]` -| -| `excluded_base` -| -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#protected_derived-2constructor[`protected_derived`] [.small]#[constructor]# -| Constructor should not be inherited -| link:#protected_derived-2destructor[`~protected_derived`] [.small]#[destructor]# -| Destructor should not be inherited -| link:#protected_derived-derived_shadowed[`derived_shadowed`] -| This function should shadow the base class function. -| link:#protected_derived-do_derived_shadowed[`do_derived_shadowed`] -| This function should shadow the base class function. -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#base_base-base_base_inherited[`base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-base_inherited[`base_inherited`] -| This function should be inherited by derived classes. -| link:#base-base_shadowed[`base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-derived_shadowed[`derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#base_base-do_base_base_inherited[`do_base_base_inherited`] -| This function should be indirectly inherited by derived classes. -| link:#base-do_base_inherited[`do_base_inherited`] -| This function should be inherited by derived classes. -| link:#base-do_base_shadowed[`do_base_shadowed`] -| This function should shadow the excluded_base function. -| link:#base-do_derived_shadowed[`do_derived_shadowed`] -| This function should be shadowed by derived classes. -| link:#protected_derived-do_excluded_inherited[`do_excluded_inherited`] -| This function should be inherited by derived classes. -| link:#protected_derived-do_shadowed[`do_shadowed`] -| This function should be shadowed by derived classes. -| link:#protected_derived-excluded_inherited[`excluded_inherited`] -| This function should be inherited by derived classes. -|=== - -[#protected_derived-2constructor] -== link:#protected_derived[protected_derived]::protected_derived - -Constructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -protected_derived(); ----- - -[#protected_derived-2destructor] -== link:#protected_derived[protected_derived]::~protected_derived - -Destructor should not be inherited - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~protected_derived(); ----- - -[#protected_derived-derived_shadowed] -== link:#protected_derived[protected_derived]::derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -derived_shadowed(); ----- - -=== Return Value - -Should inherit functions as protected. - -[#protected_derived-do_derived_shadowed] -== link:#protected_derived[protected_derived]::do_derived_shadowed - -This function should shadow the base class function. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#protected_derived[protected_derived]& -do_derived_shadowed(); ----- - -=== Return Value - -Should inherit functions as protected. - -[#protected_derived-do_excluded_inherited] -== link:#protected_derived[protected_derived]::do_excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_excluded_inherited(); ----- - -[#protected_derived-do_shadowed] -== link:#protected_derived[protected_derived]::do_shadowed - -This function should be shadowed by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -do_shadowed(); ----- - -[#protected_derived-excluded_inherited] -== link:#protected_derived[protected_derived]::excluded_inherited - -This function should be inherited by derived classes. - -=== Synopsis - -Declared in `<skip‐special.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -excluded_base& -excluded_inherited(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/inherit-base-members/skip-special.cpp b/test-files/golden-tests/config/inherit-base-members/skip-special.cpp deleted file mode 100644 index b8ac9b61d..000000000 --- a/test-files/golden-tests/config/inherit-base-members/skip-special.cpp +++ /dev/null @@ -1,122 +0,0 @@ -/* - A version similar to copy.cpp, with special member functions - that should not be inherited. - */ - -class excluded_base { -public: - /// Constructor should not be inherited - excluded_base(); - - /// Destructor should not be inherited - ~excluded_base(); - - /// This function should be shadowed by derived classes. - excluded_base& derived_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& excluded_inherited(); -protected: - /// This function should be shadowed by derived classes. - excluded_base& do_shadowed(); - /// This function should be shadowed by the base class. - excluded_base& do_base_shadowed(); - /// This function should be inherited by derived classes. - excluded_base& do_excluded_inherited(); -}; - -class base_base { -public: - /// Constructor should not be inherited - base_base(); - - /// Destructor should not be inherited - ~base_base(); - - /// This function should be indirectly inherited by derived classes. - base_base& base_base_inherited(); -public: - /// This function should be indirectly inherited by derived classes. - base_base& do_base_base_inherited(); -}; - -class base : - public base_base -{ -public: - /// Constructor should not be inherited - base(); - - /// Destructor should not be inherited - ~base(); - - /// This function should be shadowed by derived classes. - base& derived_shadowed(); - /// This function should shadow the excluded_base function. - base& base_shadowed(); - /// This function should be inherited by derived classes. - base& base_inherited(); -protected: - /// This function should be shadowed by derived classes. - base& do_derived_shadowed(); - /// This function should shadow the excluded_base function. - base& do_base_shadowed(); - /// This function should be inherited by derived classes. - base& do_base_inherited(); -}; - -class derived - : public base - , public excluded_base -{ -public: - /// Constructor should not be inherited - derived(); - - /// Destructor should not be inherited - ~derived(); - - /// This function should shadow the base class function. - derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - derived& do_derived_shadowed(); -}; - -/// Should inherit functions as protected. -class protected_derived - : protected base - , protected excluded_base -{ -public: - /// Constructor should not be inherited - protected_derived(); - - /// Destructor should not be inherited - ~protected_derived(); - - /// This function should shadow the base class function. - protected_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - protected_derived& do_derived_shadowed(); -}; - -class private_derived - : private base - , private excluded_base -{ -public: - /// Constructor should not be inherited - private_derived(); - - /// Destructor should not be inherited - ~private_derived(); - - /// This function should shadow the base class function. - private_derived& derived_shadowed(); -public: - /// This function should shadow the base class function. - private_derived& do_derived_shadowed(); -}; diff --git a/test-files/golden-tests/config/inherit-base-members/skip-special.html b/test-files/golden-tests/config/inherit-base-members/skip-special.html deleted file mode 100644 index a047bd876..000000000 --- a/test-files/golden-tests/config/inherit-base-members/skip-special.html +++ /dev/null @@ -1,956 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - -
NameDescription
base
base_base
derived
private_derived
protected_derived Should inherit functions as protected.
- -
-
-
-

base

-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-class base
-    : public base_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
base_base
-
-

Member Functions

- - - - - - - - - - - - - - - - - -
NameDescription
base [constructor]Constructor should not be inherited
~base [destructor]Destructor should not be inherited
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - -

Protected Member Functions

- - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
- - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
derived -
-
-
-
-
-

base::base

-
-Constructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base();
-
-
-
-
-
-
-
-

base::~base

-
-Destructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-~base();
-
-
-
-
-
-
-
-

base::base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base&
-base_inherited();
-
-
-
-
-
-
-
-

base::base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base&
-base_shadowed();
-
-
-
-
-
-
-
-

base::derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base&
-derived_shadowed();
-
-
-
-
-
-
-
-

base::do_base_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base&
-do_base_inherited();
-
-
-
-
-
-
-
-

base::do_base_shadowed

-
-This function should shadow the excluded_base function. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base&
-do_base_shadowed();
-
-
-
-
-
-
-
-

base::do_derived_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base&
-do_derived_shadowed();
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-class base_base;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - -
NameDescription
base_base [constructor]Constructor should not be inherited
~base_base [destructor]Destructor should not be inherited
base_base_inherited This function should be indirectly inherited by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
- - - -
-

Derived Classes

- - - - - - - - - - -
NameDescription
base -
-
-
-
-
-

base_base::base_base

-
-Constructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base_base();
-
-
-
-
-
-
-
-

base_base::~base_base

-
-Destructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-~base_base();
-
-
-
-
-
-
-
-

base_base::base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base_base&
-base_base_inherited();
-
-
-
-
-
-
-
-

base_base::do_base_base_inherited

-
-This function should be indirectly inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-base_base&
-do_base_base_inherited();
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-class derived
-    : public base
-    , public excluded_base
-
-
-
-
-
-

Base Classes

- - - - - - - - - - - -
NameDescription
base
excluded_base
-
-

Member Functions

- - - - - - - - - - - - - - - - - - - -
NameDescription
derived [constructor]Constructor should not be inherited
~derived [destructor]Destructor should not be inherited
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should shadow the base class function.
do_base_base_inherited This function should be indirectly inherited by derived classes.
do_derived_shadowed This function should shadow the base class function.
excluded_inherited This function should be inherited by derived classes.
- - -

Protected Member Functions

- - - - - - - - - - - - - - - -
NameDescription
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
do_excluded_inherited This function should be inherited by derived classes.
do_shadowed This function should be shadowed by derived classes.
- - -
-
-
-

derived::derived

-
-Constructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-derived();
-
-
-
-
-
-
-
-

derived::~derived

-
-Destructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-~derived();
-
-
-
-
-
-
-
-

derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-derived&
-derived_shadowed();
-
-
-
-
-
-
-
-

derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-derived&
-do_derived_shadowed();
-
-
-
-
-
-
-
-

derived::excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-excluded_base&
-excluded_inherited();
-
-
-
-
-
-
-
-

derived::do_excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-excluded_base&
-do_excluded_inherited();
-
-
-
-
-
-
-
-

derived::do_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-excluded_base&
-do_shadowed();
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-class private_derived
-    : base
-    , excluded_base
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - -
NameDescription
private_derived [constructor]Constructor should not be inherited
~private_derived [destructor]Destructor should not be inherited
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - - -
-
-
-

private_derived::private_derived

-
-Constructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-private_derived();
-
-
-
-
-
-
-
-

private_derived::~private_derived

-
-Destructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-~private_derived();
-
-
-
-
-
-
-
-

private_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-private_derived&
-derived_shadowed();
-
-
-
-
-
-
-
-

private_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-private_derived&
-do_derived_shadowed();
-
-
-
-
-
-
-
-

protected_derived

-
-Should inherit functions as protected. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-class protected_derived
-    : protected base
-    , protected excluded_base
-
-
-
-
-
-

Protected Base Classes

- - - - - - - - - - - -
NameDescription
base
excluded_base
-
-

Member Functions

- - - - - - - - - - - - - - -
NameDescription
protected_derived [constructor]Constructor should not be inherited
~protected_derived [destructor]Destructor should not be inherited
derived_shadowed This function should shadow the base class function.
do_derived_shadowed This function should shadow the base class function.
- - -

Protected Member Functions

- - - - - - - - - - - - - - - - - - - - - -
NameDescription
base_base_inherited This function should be indirectly inherited by derived classes.
base_inherited This function should be inherited by derived classes.
base_shadowed This function should shadow the excluded_base function.
derived_shadowed This function should be shadowed by derived classes.
do_base_base_inherited This function should be indirectly inherited by derived classes.
do_base_inherited This function should be inherited by derived classes.
do_base_shadowed This function should shadow the excluded_base function.
do_derived_shadowed This function should be shadowed by derived classes.
do_excluded_inherited This function should be inherited by derived classes.
do_shadowed This function should be shadowed by derived classes.
excluded_inherited This function should be inherited by derived classes.
- - -
-
-
-

protected_derived::protected_derived

-
-Constructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-protected_derived();
-
-
-
-
-
-
-
-

protected_derived::~protected_derived

-
-Destructor should not be inherited - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-~protected_derived();
-
-
-
-
-
-
-
-

protected_derived::derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-protected_derived&
-derived_shadowed();
-
-
-
-
-
-

Return Value

-Should inherit functions as protected. -
-
-
-
-

protected_derived::do_derived_shadowed

-
-This function should shadow the base class function. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-protected_derived&
-do_derived_shadowed();
-
-
-
-
-
-

Return Value

-Should inherit functions as protected. -
-
-
-
-

protected_derived::do_excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-excluded_base&
-do_excluded_inherited();
-
-
-
-
-
-
-
-

protected_derived::do_shadowed

-
-This function should be shadowed by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-excluded_base&
-do_shadowed();
-
-
-
-
-
-
-
-

protected_derived::excluded_inherited

-
-This function should be inherited by derived classes. - -
-
-
-

Synopsis

-
-Declared in <skip-special.cpp>
-
-excluded_base&
-excluded_inherited();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/inherit-base-members/skip-special.xml b/test-files/golden-tests/config/inherit-base-members/skip-special.xml deleted file mode 100644 index bbb51ca5e..000000000 --- a/test-files/golden-tests/config/inherit-base-members/skip-special.xml +++ /dev/null @@ -1,614 +0,0 @@ - - - - - - - - - - - - - Constructor should not be inherited - - - - - - - - Destructor should not be inherited - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - Constructor should not be inherited - - - - - - - - Destructor should not be inherited - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - - - - - - - - - - - - - - - Constructor should not be inherited - - - - - - - - Destructor should not be inherited - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - - - - - - - - - - - This function should shadow the base class function. - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - - - - - - - - - - - This function should shadow the base class function. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - - - - - Constructor should not be inherited - - - - - - - - Destructor should not be inherited - - - - - - - - - - - - - This function should shadow the base class function. - - - - - - - - - - - - - This function should shadow the base class function. - - - - - - - - - - - - - - - Should inherit functions as protected. - - - - - - - Constructor should not be inherited - - - - - - - - Destructor should not be inherited - - - - - - - - - - - - - This function should shadow the base class function. - - - Should inherit functions as protected. - - - - - - - - - - - - - This function should shadow the base class function. - - - Should inherit functions as protected. - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - This function should be indirectly inherited by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should shadow the excluded_base function. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - - - - - - - - This function should be shadowed by derived classes. - - - - - - - - - - - - - This function should be inherited by derived classes. - - - - - - diff --git a/test-files/golden-tests/config/inherit-base-members/skip-special.yml b/test-files/golden-tests/config/inherit-base-members/skip-special.yml deleted file mode 100644 index 9d5f26010..000000000 --- a/test-files/golden-tests/config/inherit-base-members/skip-special.yml +++ /dev/null @@ -1,5 +0,0 @@ -inherit-base-members: copy-dependencies -exclude-symbols: - - excluded_base -extract-private-bases: true -warn-no-paramdoc: false diff --git a/test-files/golden-tests/config/legible-names/constructor.adoc b/test-files/golden-tests/config/legible-names/constructor.adoc deleted file mode 100644 index 13a03218d..000000000 --- a/test-files/golden-tests/config/legible-names/constructor.adoc +++ /dev/null @@ -1,207 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#X[`X`] -|=== - -[#X] -== X - -=== Synopsis - -Declared in `<constructor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct X; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#X-2constructor-08[`X`] [.small]#[constructor]# -| Constructors -|=== - -[#X-2constructor-08] -== link:#X[X]::X - -Constructors - -=== Synopses - -Declared in `<constructor.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-0e8[X](); ----- - -[.small]#link:#X-2constructor-0e8[_» more..._]# - -Copy constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-0e0[X](link:#X[X] const& other); ----- - -[.small]#link:#X-2constructor-0e0[_» more..._]# - -Move constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-069[X](link:#X[X]&& other); ----- - -[.small]#link:#X-2constructor-069[_» more..._]# - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-07[X](int value); ----- - -[.small]#link:#X-2constructor-07[_» more..._]# - -Construct from `double` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#X-2constructor-06f[X](double value); ----- - -[.small]#link:#X-2constructor-06f[_» more..._]# - -[#X-2constructor-0e8] -== link:#X[X]::X - -Default constructor - -=== Synopsis - -Declared in `<constructor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(); ----- - -[#X-2constructor-0e0] -== link:#X[X]::X - -Copy constructor - -=== Synopsis - -Declared in `<constructor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(link:#X[X] const& other); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy construct from -|=== - -[#X-2constructor-069] -== link:#X[X]::X - -Move constructor - -=== Synopsis - -Declared in `<constructor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(link:#X[X]&& other); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move construct from -|=== - -[#X-2constructor-07] -== link:#X[X]::X - -Construct from `int` - -=== Synopsis - -Declared in `<constructor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#X-2constructor-06f] -== link:#X[X]::X - -Construct from `double` - -=== Synopsis - -Declared in `<constructor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -X(double value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/legible-names/constructor.cpp b/test-files/golden-tests/config/legible-names/constructor.cpp deleted file mode 100644 index 5d39f0dbd..000000000 --- a/test-files/golden-tests/config/legible-names/constructor.cpp +++ /dev/null @@ -1,9 +0,0 @@ -// Disambiguate constructors - -struct X { - X(); - X(X const& other); - X(X&& other); - X(int); - X(double); -}; \ No newline at end of file diff --git a/test-files/golden-tests/config/legible-names/constructor.html b/test-files/golden-tests/config/legible-names/constructor.html deleted file mode 100644 index 897c3fdf4..000000000 --- a/test-files/golden-tests/config/legible-names/constructor.html +++ /dev/null @@ -1,276 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
X
- -
-
-
-

X

-
-
-

Synopsis

-
-Declared in <constructor.cpp>
-
-struct X;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
X [constructor]Constructors
- - - -
-
-
-

X::X

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <constructor.cpp>
-Default constructor -
-X();
-
-
-
» more... - -Copy constructor -
-X(X const& other);
-
-
-
» more... - -Move constructor -
-X(X&& other);
-
-
-
» more... - -Construct from int -
-X(int value);
-
-
-
» more... - -Construct from double -
-X(double value);
-
-
-
» more... - - -
-
-
-
-

X::X

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <constructor.cpp>
-
-X();
-
-
-
-
-
-
-
-

X::X

-
-Copy constructor - -
-
-
-

Synopsis

-
-Declared in <constructor.cpp>
-
-X(X const& other);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy construct from
-
-
-
-
-

X::X

-
-Move constructor - -
-
-
-

Synopsis

-
-Declared in <constructor.cpp>
-
-X(X&& other);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move construct from
-
-
-
-
-

X::X

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <constructor.cpp>
-
-X(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

X::X

-
-Construct from double - -
-
-
-

Synopsis

-
-Declared in <constructor.cpp>
-
-X(double value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/legible-names/constructor.xml b/test-files/golden-tests/config/legible-names/constructor.xml deleted file mode 100644 index f2e44968b..000000000 --- a/test-files/golden-tests/config/legible-names/constructor.xml +++ /dev/null @@ -1,79 +0,0 @@ - - - - - - - - - - Default constructor - - - - - - - - - - - - - Copy constructor - - - The object to copy construct from - - - - - - - - - - - - - Move constructor - - - The object to move construct from - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - - - - Construct from - double - - - The value to construct from - - - - - - diff --git a/test-files/golden-tests/config/missing-include-prefixes/main.adoc b/test-files/golden-tests/config/missing-include-prefixes/main.adoc deleted file mode 100644 index c29cf627a..000000000 --- a/test-files/golden-tests/config/missing-include-prefixes/main.adoc +++ /dev/null @@ -1,43 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#f[`f`] -| link:#g[`g`] -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<main.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -unknown_type -f(); ----- - -[#g] -== g - -=== Synopsis - -Declared in `<main.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -unknown_ns::unknown_type -g(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/missing-include-prefixes/main.cpp b/test-files/golden-tests/config/missing-include-prefixes/main.cpp deleted file mode 100644 index 44703e71a..000000000 --- a/test-files/golden-tests/config/missing-include-prefixes/main.cpp +++ /dev/null @@ -1,8 +0,0 @@ -// forgiven by "llvm/" prefix - includes an empty file instead -#include - -unknown_type -f(); - -unknown_ns::unknown_type -g(); diff --git a/test-files/golden-tests/config/missing-include-prefixes/main.html b/test-files/golden-tests/config/missing-include-prefixes/main.html deleted file mode 100644 index dc2bb0d2e..000000000 --- a/test-files/golden-tests/config/missing-include-prefixes/main.html +++ /dev/null @@ -1,65 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - -
Name
f
g
- -
-
-
-

f

-
-
-

Synopsis

-
-Declared in <main.cpp>
-
-unknown_type
-f();
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <main.cpp>
-
-unknown_ns::unknown_type
-g();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/missing-include-prefixes/main.xml b/test-files/golden-tests/config/missing-include-prefixes/main.xml deleted file mode 100644 index 2277dc506..000000000 --- a/test-files/golden-tests/config/missing-include-prefixes/main.xml +++ /dev/null @@ -1,18 +0,0 @@ - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/missing-include-prefixes/main.yml b/test-files/golden-tests/config/missing-include-prefixes/main.yml deleted file mode 100644 index b48410686..000000000 --- a/test-files/golden-tests/config/missing-include-prefixes/main.yml +++ /dev/null @@ -1,2 +0,0 @@ -missing-include-prefixes: - - "llvm/" diff --git a/test-files/golden-tests/config/missing-include-shims/main.adoc b/test-files/golden-tests/config/missing-include-shims/main.adoc deleted file mode 100644 index 185fd9112..000000000 --- a/test-files/golden-tests/config/missing-include-shims/main.adoc +++ /dev/null @@ -1,37 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f[`f`] -| Function satisfied by missing‐include‐shims -|=== - -[#f] -== f - -Function satisfied by missing‐include‐shims - -=== Synopsis - -Declared in `<main.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -llvm::StringRef -f(); ----- - -=== Return Value - -An empty string of a type defined in the shims. - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/missing-include-shims/main.cpp b/test-files/golden-tests/config/missing-include-shims/main.cpp deleted file mode 100644 index d0521e75e..000000000 --- a/test-files/golden-tests/config/missing-include-shims/main.cpp +++ /dev/null @@ -1,8 +0,0 @@ -#include - -/** Function satisfied by missing-include-shims - - @return An empty string of a type defined in the shims. - */ -llvm::StringRef -f(); diff --git a/test-files/golden-tests/config/missing-include-shims/main.html b/test-files/golden-tests/config/missing-include-shims/main.html deleted file mode 100644 index cb7d1d50b..000000000 --- a/test-files/golden-tests/config/missing-include-shims/main.html +++ /dev/null @@ -1,57 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - -
NameDescription
f Function satisfied by missing-include-shims
- -
-
-
-

f

-
-Function satisfied by missing-include-shims - -
-
-
-

Synopsis

-
-Declared in <main.cpp>
-
-llvm::StringRef
-f();
-
-
-
-
-
-

Return Value

-An empty string of a type defined in the shims. -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/missing-include-shims/main.xml b/test-files/golden-tests/config/missing-include-shims/main.xml deleted file mode 100644 index d1ded87ad..000000000 --- a/test-files/golden-tests/config/missing-include-shims/main.xml +++ /dev/null @@ -1,20 +0,0 @@ - - - - - - - - - - - Function satisfied by missing-include-shims - - - An empty string of a type defined in the shims. - - - - - diff --git a/test-files/golden-tests/config/missing-include-shims/main.yml b/test-files/golden-tests/config/missing-include-shims/main.yml deleted file mode 100644 index c30fd6f0f..000000000 --- a/test-files/golden-tests/config/missing-include-shims/main.yml +++ /dev/null @@ -1,8 +0,0 @@ -missing-include-shims: - # Minimal shim for a commonly included LLVM header. - # Only declare enough for libclang to parse downstream code. - "llvm/ADT/StringRef.h": | - namespace llvm { - class StringRef; - } // namespace llvm - diff --git a/test-files/golden-tests/config/overloads/const-mutable.adoc b/test-files/golden-tests/config/overloads/const-mutable.adoc deleted file mode 100644 index 1c99cbc9b..000000000 --- a/test-files/golden-tests/config/overloads/const-mutable.adoc +++ /dev/null @@ -1,89 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#C[`C`] -|=== - -[#C] -== C - -=== Synopsis - -Declared in `<const‐mutable.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class C; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#C-foo-0e[`foo`] -| -|=== - -[#C-foo-0e] -== link:#C[C]::foo - -=== Synopses - -Declared in `<const‐mutable.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -link:#C-foo-0b[foo](); ----- - -[.small]#link:#C-foo-0b[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -link:#C-foo-07[foo]() const; ----- - -[.small]#link:#C-foo-07[_» more..._]# - -[#C-foo-0b] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<const‐mutable.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -foo(); ----- - -[#C-foo-07] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<const‐mutable.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int& -foo() const; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/overloads/const-mutable.cpp b/test-files/golden-tests/config/overloads/const-mutable.cpp deleted file mode 100644 index 5abe33e90..000000000 --- a/test-files/golden-tests/config/overloads/const-mutable.cpp +++ /dev/null @@ -1,5 +0,0 @@ -class C { -public: - int& foo(); - int& foo() const; -}; diff --git a/test-files/golden-tests/config/overloads/const-mutable.html b/test-files/golden-tests/config/overloads/const-mutable.html deleted file mode 100644 index a23f7b019..000000000 --- a/test-files/golden-tests/config/overloads/const-mutable.html +++ /dev/null @@ -1,122 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
C
- -
-
-
-

C

-
-
-

Synopsis

-
-Declared in <const-mutable.cpp>
-
-class C;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
foo
- - - -
-
-
-

C::foo

-
-
-

Synopses

-
-Declared in <const-mutable.cpp>
- -
-int&
-foo();
-
-
-
» more... - - -
-int&
-foo() const;
-
-
-
» more... - - -
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <const-mutable.cpp>
-
-int&
-foo();
-
-
-
-
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <const-mutable.cpp>
-
-int&
-foo() const;
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/overloads/const-mutable.xml b/test-files/golden-tests/config/overloads/const-mutable.xml deleted file mode 100644 index 1d522848c..000000000 --- a/test-files/golden-tests/config/overloads/const-mutable.xml +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/overloads/visibility.adoc b/test-files/golden-tests/config/overloads/visibility.adoc deleted file mode 100644 index 320d4062f..000000000 --- a/test-files/golden-tests/config/overloads/visibility.adoc +++ /dev/null @@ -1,308 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#C[`C`] -|=== - -[#C] -== C - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class C; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#C-foo-0e[`foo`] -| -|=== - -=== Static Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#C-foo-03[`foo`] -| -|=== - -=== Protected Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#C-foo-04c[`foo`] -| -|=== - -=== Protected Static Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#C-foo-048[`foo`] -| -|=== - -[#C-foo-0e] -== link:#C[C]::foo - -=== Synopses - -Declared in `<visibility.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -link:#C-foo-0b[foo](); ----- - -[.small]#link:#C-foo-0b[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -link:#C-foo-06[foo](bool); ----- - -[.small]#link:#C-foo-06[_» more..._]# - -[#C-foo-0b] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -foo(); ----- - -[#C-foo-06] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -foo(bool); ----- - -[#C-foo-03] -== link:#C[C]::foo - -=== Synopses - -Declared in `<visibility.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -static -int -link:#C-foo-0fc[foo](int); ----- - -[.small]#link:#C-foo-0fc[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -static -int -link:#C-foo-05[foo]( - int, - bool); ----- - -[.small]#link:#C-foo-05[_» more..._]# - -[#C-foo-0fc] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -static -int -foo(int); ----- - -[#C-foo-05] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -static -int -foo( - int, - bool); ----- - -[#C-foo-04c] -== link:#C[C]::foo - -=== Synopses - -Declared in `<visibility.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -link:#C-foo-0a[foo]( - int, - int); ----- - -[.small]#link:#C-foo-0a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -link:#C-foo-0c[foo]( - int, - int, - bool); ----- - -[.small]#link:#C-foo-0c[_» more..._]# - -[#C-foo-0a] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -foo( - int, - int); ----- - -[#C-foo-0c] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -foo( - int, - int, - bool); ----- - -[#C-foo-048] -== link:#C[C]::foo - -=== Synopses - -Declared in `<visibility.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -static -int -link:#C-foo-00[foo]( - int, - int, - int); ----- - -[.small]#link:#C-foo-00[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -static -int -link:#C-foo-0f5[foo]( - int, - int, - int, - bool); ----- - -[.small]#link:#C-foo-0f5[_» more..._]# - -[#C-foo-00] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -static -int -foo( - int, - int, - int); ----- - -[#C-foo-0f5] -== link:#C[C]::foo - -=== Synopsis - -Declared in `<visibility.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -static -int -foo( - int, - int, - int, - bool); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/overloads/visibility.cpp b/test-files/golden-tests/config/overloads/visibility.cpp deleted file mode 100644 index a0670026f..000000000 --- a/test-files/golden-tests/config/overloads/visibility.cpp +++ /dev/null @@ -1,17 +0,0 @@ -class C { -public: - int foo(); - int foo(bool); - static int foo(int); - static int foo(int, bool); -protected: - int foo(int, int); - int foo(int, int, bool); - static int foo(int, int, int); - static int foo(int, int, int, bool); -private: - int foo(int, int, int, int); - int foo(int, int, int, int, bool); - static int foo(int, int, int, int, int); - static int foo(int, int, int, int, int, bool); -}; diff --git a/test-files/golden-tests/config/overloads/visibility.html b/test-files/golden-tests/config/overloads/visibility.html deleted file mode 100644 index db1619027..000000000 --- a/test-files/golden-tests/config/overloads/visibility.html +++ /dev/null @@ -1,377 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
C
- -
-
-
-

C

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-class C;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
foo
- -

Static Member Functions

- - - - - - - - - - - -
NameDescription
foo
- - -

Protected Member Functions

- - - - - - - - - - - -
NameDescription
foo
- -

Protected Static Member Functions

- - - - - - - - - - - -
NameDescription
foo
- - -
-
-
-

C::foo

-
-
-

Synopses

-
-Declared in <visibility.cpp>
- -
-int
-foo();
-
-
-
» more... - - -
-int
-foo(bool);
-
-
-
» more... - - -
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-int
-foo();
-
-
-
-
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-int
-foo(bool);
-
-
-
-
-
-
-
-

C::foo

-
-
-

Synopses

-
-Declared in <visibility.cpp>
- -
-static
-int
-foo(int);
-
-
-
» more... - - -
-static
-int
-foo(
-    int,
-    bool);
-
-
-
» more... - - -
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-static
-int
-foo(int);
-
-
-
-
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-static
-int
-foo(
-    int,
-    bool);
-
-
-
-
-
-
-
-

C::foo

-
-
-

Synopses

-
-Declared in <visibility.cpp>
- -
-int
-foo(
-    int,
-    int);
-
-
-
» more... - - -
-int
-foo(
-    int,
-    int,
-    bool);
-
-
-
» more... - - -
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-int
-foo(
-    int,
-    int);
-
-
-
-
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-int
-foo(
-    int,
-    int,
-    bool);
-
-
-
-
-
-
-
-

C::foo

-
-
-

Synopses

-
-Declared in <visibility.cpp>
- -
-static
-int
-foo(
-    int,
-    int,
-    int);
-
-
-
» more... - - -
-static
-int
-foo(
-    int,
-    int,
-    int,
-    bool);
-
-
-
» more... - - -
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-static
-int
-foo(
-    int,
-    int,
-    int);
-
-
-
-
-
-
-
-

C::foo

-
-
-

Synopsis

-
-Declared in <visibility.cpp>
-
-static
-int
-foo(
-    int,
-    int,
-    int,
-    bool);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/overloads/visibility.xml b/test-files/golden-tests/config/overloads/visibility.xml deleted file mode 100644 index db361111e..000000000 --- a/test-files/golden-tests/config/overloads/visibility.xml +++ /dev/null @@ -1,109 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/sfinae/redeclare.adoc b/test-files/golden-tests/config/sfinae/redeclare.adoc deleted file mode 100644 index 2dfd7440b..000000000 --- a/test-files/golden-tests/config/sfinae/redeclare.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#f[`f`] -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<redeclare.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -void -f(void) -requires std::is_class_v<T>; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/sfinae/redeclare.cpp b/test-files/golden-tests/config/sfinae/redeclare.cpp deleted file mode 100644 index 7eb75ff95..000000000 --- a/test-files/golden-tests/config/sfinae/redeclare.cpp +++ /dev/null @@ -1,14 +0,0 @@ -// issue #850 - -#include - -template -void f(std::enable_if_t>); - -template -void f(std::enable_if_t>); - -template -void f(std::enable_if_t>) -{ -} \ No newline at end of file diff --git a/test-files/golden-tests/config/sfinae/redeclare.html b/test-files/golden-tests/config/sfinae/redeclare.html deleted file mode 100644 index 8db003587..000000000 --- a/test-files/golden-tests/config/sfinae/redeclare.html +++ /dev/null @@ -1,50 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - -
Name
f
- -
-
-
-

f

-
-
-

Synopsis

-
-Declared in <redeclare.cpp>
-
-template<typename T>
-void
-f(void)
-requires std::is_class_v<T>;
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/sfinae/redeclare.xml b/test-files/golden-tests/config/sfinae/redeclare.xml deleted file mode 100644 index 0aca10feb..000000000 --- a/test-files/golden-tests/config/sfinae/redeclare.xml +++ /dev/null @@ -1,17 +0,0 @@ - - - - - - diff --git a/test-files/golden-tests/config/sfinae/return-based.adoc b/test-files/golden-tests/config/sfinae/return-based.adoc deleted file mode 100644 index 7db55d1fa..000000000 --- a/test-files/golden-tests/config/sfinae/return-based.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#f[`f`] -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<return‐based.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -int -f() -requires std::is_class_v<T>; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/sfinae/return-based.cpp b/test-files/golden-tests/config/sfinae/return-based.cpp deleted file mode 100644 index e701be105..000000000 --- a/test-files/golden-tests/config/sfinae/return-based.cpp +++ /dev/null @@ -1,6 +0,0 @@ -// issue #849 - -#include - -template -std::enable_if_t, int> f(); diff --git a/test-files/golden-tests/config/sfinae/return-based.html b/test-files/golden-tests/config/sfinae/return-based.html deleted file mode 100644 index 97acc194f..000000000 --- a/test-files/golden-tests/config/sfinae/return-based.html +++ /dev/null @@ -1,50 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - -
Name
f
- -
-
-
-

f

-
-
-

Synopsis

-
-Declared in <return-based.cpp>
-
-template<typename T>
-int
-f()
-requires std::is_class_v<T>;
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/sfinae/return-based.xml b/test-files/golden-tests/config/sfinae/return-based.xml deleted file mode 100644 index aad9c9e19..000000000 --- a/test-files/golden-tests/config/sfinae/return-based.xml +++ /dev/null @@ -1,15 +0,0 @@ - - - - - - diff --git a/test-files/golden-tests/config/show-namespaces/show-namespaces.adoc b/test-files/golden-tests/config/show-namespaces/show-namespaces.adoc deleted file mode 100644 index 673cef0be..000000000 --- a/test-files/golden-tests/config/show-namespaces/show-namespaces.adoc +++ /dev/null @@ -1,44 +0,0 @@ -= Reference -:mrdocs: - -[#A-B-c] -== A::B::c - -=== Synopsis - -Declared in `<show‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -c(); ----- - -[#A-b] -== A::b - -=== Synopsis - -Declared in `<show‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -b(); ----- - -[#a] -== a - -=== Synopsis - -Declared in `<show‐namespaces.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -a(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/show-namespaces/show-namespaces.cpp b/test-files/golden-tests/config/show-namespaces/show-namespaces.cpp deleted file mode 100644 index 26f5db01b..000000000 --- a/test-files/golden-tests/config/show-namespaces/show-namespaces.cpp +++ /dev/null @@ -1,9 +0,0 @@ -void a(); - -namespace A { - void b(); - namespace B { - void c(); - } -} - diff --git a/test-files/golden-tests/config/show-namespaces/show-namespaces.html b/test-files/golden-tests/config/show-namespaces/show-namespaces.html deleted file mode 100644 index af2b0caec..000000000 --- a/test-files/golden-tests/config/show-namespaces/show-namespaces.html +++ /dev/null @@ -1,62 +0,0 @@ - - -Reference - - -
-

Reference

-
- -
-

Synopsis

-
-Declared in <show-namespaces.cpp>
-
-void
-c();
-
-
-
-
-
-
-
-

A::b

-
-
-

Synopsis

-
-Declared in <show-namespaces.cpp>
-
-void
-b();
-
-
-
-
-
-
-
-

a

-
-
-

Synopsis

-
-Declared in <show-namespaces.cpp>
-
-void
-a();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/show-namespaces/show-namespaces.xml b/test-files/golden-tests/config/show-namespaces/show-namespaces.xml deleted file mode 100644 index 4413d9345..000000000 --- a/test-files/golden-tests/config/show-namespaces/show-namespaces.xml +++ /dev/null @@ -1,19 +0,0 @@ - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/show-namespaces/show-namespaces.yml b/test-files/golden-tests/config/show-namespaces/show-namespaces.yml deleted file mode 100644 index 0048c268a..000000000 --- a/test-files/golden-tests/config/show-namespaces/show-namespaces.yml +++ /dev/null @@ -1 +0,0 @@ -show-namespaces: false \ No newline at end of file diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.adoc b/test-files/golden-tests/config/sort-members-by/sort-members-by-location.adoc deleted file mode 100644 index 5d687880e..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.adoc +++ /dev/null @@ -1,285 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#Z[`Z`] -|=== - -[#Z] -== Z - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Z; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Z-2constructor-00[`Z`] [.small]#[constructor]# -| Constructors -| link:#Z-2destructor[`~Z`] [.small]#[destructor]# -| Destructor -| link:#Z-foo[`foo`] -| -| link:#Z-bar[`bar`] -| -| link:#Z-2conversion[`operator bool`] -| Conversion to `bool` -| link:#Z-operator_not[`operator!`] -| Negation operator -| link:#Z-operator_eq[`operator==`] -| Equality operator -| link:#Z-operator_not_eq[`operator!=`] -| Inequality operator -| link:#Z-operator_3way[`operator<=>`] -| Three‐way comparison operator -|=== - -[#Z-2constructor-00] -== link:#Z[Z]::Z - -Constructors - -=== Synopses - -Declared in `<sort‐members‐by‐location.cpp>` - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-06[Z](int value); ----- - -[.small]#link:#Z-2constructor-06[_» more..._]# - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-05[Z](); ----- - -[.small]#link:#Z-2constructor-05[_» more..._]# - -[#Z-2constructor-06] -== link:#Z[Z]::Z - -Construct from `int` - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#Z-2constructor-05] -== link:#Z[Z]::Z - -Default constructor - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(); ----- - -[#Z-2destructor] -== link:#Z[Z]::~Z - -Destructor - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~Z(); ----- - -[#Z-foo] -== link:#Z[Z]::foo - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -foo() const; ----- - -[#Z-bar] -== link:#Z[Z]::bar - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -bar() const; ----- - -[#Z-2conversion] -== link:#Z[Z]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator bool() const; ----- - -=== Return Value - -The object converted to `bool` - -[#Z-operator_not] -== link:#Z[Z]::operator! - -Negation operator - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!() const; ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -[#Z-operator_eq] -== link:#Z[Z]::operator== - -Equality operator - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_not_eq] -== link:#Z[Z]::operator!= - -Inequality operator - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_3way] -== link:#Z[Z]::operator<=> - -Three‐way comparison operator - -=== Synopsis - -Declared in `<sort‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -auto -operator<=>(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -The relative order of the objects - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.cpp b/test-files/golden-tests/config/sort-members-by/sort-members-by-location.cpp deleted file mode 100644 index 16bf5b4c8..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.cpp +++ /dev/null @@ -1,13 +0,0 @@ -struct Z { - auto operator<=>(Z const&) const; - bool operator!=(Z const&) const; - bool operator==(Z const&) const; - bool operator!() const; - operator bool() const; - void foo() const; - void bar() const; - ~Z(); - Z(int); - Z(); -}; - diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.html b/test-files/golden-tests/config/sort-members-by/sort-members-by-location.html deleted file mode 100644 index 3acbf2191..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.html +++ /dev/null @@ -1,376 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
Z
- -
-
-
-

Z

-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-struct Z;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - - - - - - -
NameDescription
Z [constructor]Constructors
~Z [destructor]Destructor
foo
bar
operator bool Conversion to bool
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
operator<=> Three-way comparison operator
- - - -
-
-
-

Z::Z

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <sort-members-by-location.cpp>
-Construct from int -
-Z(int value);
-
-
-
» more... - -Default constructor -
-Z();
-
-
-
» more... - - -
-
-
-
-

Z::Z

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-Z(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

Z::Z

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-Z();
-
-
-
-
-
-
-
-

Z::~Z

-
-Destructor - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-~Z();
-
-
-
-
-
-
-
-

Z::foo

-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-void
-foo() const;
-
-
-
-
-
-
-
-

Z::bar

-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-void
-bar() const;
-
-
-
-
-
-
-
-

Z::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-operator bool() const;
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
-
-

Z::operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-bool
-operator!() const;
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-
-
-

Z::operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-bool
-operator==(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-bool
-operator!=(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator<=>

-
-Three-way comparison operator - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-location.cpp>
-
-auto
-operator<=>(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-The relative order of the objects -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.xml b/test-files/golden-tests/config/sort-members-by/sort-members-by-location.xml deleted file mode 100644 index 365e73fe3..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - Default constructor - - - - - - - - Destructor - - - - - - - - - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - - Three-way comparison operator - - - The relative order of the objects - - - The right operand - - - - - - diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.yml b/test-files/golden-tests/config/sort-members-by/sort-members-by-location.yml deleted file mode 100644 index 02654f2c8..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-location.yml +++ /dev/null @@ -1,2 +0,0 @@ -sort-members: true -sort-members-by: location \ No newline at end of file diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.adoc b/test-files/golden-tests/config/sort-members-by/sort-members-by-name.adoc deleted file mode 100644 index c71581bd8..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.adoc +++ /dev/null @@ -1,285 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#Z[`Z`] -|=== - -[#Z] -== Z - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Z; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Z-2constructor-00[`Z`] [.small]#[constructor]# -| Constructors -| link:#Z-2destructor[`~Z`] [.small]#[destructor]# -| Destructor -| link:#Z-bar[`bar`] -| -| link:#Z-foo[`foo`] -| -| link:#Z-2conversion[`operator bool`] -| Conversion to `bool` -| link:#Z-operator_not[`operator!`] -| Negation operator -| link:#Z-operator_eq[`operator==`] -| Equality operator -| link:#Z-operator_not_eq[`operator!=`] -| Inequality operator -| link:#Z-operator_3way[`operator<=>`] -| Three‐way comparison operator -|=== - -[#Z-2constructor-00] -== link:#Z[Z]::Z - -Constructors - -=== Synopses - -Declared in `<sort‐members‐by‐name.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-05[Z](); ----- - -[.small]#link:#Z-2constructor-05[_» more..._]# - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-06[Z](int value); ----- - -[.small]#link:#Z-2constructor-06[_» more..._]# - -[#Z-2constructor-05] -== link:#Z[Z]::Z - -Default constructor - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(); ----- - -[#Z-2constructor-06] -== link:#Z[Z]::Z - -Construct from `int` - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#Z-2destructor] -== link:#Z[Z]::~Z - -Destructor - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~Z(); ----- - -[#Z-bar] -== link:#Z[Z]::bar - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -bar() const; ----- - -[#Z-foo] -== link:#Z[Z]::foo - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -foo() const; ----- - -[#Z-2conversion] -== link:#Z[Z]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator bool() const; ----- - -=== Return Value - -The object converted to `bool` - -[#Z-operator_not] -== link:#Z[Z]::operator! - -Negation operator - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!() const; ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -[#Z-operator_eq] -== link:#Z[Z]::operator== - -Equality operator - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_not_eq] -== link:#Z[Z]::operator!= - -Inequality operator - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_3way] -== link:#Z[Z]::operator<=> - -Three‐way comparison operator - -=== Synopsis - -Declared in `<sort‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -auto -operator<=>(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -The relative order of the objects - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.cpp b/test-files/golden-tests/config/sort-members-by/sort-members-by-name.cpp deleted file mode 100644 index 16bf5b4c8..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.cpp +++ /dev/null @@ -1,13 +0,0 @@ -struct Z { - auto operator<=>(Z const&) const; - bool operator!=(Z const&) const; - bool operator==(Z const&) const; - bool operator!() const; - operator bool() const; - void foo() const; - void bar() const; - ~Z(); - Z(int); - Z(); -}; - diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.html b/test-files/golden-tests/config/sort-members-by/sort-members-by-name.html deleted file mode 100644 index 839f92eca..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.html +++ /dev/null @@ -1,376 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
Z
- -
-
-
-

Z

-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-struct Z;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - - - - - - -
NameDescription
Z [constructor]Constructors
~Z [destructor]Destructor
bar
foo
operator bool Conversion to bool
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
operator<=> Three-way comparison operator
- - - -
-
-
-

Z::Z

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <sort-members-by-name.cpp>
-Default constructor -
-Z();
-
-
-
» more... - -Construct from int -
-Z(int value);
-
-
-
» more... - - -
-
-
-
-

Z::Z

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-Z();
-
-
-
-
-
-
-
-

Z::Z

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-Z(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

Z::~Z

-
-Destructor - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-~Z();
-
-
-
-
-
-
-
-

Z::bar

-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-void
-bar() const;
-
-
-
-
-
-
-
-

Z::foo

-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-void
-foo() const;
-
-
-
-
-
-
-
-

Z::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-operator bool() const;
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
-
-

Z::operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-bool
-operator!() const;
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-
-
-

Z::operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-bool
-operator==(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-bool
-operator!=(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator<=>

-
-Three-way comparison operator - -
-
-
-

Synopsis

-
-Declared in <sort-members-by-name.cpp>
-
-auto
-operator<=>(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-The relative order of the objects -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.xml b/test-files/golden-tests/config/sort-members-by/sort-members-by-name.xml deleted file mode 100644 index ea7587b9a..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.xml +++ /dev/null @@ -1,163 +0,0 @@ - - - - - - - - - - Default constructor - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - Destructor - - - - - - - - - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - - Three-way comparison operator - - - The relative order of the objects - - - The right operand - - - - - - diff --git a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.yml b/test-files/golden-tests/config/sort-members-by/sort-members-by-name.yml deleted file mode 100644 index 560043756..000000000 --- a/test-files/golden-tests/config/sort-members-by/sort-members-by-name.yml +++ /dev/null @@ -1,2 +0,0 @@ -sort-members: true -sort-members-by: name \ No newline at end of file diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.adoc b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.adoc deleted file mode 100644 index 5819d534a..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.adoc +++ /dev/null @@ -1,712 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#D[`D`] -| link:#C-0f[`C`] -| link:#C-0d[`C<int, char>`] -| link:#C-03[`C<int>`] -| link:#B-0b[`B`] -| link:#B-04[`B<int, char>`] -| link:#B-05[`B<int, U>`] -| link:#A[`A`] -| link:#Z[`Z`] -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#h[`h`] -| -| link:#g-0f[`g`] -| -| link:#f[`f`] -| -| link:#operator_not[`operator!`] -| Negation operator -| link:#operator_eq[`operator==`] -| Equality operator -| link:#operator_not_eq[`operator!=`] -| Inequality operator -|=== - -[#D] -== D - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct D; ----- - -[#C-0f] -== C - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - class U = void> -struct C; ----- - -[#C-0d] -== link:#C-0f[C]<int, char> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#C-0f[C]<int, char>; ----- - -[#C-03] -== link:#C-0f[C]<int> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#C-0f[C]<int>; ----- - -[#B-0b] -== B - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - class U> -struct B; ----- - -[#B-04] -== link:#B-0b[B]<int, char> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#B-0b[B]<int, char>; ----- - -[#B-05] -== link:#B-0b[B]<int, U> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class U> -struct link:#B-0b[B]<int, U>; ----- - -[#A] -== A - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#Z] -== Z - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Z; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Z-2constructor-00[`Z`] [.small]#[constructor]# -| Constructors -| link:#Z-2destructor[`~Z`] [.small]#[destructor]# -| Destructor -| link:#Z-foo[`foo`] -| -| link:#Z-2conversion[`operator bool`] -| Conversion to `bool` -| link:#Z-operator_not[`operator!`] -| Negation operator -| link:#Z-operator_eq[`operator==`] -| Equality operator -| link:#Z-operator_not_eq[`operator!=`] -| Inequality operator -| link:#Z-operator_3way[`operator<=>`] -| Three‐way comparison operator -|=== - -[#Z-2constructor-00] -== link:#Z[Z]::Z - -Constructors - -=== Synopses - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-05[Z](); ----- - -[.small]#link:#Z-2constructor-05[_» more..._]# - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-06[Z](int value); ----- - -[.small]#link:#Z-2constructor-06[_» more..._]# - -[#Z-2constructor-05] -== link:#Z[Z]::Z - -Default constructor - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(); ----- - -[#Z-2constructor-06] -== link:#Z[Z]::Z - -Construct from `int` - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#Z-2destructor] -== link:#Z[Z]::~Z - -Destructor - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~Z(); ----- - -[#Z-foo] -== link:#Z[Z]::foo - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -foo() const; ----- - -[#Z-2conversion] -== link:#Z[Z]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator bool() const; ----- - -=== Return Value - -The object converted to `bool` - -[#Z-operator_not] -== link:#Z[Z]::operator! - -Negation operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!() const; ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -[#Z-operator_eq] -== link:#Z[Z]::operator== - -Equality operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_not_eq] -== link:#Z[Z]::operator!= - -Inequality operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_3way] -== link:#Z[Z]::operator<=> - -Three‐way comparison operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -auto -operator<=>(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -The relative order of the objects - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#h] -== h - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -h(); ----- - -[#g-0f] -== g - -=== Synopses - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -char -link:#g-03c[g]( - T, - T, - T); ----- - -[.small]#link:#g-03c[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -char -link:#g-0e4[g<int>]( - int, - int, - int); ----- - -[.small]#link:#g-0e4[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-0a[g]( - char, - char, - char); ----- - -[.small]#link:#g-0a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-03a[g]( - double, - char); ----- - -[.small]#link:#g-03a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-06[g](double); ----- - -[.small]#link:#g-06[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-04[g](int); ----- - -[.small]#link:#g-04[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -link:#g-0e3[g](); ----- - -[.small]#link:#g-0e3[_» more..._]# - -[#g-03c] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -char -g( - T, - T, - T); ----- - -[#g-0e4] -== link:#g-03c[g]<int> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -char -link:#g-03c[g]<int>( - int, - int, - int); ----- - -[#g-0a] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g( - char, - char, - char); ----- - -[#g-03a] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g( - double, - char); ----- - -[#g-06] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g(double); ----- - -[#g-04] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g(int); ----- - -[#g-0e3] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -g(); ----- - -[#f] -== f - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - -[#operator_not] -== operator! - -Negation operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!(link:#A[A] const& v); ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *v* -| The operand -|=== - -[#operator_eq] -== operator== - -Equality operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_not_eq] -== operator!= - -Inequality operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐location.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.cpp b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.cpp deleted file mode 100644 index c65f3cf8d..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.cpp +++ /dev/null @@ -1,60 +0,0 @@ -struct D {}; - -template -struct C {}; - -template <> -struct C {}; - -template <> -struct C {}; - -template -struct B {}; - -template <> -struct B {}; - -template -struct B {}; - -struct A {}; - -struct Z { - auto operator<=>(Z const&) const; - bool operator!=(Z const&) const; - bool operator==(Z const&) const; - bool operator!() const; - operator bool() const; - void foo() const; - ~Z(); - Z(int); - Z(); -}; - -bool operator!=(A const& lhs, A const& rhs); -bool operator==(A const& lhs, A const& rhs); -bool operator!(A const& v); - -void h(); - -template -char g(T, T, T); - -template <> -char g(int, int, int); - -char g(char, char, char); - -char g(double, char); - -char g(double); - -char g(int); - -char g(int); - -void g(); - -void f(); - diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.html b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.html deleted file mode 100644 index e90718cb6..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.html +++ /dev/null @@ -1,904 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - - - - -
Name
D
C
C<int, char>
C<int>
B
B<int, char>
B<int, U>
A
Z
- -

Functions

- - - - - - - - - - - - - - - - -
NameDescription
h
g
f
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
- -
-
-
-

D

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-struct D;
-
-
-
-
- - -
-
-
-

C

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-template<
-    class T,
-    class U = void>
-struct C;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-template<>
-struct C<int, char>;
-
-
-
-
- - -
-
-
-

C<int>

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-template<>
-struct C<int>;
-
-
-
-
- - -
-
-
-

B

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-template<
-    class T,
-    class U>
-struct B;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-template<>
-struct B<int, char>;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-template<class U>
-struct B<int, U>;
-
-
-
-
- - -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

Z

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-struct Z;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - - - - - -
NameDescription
Z [constructor]Constructors
~Z [destructor]Destructor
foo
operator bool Conversion to bool
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
operator<=> Three-way comparison operator
- - - -
-
-
-

Z::Z

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <sort-namespace-members-by-location.cpp>
-Default constructor -
-Z();
-
-
-
» more... - -Construct from int -
-Z(int value);
-
-
-
» more... - - -
-
-
-
-

Z::Z

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-Z();
-
-
-
-
-
-
-
-

Z::Z

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-Z(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

Z::~Z

-
-Destructor - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-~Z();
-
-
-
-
-
-
-
-

Z::foo

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-void
-foo() const;
-
-
-
-
-
-
-
-

Z::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-operator bool() const;
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
-
-

Z::operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-bool
-operator!() const;
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-
-
-

Z::operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-bool
-operator==(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-bool
-operator!=(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator<=>

-
-Three-way comparison operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-auto
-operator<=>(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-The relative order of the objects -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

h

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-void
-h();
-
-
-
-
-
-
-
-

g

-
-
-

Synopses

-
-Declared in <sort-namespace-members-by-location.cpp>
- -
-template<class T>
-char
-g(
-    T,
-    T,
-    T);
-
-
-
» more... - - -
-template<>
-char
-g<int>(
-    int,
-    int,
-    int);
-
-
-
» more... - - -
-char
-g(
-    char,
-    char,
-    char);
-
-
-
» more... - - -
-char
-g(
-    double,
-    char);
-
-
-
» more... - - -
-char
-g(double);
-
-
-
» more... - - -
-char
-g(int);
-
-
-
» more... - - -
-void
-g();
-
-
-
» more... - - -
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-template<class T>
-char
-g(
-    T,
-    T,
-    T);
-
-
-
-
-
-
-
-

g<int>

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-template<>
-char
-g<int>(
-    int,
-    int,
-    int);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-char
-g(
-    char,
-    char,
-    char);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-char
-g(
-    double,
-    char);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-char
-g(double);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-char
-g(int);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-void
-g();
-
-
-
-
-
-
-
-

f

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-void
-f();
-
-
-
-
-
-
-
-

operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-bool
-operator!(A const& v);
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
vThe operand
-
-
-
-
-

operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-bool
-operator==(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-location.cpp>
-
-bool
-operator!=(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.xml b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.xml deleted file mode 100644 index 0071193ec..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.xml +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Default constructor - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - Destructor - - - - - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - - Three-way comparison operator - - - The relative order of the objects - - - The right operand - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - The operand - - - - - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The left operand - - - The right operand - - - - - diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.yml b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.yml deleted file mode 100644 index 7ca2dc8e5..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-location.yml +++ /dev/null @@ -1 +0,0 @@ -sort-namespace-members-by: location \ No newline at end of file diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.adoc b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.adoc deleted file mode 100644 index 1ba8bff7f..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.adoc +++ /dev/null @@ -1,712 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -| link:#B-0b[`B`] -| link:#B-04[`B<int, char>`] -| link:#B-05[`B<int, U>`] -| link:#C-0f[`C`] -| link:#C-03[`C<int>`] -| link:#C-0d[`C<int, char>`] -| link:#D[`D`] -| link:#Z[`Z`] -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f[`f`] -| -| link:#g-0f[`g`] -| -| link:#h[`h`] -| -| link:#operator_not[`operator!`] -| Negation operator -| link:#operator_eq[`operator==`] -| Equality operator -| link:#operator_not_eq[`operator!=`] -| Inequality operator -|=== - -[#A] -== A - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#B-0b] -== B - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - class U> -struct B; ----- - -[#B-04] -== link:#B-0b[B]<int, char> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#B-0b[B]<int, char>; ----- - -[#B-05] -== link:#B-0b[B]<int, U> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class U> -struct link:#B-0b[B]<int, U>; ----- - -[#C-0f] -== C - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - class U = void> -struct C; ----- - -[#C-03] -== link:#C-0f[C]<int> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#C-0f[C]<int>; ----- - -[#C-0d] -== link:#C-0f[C]<int, char> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#C-0f[C]<int, char>; ----- - -[#D] -== D - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct D; ----- - -[#Z] -== Z - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Z; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Z-2constructor-00[`Z`] [.small]#[constructor]# -| Constructors -| link:#Z-2destructor[`~Z`] [.small]#[destructor]# -| Destructor -| link:#Z-foo[`foo`] -| -| link:#Z-2conversion[`operator bool`] -| Conversion to `bool` -| link:#Z-operator_not[`operator!`] -| Negation operator -| link:#Z-operator_eq[`operator==`] -| Equality operator -| link:#Z-operator_not_eq[`operator!=`] -| Inequality operator -| link:#Z-operator_3way[`operator<=>`] -| Three‐way comparison operator -|=== - -[#Z-2constructor-00] -== link:#Z[Z]::Z - -Constructors - -=== Synopses - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-05[Z](); ----- - -[.small]#link:#Z-2constructor-05[_» more..._]# - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-06[Z](int value); ----- - -[.small]#link:#Z-2constructor-06[_» more..._]# - -[#Z-2constructor-05] -== link:#Z[Z]::Z - -Default constructor - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(); ----- - -[#Z-2constructor-06] -== link:#Z[Z]::Z - -Construct from `int` - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#Z-2destructor] -== link:#Z[Z]::~Z - -Destructor - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~Z(); ----- - -[#Z-foo] -== link:#Z[Z]::foo - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -foo() const; ----- - -[#Z-2conversion] -== link:#Z[Z]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator bool() const; ----- - -=== Return Value - -The object converted to `bool` - -[#Z-operator_not] -== link:#Z[Z]::operator! - -Negation operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!() const; ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -[#Z-operator_eq] -== link:#Z[Z]::operator== - -Equality operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_not_eq] -== link:#Z[Z]::operator!= - -Inequality operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_3way] -== link:#Z[Z]::operator<=> - -Three‐way comparison operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -auto -operator<=>(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -The relative order of the objects - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - -[#g-0f] -== g - -=== Synopses - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -link:#g-0e3[g](); ----- - -[.small]#link:#g-0e3[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-04[g](int); ----- - -[.small]#link:#g-04[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-06[g](double); ----- - -[.small]#link:#g-06[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-03a[g]( - double, - char); ----- - -[.small]#link:#g-03a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-0a[g]( - char, - char, - char); ----- - -[.small]#link:#g-0a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -char -link:#g-03c[g]( - T, - T, - T); ----- - -[.small]#link:#g-03c[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -char -link:#g-0e4[g<int>]( - int, - int, - int); ----- - -[.small]#link:#g-0e4[_» more..._]# - -[#g-0e3] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -g(); ----- - -[#g-04] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g(int); ----- - -[#g-06] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g(double); ----- - -[#g-03a] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g( - double, - char); ----- - -[#g-0a] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g( - char, - char, - char); ----- - -[#g-03c] -== g - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -char -g( - T, - T, - T); ----- - -[#g-0e4] -== link:#g-03c[g]<int> - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -char -link:#g-03c[g]<int>( - int, - int, - int); ----- - -[#h] -== h - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -h(); ----- - -[#operator_not] -== operator! - -Negation operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!(link:#A[A] const& v); ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *v* -| The operand -|=== - -[#operator_eq] -== operator== - -Equality operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_not_eq] -== operator!= - -Inequality operator - -=== Synopsis - -Declared in `<sort‐namespace‐members‐by‐name.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.cpp b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.cpp deleted file mode 100644 index c65f3cf8d..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.cpp +++ /dev/null @@ -1,60 +0,0 @@ -struct D {}; - -template -struct C {}; - -template <> -struct C {}; - -template <> -struct C {}; - -template -struct B {}; - -template <> -struct B {}; - -template -struct B {}; - -struct A {}; - -struct Z { - auto operator<=>(Z const&) const; - bool operator!=(Z const&) const; - bool operator==(Z const&) const; - bool operator!() const; - operator bool() const; - void foo() const; - ~Z(); - Z(int); - Z(); -}; - -bool operator!=(A const& lhs, A const& rhs); -bool operator==(A const& lhs, A const& rhs); -bool operator!(A const& v); - -void h(); - -template -char g(T, T, T); - -template <> -char g(int, int, int); - -char g(char, char, char); - -char g(double, char); - -char g(double); - -char g(int); - -char g(int); - -void g(); - -void f(); - diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.html b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.html deleted file mode 100644 index 399b5f869..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.html +++ /dev/null @@ -1,904 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - - - - -
Name
A
B
B<int, char>
B<int, U>
C
C<int>
C<int, char>
D
Z
- -

Functions

- - - - - - - - - - - - - - - - -
NameDescription
f
g
h
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
- -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

B

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-template<
-    class T,
-    class U>
-struct B;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-template<>
-struct B<int, char>;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-template<class U>
-struct B<int, U>;
-
-
-
-
- - -
-
-
-

C

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-template<
-    class T,
-    class U = void>
-struct C;
-
-
-
-
- - -
-
-
-

C<int>

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-template<>
-struct C<int>;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-template<>
-struct C<int, char>;
-
-
-
-
- - -
-
-
-

D

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-struct D;
-
-
-
-
- - -
-
-
-

Z

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-struct Z;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - - - - - -
NameDescription
Z [constructor]Constructors
~Z [destructor]Destructor
foo
operator bool Conversion to bool
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
operator<=> Three-way comparison operator
- - - -
-
-
-

Z::Z

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <sort-namespace-members-by-name.cpp>
-Default constructor -
-Z();
-
-
-
» more... - -Construct from int -
-Z(int value);
-
-
-
» more... - - -
-
-
-
-

Z::Z

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-Z();
-
-
-
-
-
-
-
-

Z::Z

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-Z(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

Z::~Z

-
-Destructor - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-~Z();
-
-
-
-
-
-
-
-

Z::foo

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-void
-foo() const;
-
-
-
-
-
-
-
-

Z::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-operator bool() const;
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
-
-

Z::operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-bool
-operator!() const;
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-
-
-

Z::operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-bool
-operator==(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-bool
-operator!=(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator<=>

-
-Three-way comparison operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-auto
-operator<=>(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-The relative order of the objects -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

f

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-void
-f();
-
-
-
-
-
-
-
-

g

-
-
-

Synopses

-
-Declared in <sort-namespace-members-by-name.cpp>
- -
-void
-g();
-
-
-
» more... - - -
-char
-g(int);
-
-
-
» more... - - -
-char
-g(double);
-
-
-
» more... - - -
-char
-g(
-    double,
-    char);
-
-
-
» more... - - -
-char
-g(
-    char,
-    char,
-    char);
-
-
-
» more... - - -
-template<class T>
-char
-g(
-    T,
-    T,
-    T);
-
-
-
» more... - - -
-template<>
-char
-g<int>(
-    int,
-    int,
-    int);
-
-
-
» more... - - -
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-void
-g();
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-char
-g(int);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-char
-g(double);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-char
-g(
-    double,
-    char);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-char
-g(
-    char,
-    char,
-    char);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-template<class T>
-char
-g(
-    T,
-    T,
-    T);
-
-
-
-
-
-
-
-

g<int>

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-template<>
-char
-g<int>(
-    int,
-    int,
-    int);
-
-
-
-
-
-
-
-

h

-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-void
-h();
-
-
-
-
-
-
-
-

operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-bool
-operator!(A const& v);
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
vThe operand
-
-
-
-
-

operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-bool
-operator==(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <sort-namespace-members-by-name.cpp>
-
-bool
-operator!=(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.xml b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.xml deleted file mode 100644 index db912f484..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.xml +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Default constructor - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - Destructor - - - - - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - - Three-way comparison operator - - - The relative order of the objects - - - The right operand - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - The operand - - - - - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The left operand - - - The right operand - - - - - diff --git a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.yml b/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.yml deleted file mode 100644 index ed34d2abd..000000000 --- a/test-files/golden-tests/config/sort-namespace-members-by/sort-namespace-members-by-name.yml +++ /dev/null @@ -1 +0,0 @@ -sort-namespace-members-by: name \ No newline at end of file diff --git a/test-files/golden-tests/config/sort/sort-members.adoc b/test-files/golden-tests/config/sort/sort-members.adoc deleted file mode 100644 index d0b9a0b30..000000000 --- a/test-files/golden-tests/config/sort/sort-members.adoc +++ /dev/null @@ -1,712 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#A[`A`] -| link:#B-0b[`B`] -| link:#B-04[`B<int, char>`] -| link:#B-05[`B<int, U>`] -| link:#C-0f[`C`] -| link:#C-03[`C<int>`] -| link:#C-0d[`C<int, char>`] -| link:#D[`D`] -| link:#Z[`Z`] -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f[`f`] -| -| link:#g-0f[`g`] -| -| link:#h[`h`] -| -| link:#operator_not[`operator!`] -| Negation operator -| link:#operator_eq[`operator==`] -| Equality operator -| link:#operator_not_eq[`operator!=`] -| Inequality operator -|=== - -[#A] -== A - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#B-0b] -== B - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - class U> -struct B; ----- - -[#B-04] -== link:#B-0b[B]<int, char> - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#B-0b[B]<int, char>; ----- - -[#B-05] -== link:#B-0b[B]<int, U> - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class U> -struct link:#B-0b[B]<int, U>; ----- - -[#C-0f] -== C - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - class U = void> -struct C; ----- - -[#C-03] -== link:#C-0f[C]<int> - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#C-0f[C]<int>; ----- - -[#C-0d] -== link:#C-0f[C]<int, char> - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#C-0f[C]<int, char>; ----- - -[#D] -== D - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct D; ----- - -[#Z] -== Z - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Z; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Z-2constructor-00[`Z`] [.small]#[constructor]# -| Constructors -| link:#Z-2destructor[`~Z`] [.small]#[destructor]# -| Destructor -| link:#Z-foo[`foo`] -| -| link:#Z-2conversion[`operator bool`] -| Conversion to `bool` -| link:#Z-operator_not[`operator!`] -| Negation operator -| link:#Z-operator_eq[`operator==`] -| Equality operator -| link:#Z-operator_not_eq[`operator!=`] -| Inequality operator -| link:#Z-operator_3way[`operator<=>`] -| Three‐way comparison operator -|=== - -[#Z-2constructor-00] -== link:#Z[Z]::Z - -Constructors - -=== Synopses - -Declared in `<sort‐members.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-05[Z](); ----- - -[.small]#link:#Z-2constructor-05[_» more..._]# - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-06[Z](int value); ----- - -[.small]#link:#Z-2constructor-06[_» more..._]# - -[#Z-2constructor-05] -== link:#Z[Z]::Z - -Default constructor - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(); ----- - -[#Z-2constructor-06] -== link:#Z[Z]::Z - -Construct from `int` - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#Z-2destructor] -== link:#Z[Z]::~Z - -Destructor - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~Z(); ----- - -[#Z-foo] -== link:#Z[Z]::foo - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -foo() const; ----- - -[#Z-2conversion] -== link:#Z[Z]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator bool() const; ----- - -=== Return Value - -The object converted to `bool` - -[#Z-operator_not] -== link:#Z[Z]::operator! - -Negation operator - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!() const; ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -[#Z-operator_eq] -== link:#Z[Z]::operator== - -Equality operator - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_not_eq] -== link:#Z[Z]::operator!= - -Inequality operator - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_3way] -== link:#Z[Z]::operator<=> - -Three‐way comparison operator - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -auto -operator<=>(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -The relative order of the objects - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - -[#g-0f] -== g - -=== Synopses - -Declared in `<sort‐members.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -link:#g-0e3[g](); ----- - -[.small]#link:#g-0e3[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-04[g](int); ----- - -[.small]#link:#g-04[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-06[g](double); ----- - -[.small]#link:#g-06[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-03a[g]( - double, - char); ----- - -[.small]#link:#g-03a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-0a[g]( - char, - char, - char); ----- - -[.small]#link:#g-0a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -char -link:#g-03c[g]( - T, - T, - T); ----- - -[.small]#link:#g-03c[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -char -link:#g-0e4[g<int>]( - int, - int, - int); ----- - -[.small]#link:#g-0e4[_» more..._]# - -[#g-0e3] -== g - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -g(); ----- - -[#g-04] -== g - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g(int); ----- - -[#g-06] -== g - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g(double); ----- - -[#g-03a] -== g - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g( - double, - char); ----- - -[#g-0a] -== g - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g( - char, - char, - char); ----- - -[#g-03c] -== g - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -char -g( - T, - T, - T); ----- - -[#g-0e4] -== link:#g-03c[g]<int> - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -char -link:#g-03c[g]<int>( - int, - int, - int); ----- - -[#h] -== h - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -h(); ----- - -[#operator_not] -== operator! - -Negation operator - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!(link:#A[A] const& v); ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *v* -| The operand -|=== - -[#operator_eq] -== operator== - -Equality operator - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_not_eq] -== operator!= - -Inequality operator - -=== Synopsis - -Declared in `<sort‐members.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/sort/sort-members.cpp b/test-files/golden-tests/config/sort/sort-members.cpp deleted file mode 100644 index c65f3cf8d..000000000 --- a/test-files/golden-tests/config/sort/sort-members.cpp +++ /dev/null @@ -1,60 +0,0 @@ -struct D {}; - -template -struct C {}; - -template <> -struct C {}; - -template <> -struct C {}; - -template -struct B {}; - -template <> -struct B {}; - -template -struct B {}; - -struct A {}; - -struct Z { - auto operator<=>(Z const&) const; - bool operator!=(Z const&) const; - bool operator==(Z const&) const; - bool operator!() const; - operator bool() const; - void foo() const; - ~Z(); - Z(int); - Z(); -}; - -bool operator!=(A const& lhs, A const& rhs); -bool operator==(A const& lhs, A const& rhs); -bool operator!(A const& v); - -void h(); - -template -char g(T, T, T); - -template <> -char g(int, int, int); - -char g(char, char, char); - -char g(double, char); - -char g(double); - -char g(int); - -char g(int); - -void g(); - -void f(); - diff --git a/test-files/golden-tests/config/sort/sort-members.html b/test-files/golden-tests/config/sort/sort-members.html deleted file mode 100644 index d2563ae5a..000000000 --- a/test-files/golden-tests/config/sort/sort-members.html +++ /dev/null @@ -1,904 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - - - - -
Name
A
B
B<int, char>
B<int, U>
C
C<int>
C<int, char>
D
Z
- -

Functions

- - - - - - - - - - - - - - - - -
NameDescription
f
g
h
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
- -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

B

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-template<
-    class T,
-    class U>
-struct B;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-template<>
-struct B<int, char>;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-template<class U>
-struct B<int, U>;
-
-
-
-
- - -
-
-
-

C

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-template<
-    class T,
-    class U = void>
-struct C;
-
-
-
-
- - -
-
-
-

C<int>

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-template<>
-struct C<int>;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-template<>
-struct C<int, char>;
-
-
-
-
- - -
-
-
-

D

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-struct D;
-
-
-
-
- - -
-
-
-

Z

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-struct Z;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - - - - - -
NameDescription
Z [constructor]Constructors
~Z [destructor]Destructor
foo
operator bool Conversion to bool
operator! Negation operator
operator== Equality operator
operator!= Inequality operator
operator<=> Three-way comparison operator
- - - -
-
-
-

Z::Z

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <sort-members.cpp>
-Default constructor -
-Z();
-
-
-
» more... - -Construct from int -
-Z(int value);
-
-
-
» more... - - -
-
-
-
-

Z::Z

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-Z();
-
-
-
-
-
-
-
-

Z::Z

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-Z(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

Z::~Z

-
-Destructor - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-~Z();
-
-
-
-
-
-
-
-

Z::foo

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-void
-foo() const;
-
-
-
-
-
-
-
-

Z::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-operator bool() const;
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
-
-

Z::operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-bool
-operator!() const;
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-
-
-

Z::operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-bool
-operator==(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-bool
-operator!=(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator<=>

-
-Three-way comparison operator - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-auto
-operator<=>(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-The relative order of the objects -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

f

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-void
-f();
-
-
-
-
-
-
-
-

g

-
-
-

Synopses

-
-Declared in <sort-members.cpp>
- -
-void
-g();
-
-
-
» more... - - -
-char
-g(int);
-
-
-
» more... - - -
-char
-g(double);
-
-
-
» more... - - -
-char
-g(
-    double,
-    char);
-
-
-
» more... - - -
-char
-g(
-    char,
-    char,
-    char);
-
-
-
» more... - - -
-template<class T>
-char
-g(
-    T,
-    T,
-    T);
-
-
-
» more... - - -
-template<>
-char
-g<int>(
-    int,
-    int,
-    int);
-
-
-
» more... - - -
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-void
-g();
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-char
-g(int);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-char
-g(double);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-char
-g(
-    double,
-    char);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-char
-g(
-    char,
-    char,
-    char);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-template<class T>
-char
-g(
-    T,
-    T,
-    T);
-
-
-
-
-
-
-
-

g<int>

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-template<>
-char
-g<int>(
-    int,
-    int,
-    int);
-
-
-
-
-
-
-
-

h

-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-void
-h();
-
-
-
-
-
-
-
-

operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-bool
-operator!(A const& v);
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
vThe operand
-
-
-
-
-

operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-bool
-operator==(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <sort-members.cpp>
-
-bool
-operator!=(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/sort/sort-members.xml b/test-files/golden-tests/config/sort/sort-members.xml deleted file mode 100644 index 143cabb54..000000000 --- a/test-files/golden-tests/config/sort/sort-members.xml +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - Default constructor - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - Destructor - - - - - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - - Three-way comparison operator - - - The relative order of the objects - - - The right operand - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - The operand - - - - - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The left operand - - - The right operand - - - - - diff --git a/test-files/golden-tests/config/sort/sort-members.yml b/test-files/golden-tests/config/sort/sort-members.yml deleted file mode 100644 index 8cc1c56b3..000000000 --- a/test-files/golden-tests/config/sort/sort-members.yml +++ /dev/null @@ -1 +0,0 @@ -sort-members: true \ No newline at end of file diff --git a/test-files/golden-tests/config/sort/unordered.adoc b/test-files/golden-tests/config/sort/unordered.adoc deleted file mode 100644 index f615bc695..000000000 --- a/test-files/golden-tests/config/sort/unordered.adoc +++ /dev/null @@ -1,712 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#D[`D`] -| link:#C-0f[`C`] -| link:#C-0d[`C<int, char>`] -| link:#C-03[`C<int>`] -| link:#B-0b[`B`] -| link:#B-04[`B<int, char>`] -| link:#B-05[`B<int, U>`] -| link:#A[`A`] -| link:#Z[`Z`] -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#operator_not_eq[`operator!=`] -| Inequality operator -| link:#operator_eq[`operator==`] -| Equality operator -| link:#operator_not[`operator!`] -| Negation operator -| link:#h[`h`] -| -| link:#g-0f[`g`] -| -| link:#f[`f`] -| -|=== - -[#D] -== D - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct D; ----- - -[#C-0f] -== C - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - class U = void> -struct C; ----- - -[#C-0d] -== link:#C-0f[C]<int, char> - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#C-0f[C]<int, char>; ----- - -[#C-03] -== link:#C-0f[C]<int> - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#C-0f[C]<int>; ----- - -[#B-0b] -== B - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class T, - class U> -struct B; ----- - -[#B-04] -== link:#B-0b[B]<int, char> - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -struct link:#B-0b[B]<int, char>; ----- - -[#B-05] -== link:#B-0b[B]<int, U> - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class U> -struct link:#B-0b[B]<int, U>; ----- - -[#A] -== A - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct A; ----- - -[#Z] -== Z - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Z; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Z-operator_3way[`operator<=>`] -| Three‐way comparison operator -| link:#Z-operator_not_eq[`operator!=`] -| Inequality operator -| link:#Z-operator_eq[`operator==`] -| Equality operator -| link:#Z-operator_not[`operator!`] -| Negation operator -| link:#Z-2conversion[`operator bool`] -| Conversion to `bool` -| link:#Z-foo[`foo`] -| -| link:#Z-2destructor[`~Z`] [.small]#[destructor]# -| Destructor -| link:#Z-2constructor-00[`Z`] [.small]#[constructor]# -| Constructors -|=== - -[#Z-operator_3way] -== link:#Z[Z]::operator<=> - -Three‐way comparison operator - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -auto -operator<=>(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -The relative order of the objects - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_not_eq] -== link:#Z[Z]::operator!= - -Inequality operator - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_eq] -== link:#Z[Z]::operator== - -Equality operator - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==(link:#Z[Z] const& rhs) const; ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *rhs* -| The right operand -|=== - -[#Z-operator_not] -== link:#Z[Z]::operator! - -Negation operator - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!() const; ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -[#Z-2conversion] -== link:#Z[Z]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -operator bool() const; ----- - -=== Return Value - -The object converted to `bool` - -[#Z-foo] -== link:#Z[Z]::foo - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -foo() const; ----- - -[#Z-2destructor] -== link:#Z[Z]::~Z - -Destructor - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -~Z(); ----- - -[#Z-2constructor-00] -== link:#Z[Z]::Z - -Constructors - -=== Synopses - -Declared in `<unordered.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-05[Z](); ----- - -[.small]#link:#Z-2constructor-05[_» more..._]# - -Construct from `int` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#Z-2constructor-06[Z](int value); ----- - -[.small]#link:#Z-2constructor-06[_» more..._]# - -[#Z-2constructor-05] -== link:#Z[Z]::Z - -Default constructor - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(); ----- - -[#Z-2constructor-06] -== link:#Z[Z]::Z - -Construct from `int` - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -Z(int value); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to construct from -|=== - -[#operator_not_eq] -== operator!= - -Inequality operator - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!=( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are not equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_eq] -== operator== - -Equality operator - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator==( - link:#A[A] const& lhs, - link:#A[A] const& rhs); ----- - -=== Return Value - -`true` if the objects are equal, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *lhs* -| The left operand -| *rhs* -| The right operand -|=== - -[#operator_not] -== operator! - -Negation operator - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -operator!(link:#A[A] const& v); ----- - -=== Return Value - -`true` if the object is falsy, `false` otherwise - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *v* -| The operand -|=== - -[#h] -== h - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -h(); ----- - -[#g-0f] -== g - -=== Synopses - -Declared in `<unordered.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -char -link:#g-03c[g]( - T, - T, - T); ----- - -[.small]#link:#g-03c[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -char -link:#g-0e4[g<int>]( - int, - int, - int); ----- - -[.small]#link:#g-0e4[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-0a[g]( - char, - char, - char); ----- - -[.small]#link:#g-0a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-03a[g]( - double, - char); ----- - -[.small]#link:#g-03a[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-06[g](double); ----- - -[.small]#link:#g-06[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -link:#g-04[g](int); ----- - -[.small]#link:#g-04[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -link:#g-0e3[g](); ----- - -[.small]#link:#g-0e3[_» more..._]# - -[#g-03c] -== g - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -char -g( - T, - T, - T); ----- - -[#g-0e4] -== link:#g-03c[g]<int> - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<> -char -link:#g-03c[g]<int>( - int, - int, - int); ----- - -[#g-0a] -== g - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g( - char, - char, - char); ----- - -[#g-03a] -== g - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g( - double, - char); ----- - -[#g-06] -== g - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g(double); ----- - -[#g-04] -== g - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -char -g(int); ----- - -[#g-0e3] -== g - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -g(); ----- - -[#f] -== f - -=== Synopsis - -Declared in `<unordered.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/config/sort/unordered.cpp b/test-files/golden-tests/config/sort/unordered.cpp deleted file mode 100644 index c65f3cf8d..000000000 --- a/test-files/golden-tests/config/sort/unordered.cpp +++ /dev/null @@ -1,60 +0,0 @@ -struct D {}; - -template -struct C {}; - -template <> -struct C {}; - -template <> -struct C {}; - -template -struct B {}; - -template <> -struct B {}; - -template -struct B {}; - -struct A {}; - -struct Z { - auto operator<=>(Z const&) const; - bool operator!=(Z const&) const; - bool operator==(Z const&) const; - bool operator!() const; - operator bool() const; - void foo() const; - ~Z(); - Z(int); - Z(); -}; - -bool operator!=(A const& lhs, A const& rhs); -bool operator==(A const& lhs, A const& rhs); -bool operator!(A const& v); - -void h(); - -template -char g(T, T, T); - -template <> -char g(int, int, int); - -char g(char, char, char); - -char g(double, char); - -char g(double); - -char g(int); - -char g(int); - -void g(); - -void f(); - diff --git a/test-files/golden-tests/config/sort/unordered.html b/test-files/golden-tests/config/sort/unordered.html deleted file mode 100644 index 6dc210a0f..000000000 --- a/test-files/golden-tests/config/sort/unordered.html +++ /dev/null @@ -1,904 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - - - - - - -
Name
D
C
C<int, char>
C<int>
B
B<int, char>
B<int, U>
A
Z
- -

Functions

- - - - - - - - - - - - - - - - -
NameDescription
operator!= Inequality operator
operator== Equality operator
operator! Negation operator
h
g
f
- -
-
-
-

D

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-struct D;
-
-
-
-
- - -
-
-
-

C

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-template<
-    class T,
-    class U = void>
-struct C;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <unordered.cpp>
-
-template<>
-struct C<int, char>;
-
-
-
-
- - -
-
-
-

C<int>

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-template<>
-struct C<int>;
-
-
-
-
- - -
-
-
-

B

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-template<
-    class T,
-    class U>
-struct B;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <unordered.cpp>
-
-template<>
-struct B<int, char>;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <unordered.cpp>
-
-template<class U>
-struct B<int, U>;
-
-
-
-
- - -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-struct A;
-
-
-
-
- - -
-
-
-

Z

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-struct Z;
-
-
-
-
-

Member Functions

- - - - - - - - - - - - - - - - - - -
NameDescription
operator<=> Three-way comparison operator
operator!= Inequality operator
operator== Equality operator
operator! Negation operator
operator bool Conversion to bool
foo
~Z [destructor]Destructor
Z [constructor]Constructors
- - - -
-
-
-

Z::operator<=>

-
-Three-way comparison operator - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-auto
-operator<=>(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-The relative order of the objects -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-bool
-operator!=(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-bool
-operator==(Z const& rhs) const;
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
rhsThe right operand
-
-
-
-
-

Z::operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-bool
-operator!() const;
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-
-
-

Z::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-operator bool() const;
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
-
-

Z::foo

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-void
-foo() const;
-
-
-
-
-
-
-
-

Z::~Z

-
-Destructor - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-~Z();
-
-
-
-
-
-
-
-

Z::Z

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <unordered.cpp>
-Default constructor -
-Z();
-
-
-
» more... - -Construct from int -
-Z(int value);
-
-
-
» more... - - -
-
-
-
-

Z::Z

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-Z();
-
-
-
-
-
-
-
-

Z::Z

-
-Construct from int - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-Z(int value);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to construct from
-
-
-
-
-

operator!=

-
-Inequality operator - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-bool
-operator!=(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are not equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator==

-
-Equality operator - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-bool
-operator==(
-    A const& lhs,
-    A const& rhs);
-
-
-
-
-
-

Return Value

-true if the objects are equal, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - - - - - -
NameDescription
lhsThe left operand
rhsThe right operand
-
-
-
-
-

operator!

-
-Negation operator - -
-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-bool
-operator!(A const& v);
-
-
-
-
-
-

Return Value

-true if the object is falsy, false otherwise -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
vThe operand
-
-
-
-
-

h

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-void
-h();
-
-
-
-
-
-
-
-

g

-
-
-

Synopses

-
-Declared in <unordered.cpp>
- -
-template<class T>
-char
-g(
-    T,
-    T,
-    T);
-
-
-
» more... - - -
-template<>
-char
-g<int>(
-    int,
-    int,
-    int);
-
-
-
» more... - - -
-char
-g(
-    char,
-    char,
-    char);
-
-
-
» more... - - -
-char
-g(
-    double,
-    char);
-
-
-
» more... - - -
-char
-g(double);
-
-
-
» more... - - -
-char
-g(int);
-
-
-
» more... - - -
-void
-g();
-
-
-
» more... - - -
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-template<class T>
-char
-g(
-    T,
-    T,
-    T);
-
-
-
-
-
-
-
-

g<int>

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-template<>
-char
-g<int>(
-    int,
-    int,
-    int);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-char
-g(
-    char,
-    char,
-    char);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-char
-g(
-    double,
-    char);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-char
-g(double);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-char
-g(int);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-void
-g();
-
-
-
-
-
-
-
-

f

-
-
-

Synopsis

-
-Declared in <unordered.cpp>
-
-void
-f();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/config/sort/unordered.xml b/test-files/golden-tests/config/sort/unordered.xml deleted file mode 100644 index 1715fe9d1..000000000 --- a/test-files/golden-tests/config/sort/unordered.xml +++ /dev/null @@ -1,392 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Three-way comparison operator - - - The relative order of the objects - - - The right operand - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The right operand - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - - - - - - - Destructor - - - - - - - - Default constructor - - - - - - - - - - - Construct from - int - - - The value to construct from - - - - - - - - - - - - - - - - - - - - - - - Inequality operator - - - true - if the objects are not equal, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - - - - - - Equality operator - - - true - if the objects are equal, - false - otherwise - - - The left operand - - - The right operand - - - - - - - - - - - - - - - - - Negation operator - - - true - if the object is falsy, - false - otherwise - - - The operand - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/config/sort/unordered.yml b/test-files/golden-tests/config/sort/unordered.yml deleted file mode 100644 index 4a7619137..000000000 --- a/test-files/golden-tests/config/sort/unordered.yml +++ /dev/null @@ -1,7 +0,0 @@ -sort-members: false -sort-members-ctors-1st: false -sort-members-dtors-1st: false -sort-members-assignment-1st: false -sort-members-conversion-last: false -sort-members-relational-last: false -sort-namespace-members-by: location \ No newline at end of file diff --git a/test-files/golden-tests/core/empty.adoc b/test-files/golden-tests/core/empty.adoc deleted file mode 100644 index fff40cfa1..000000000 --- a/test-files/golden-tests/core/empty.adoc +++ /dev/null @@ -1,8 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/core/empty.cpp b/test-files/golden-tests/core/empty.cpp deleted file mode 100644 index 8b1378917..000000000 --- a/test-files/golden-tests/core/empty.cpp +++ /dev/null @@ -1 +0,0 @@ - diff --git a/test-files/golden-tests/core/empty.html b/test-files/golden-tests/core/empty.html deleted file mode 100644 index 1ee3b8055..000000000 --- a/test-files/golden-tests/core/empty.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/core/empty.xml b/test-files/golden-tests/core/empty.xml deleted file mode 100644 index fd4dc6e6d..000000000 --- a/test-files/golden-tests/core/empty.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - diff --git a/test-files/golden-tests/core/libcxx.adoc b/test-files/golden-tests/core/libcxx.adoc deleted file mode 100644 index 3272e8e79..000000000 --- a/test-files/golden-tests/core/libcxx.adoc +++ /dev/null @@ -1,73 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#sqrt[`sqrt`] -| Computes the square root of an integral value. -|=== - -[#sqrt] -== sqrt - -Computes the square root of an integral value. - -=== Synopsis - -Declared in `<libcxx.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -T -sqrt(T value) -requires std::is_integral_v<T>; ----- - -=== Description - -This function calculates the square root of a given integral value using bit manipulation. - -=== Exceptions - -[cols=2] -|=== -| Name -| Thrown on -| `std::invalid_argument` -| if the input value is negative. -|=== - -=== Return Value - -The square root of the input value. - -=== Template Parameters - -[cols=2] -|=== -| Name -| Description -| *T* -| The type of the input value. Must be an integral type. -|=== - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The integral value to compute the square root of. -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/core/libcxx.cpp b/test-files/golden-tests/core/libcxx.cpp deleted file mode 100644 index 714a9d823..000000000 --- a/test-files/golden-tests/core/libcxx.cpp +++ /dev/null @@ -1,152 +0,0 @@ -// Check if all std includes are functional with -nostdinc -// defined in MrDocsCompilationDatabase.cpp and headers/libc-stubs - -// libcxx -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include - -/** Computes the square root of an integral value. - - This function calculates the square root of a - given integral value using bit manipulation. - - @throws std::invalid_argument if the input value is negative. - - @tparam T The type of the input value. Must be an integral type. - @param value The integral value to compute the square root of. - @return The square root of the input value. - */ -template -std::enable_if_t, T> -sqrt(T value); - diff --git a/test-files/golden-tests/core/libcxx.html b/test-files/golden-tests/core/libcxx.html deleted file mode 100644 index a0ff234ed..000000000 --- a/test-files/golden-tests/core/libcxx.html +++ /dev/null @@ -1,114 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - -
NameDescription
sqrt Computes the square root of an integral value.
- -
-
-
-

sqrt

-
-Computes the square root of an integral value. - -
-
-
-

Synopsis

-
-Declared in <libcxx.cpp>
-
-template<typename T>
-T
-sqrt(T value)
-requires std::is_integral_v<T>;
-
-
-
-
-
-

Description

-

This function calculates the square root of a given integral value using bit manipulation.

-
-
-

Exceptions

- - - - - - - - - - - - - -
NameThrown on
std::invalid_argumentif the input value is negative.
-
-
-

Return Value

-The square root of the input value. -
-
-

Template Parameters

- - - - - - - - - - - - - -
NameDescription
TThe type of the input value. Must be an integral type.
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe integral value to compute the square root of.
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/core/libcxx.xml b/test-files/golden-tests/core/libcxx.xml deleted file mode 100644 index 0c469e7e0..000000000 --- a/test-files/golden-tests/core/libcxx.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - diff --git a/test-files/golden-tests/core/utf-8.adoc b/test-files/golden-tests/core/utf-8.adoc deleted file mode 100644 index 95552a603..000000000 --- a/test-files/golden-tests/core/utf-8.adoc +++ /dev/null @@ -1,29 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#Христос_воскрес[`Христос_воскрес`] -|=== - -[#Христос_воскрес] -== Христос_воскрес - -=== Synopsis - -Declared in `<utf‐8.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -Христос_воскрес(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/core/utf-8.cpp b/test-files/golden-tests/core/utf-8.cpp deleted file mode 100644 index dea398534..000000000 --- a/test-files/golden-tests/core/utf-8.cpp +++ /dev/null @@ -1 +0,0 @@ -bool Христос_воскрес() { return true; } \ No newline at end of file diff --git a/test-files/golden-tests/core/utf-8.html b/test-files/golden-tests/core/utf-8.html deleted file mode 100644 index 0f513fe38..000000000 --- a/test-files/golden-tests/core/utf-8.html +++ /dev/null @@ -1,48 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - -
Name
Христос_воскрес
- -
-
- -
-

Synopsis

-
-Declared in <utf-8.cpp>
-
-bool
-Христос_воскрес();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/core/utf-8.xml b/test-files/golden-tests/core/utf-8.xml deleted file mode 100644 index 817b42be3..000000000 --- a/test-files/golden-tests/core/utf-8.xml +++ /dev/null @@ -1,12 +0,0 @@ - - - - - - - - - - - diff --git a/test-files/golden-tests/filters/file/a/included.hpp b/test-files/golden-tests/filters/file/a/included.hpp deleted file mode 100644 index ae0baa306..000000000 --- a/test-files/golden-tests/filters/file/a/included.hpp +++ /dev/null @@ -1,4 +0,0 @@ -/** A brief. -*/ - -void f(); diff --git a/test-files/golden-tests/filters/file/abc/excluded.hpp b/test-files/golden-tests/filters/file/abc/excluded.hpp deleted file mode 100644 index 23869cee7..000000000 --- a/test-files/golden-tests/filters/file/abc/excluded.hpp +++ /dev/null @@ -1,4 +0,0 @@ -/** A brief. -*/ - -void g(); diff --git a/test-files/golden-tests/filters/file/exclude-self.adoc b/test-files/golden-tests/filters/file/exclude-self.adoc deleted file mode 100644 index fff40cfa1..000000000 --- a/test-files/golden-tests/filters/file/exclude-self.adoc +++ /dev/null @@ -1,8 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/file/exclude-self.cpp b/test-files/golden-tests/filters/file/exclude-self.cpp deleted file mode 100644 index 353ac8c96..000000000 --- a/test-files/golden-tests/filters/file/exclude-self.cpp +++ /dev/null @@ -1,88 +0,0 @@ -namespace N0 -{ - void f0(); - - namespace N1_BL - { - void f1(); - } - - struct S0_BL - { - void f2(); - }; -} - -void N0::f0(); -void N0::N1_BL::f1(); -void N0::S0_BL::f2() { } - -namespace N2_BL -{ - void f0_BL(); - - namespace N3_BL - { - void f1(); - } - - void f2(); -} - -namespace N3 -{ - void f0_BL(); - void f1_BL(); -} - -namespace N4 -{ - namespace N5 - { - void f0_BL(); - void f1(); - } - - namespace N6 - { - void f0_BL(); - void f1(); - } -} - -namespace N7 -{ - namespace N8 - { - void f0_BL(); - void g0_BL(); - } - - namespace N9 - { - void f0_BL(); - void g0(); - } -} - -namespace N10 -{ - void f0_BL(); - namespace N11 - { - void f1_BL(); - } -} - -namespace N12 -{ - void f0_BL(); - namespace N13 - { - void f1_BL(); - namespace N14 - { - void f2_BL(); - } - } -} diff --git a/test-files/golden-tests/filters/file/exclude-self.html b/test-files/golden-tests/filters/file/exclude-self.html deleted file mode 100644 index 1ee3b8055..000000000 --- a/test-files/golden-tests/filters/file/exclude-self.html +++ /dev/null @@ -1,19 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/file/exclude-self.xml b/test-files/golden-tests/filters/file/exclude-self.xml deleted file mode 100644 index fd4dc6e6d..000000000 --- a/test-files/golden-tests/filters/file/exclude-self.xml +++ /dev/null @@ -1,6 +0,0 @@ - - - - - diff --git a/test-files/golden-tests/filters/file/exclude-self.yml b/test-files/golden-tests/filters/file/exclude-self.yml deleted file mode 100644 index aedda613a..000000000 --- a/test-files/golden-tests/filters/file/exclude-self.yml +++ /dev/null @@ -1,3 +0,0 @@ -# Exclude everything in self.cpp -exclude: - - '.' \ No newline at end of file diff --git a/test-files/golden-tests/filters/file/excluded.hpp b/test-files/golden-tests/filters/file/excluded.hpp deleted file mode 100644 index ae0baa306..000000000 --- a/test-files/golden-tests/filters/file/excluded.hpp +++ /dev/null @@ -1,4 +0,0 @@ -/** A brief. -*/ - -void f(); diff --git a/test-files/golden-tests/filters/file/include-self.adoc b/test-files/golden-tests/filters/file/include-self.adoc deleted file mode 100644 index 1170553b3..000000000 --- a/test-files/golden-tests/filters/file/include-self.adoc +++ /dev/null @@ -1,39 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#TEST[`TEST`] -|=== - -[#TEST] -== TEST - -=== Types - -[cols=1] -|=== -| Name -| link:#TEST-SUCCESS[`SUCCESS`] -|=== - -[#TEST-SUCCESS] -== link:#TEST[TEST]::SUCCESS - -=== Synopsis - -Declared in `<include‐self.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct SUCCESS; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/file/include-self.cpp b/test-files/golden-tests/filters/file/include-self.cpp deleted file mode 100644 index 53e24bf0c..000000000 --- a/test-files/golden-tests/filters/file/include-self.cpp +++ /dev/null @@ -1,4 +0,0 @@ -namespace TEST -{ - struct SUCCESS {}; -} diff --git a/test-files/golden-tests/filters/file/include-self.html b/test-files/golden-tests/filters/file/include-self.html deleted file mode 100644 index 0974c6f3f..000000000 --- a/test-files/golden-tests/filters/file/include-self.html +++ /dev/null @@ -1,67 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - -
Name
TEST
- -
-
-
-

TEST

-
-

Types

- - - - - - - - - - -
Name
SUCCESS
- -
-
- -
-

Synopsis

-
-Declared in <include-self.cpp>
-
-struct SUCCESS;
-
-
-
-
- - -
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/file/include-self.xml b/test-files/golden-tests/filters/file/include-self.xml deleted file mode 100644 index 7ba8ddfcb..000000000 --- a/test-files/golden-tests/filters/file/include-self.xml +++ /dev/null @@ -1,11 +0,0 @@ - - - - - - - - - - diff --git a/test-files/golden-tests/filters/file/include-self.yml b/test-files/golden-tests/filters/file/include-self.yml deleted file mode 100644 index 6f6542a9d..000000000 --- a/test-files/golden-tests/filters/file/include-self.yml +++ /dev/null @@ -1,3 +0,0 @@ -# Include everything in self.cpp -input: - - '.' \ No newline at end of file diff --git a/test-files/golden-tests/filters/file/include-symlink.adoc b/test-files/golden-tests/filters/file/include-symlink.adoc deleted file mode 100644 index e3bb2f296..000000000 --- a/test-files/golden-tests/filters/file/include-symlink.adoc +++ /dev/null @@ -1,33 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f[`f`] -| A brief. -|=== - -[#f] -== f - -A brief. - -=== Synopsis - -Declared in `<included.hpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/file/include-symlink.cpp b/test-files/golden-tests/filters/file/include-symlink.cpp deleted file mode 100644 index 080c83935..000000000 --- a/test-files/golden-tests/filters/file/include-symlink.cpp +++ /dev/null @@ -1 +0,0 @@ -#include "included.hpp" diff --git a/test-files/golden-tests/filters/file/include-symlink.html b/test-files/golden-tests/filters/file/include-symlink.html deleted file mode 100644 index ed51751e7..000000000 --- a/test-files/golden-tests/filters/file/include-symlink.html +++ /dev/null @@ -1,53 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - -
NameDescription
f A brief.
- -
-
-
-

f

-
-A brief. - -
-
-
-

Synopsis

-
-Declared in <included.hpp>
-
-void
-f();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/file/include-symlink.xml b/test-files/golden-tests/filters/file/include-symlink.xml deleted file mode 100644 index 4e00cd859..000000000 --- a/test-files/golden-tests/filters/file/include-symlink.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - A brief. - - - - - diff --git a/test-files/golden-tests/filters/file/include-symlink.yml b/test-files/golden-tests/filters/file/include-symlink.yml deleted file mode 100644 index 1369aaae6..000000000 --- a/test-files/golden-tests/filters/file/include-symlink.yml +++ /dev/null @@ -1,3 +0,0 @@ -# Exclude excluded.hpp -exclude: - - 'excluded.hpp' diff --git a/test-files/golden-tests/filters/file/included.hpp b/test-files/golden-tests/filters/file/included.hpp deleted file mode 120000 index 95f280f3e..000000000 --- a/test-files/golden-tests/filters/file/included.hpp +++ /dev/null @@ -1 +0,0 @@ -excluded.hpp \ No newline at end of file diff --git a/test-files/golden-tests/filters/file/subdirectories.adoc b/test-files/golden-tests/filters/file/subdirectories.adoc deleted file mode 100644 index 02b9ced9c..000000000 --- a/test-files/golden-tests/filters/file/subdirectories.adoc +++ /dev/null @@ -1,33 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f[`f`] -| A brief. -|=== - -[#f] -== f - -A brief. - -=== Synopsis - -Declared in `<a/included.hpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/file/subdirectories.cpp b/test-files/golden-tests/filters/file/subdirectories.cpp deleted file mode 100644 index 9948734bb..000000000 --- a/test-files/golden-tests/filters/file/subdirectories.cpp +++ /dev/null @@ -1,7 +0,0 @@ -#include "a/included.hpp" -#include "abc/excluded.hpp" - -namespace TEST -{ - struct SUCCESS {}; -} diff --git a/test-files/golden-tests/filters/file/subdirectories.html b/test-files/golden-tests/filters/file/subdirectories.html deleted file mode 100644 index e94b202e7..000000000 --- a/test-files/golden-tests/filters/file/subdirectories.html +++ /dev/null @@ -1,53 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - -
NameDescription
f A brief.
- -
-
-
-

f

-
-A brief. - -
-
-
-

Synopsis

-
-Declared in <a/included.hpp>
-
-void
-f();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/file/subdirectories.xml b/test-files/golden-tests/filters/file/subdirectories.xml deleted file mode 100644 index 07bf5951a..000000000 --- a/test-files/golden-tests/filters/file/subdirectories.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - A brief. - - - - - diff --git a/test-files/golden-tests/filters/file/subdirectories.yml b/test-files/golden-tests/filters/file/subdirectories.yml deleted file mode 100644 index ef91b5b16..000000000 --- a/test-files/golden-tests/filters/file/subdirectories.yml +++ /dev/null @@ -1,3 +0,0 @@ -# Include a (but not abc) -input: - - './a/' diff --git a/test-files/golden-tests/filters/file/subdirectories2.adoc b/test-files/golden-tests/filters/file/subdirectories2.adoc deleted file mode 100644 index 02b9ced9c..000000000 --- a/test-files/golden-tests/filters/file/subdirectories2.adoc +++ /dev/null @@ -1,33 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f[`f`] -| A brief. -|=== - -[#f] -== f - -A brief. - -=== Synopsis - -Declared in `<a/included.hpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/file/subdirectories2.cpp b/test-files/golden-tests/filters/file/subdirectories2.cpp deleted file mode 100644 index 9948734bb..000000000 --- a/test-files/golden-tests/filters/file/subdirectories2.cpp +++ /dev/null @@ -1,7 +0,0 @@ -#include "a/included.hpp" -#include "abc/excluded.hpp" - -namespace TEST -{ - struct SUCCESS {}; -} diff --git a/test-files/golden-tests/filters/file/subdirectories2.html b/test-files/golden-tests/filters/file/subdirectories2.html deleted file mode 100644 index e94b202e7..000000000 --- a/test-files/golden-tests/filters/file/subdirectories2.html +++ /dev/null @@ -1,53 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - -
NameDescription
f A brief.
- -
-
-
-

f

-
-A brief. - -
-
-
-

Synopsis

-
-Declared in <a/included.hpp>
-
-void
-f();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/file/subdirectories2.xml b/test-files/golden-tests/filters/file/subdirectories2.xml deleted file mode 100644 index 07bf5951a..000000000 --- a/test-files/golden-tests/filters/file/subdirectories2.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - A brief. - - - - - diff --git a/test-files/golden-tests/filters/file/subdirectories2.yml b/test-files/golden-tests/filters/file/subdirectories2.yml deleted file mode 100644 index 9a0f3f8e5..000000000 --- a/test-files/golden-tests/filters/file/subdirectories2.yml +++ /dev/null @@ -1,3 +0,0 @@ -# Include a (but not abc) -input: - - './a' diff --git a/test-files/golden-tests/filters/symbol-name/blacklist_0.adoc b/test-files/golden-tests/filters/symbol-name/blacklist_0.adoc deleted file mode 100644 index 01af03944..000000000 --- a/test-files/golden-tests/filters/symbol-name/blacklist_0.adoc +++ /dev/null @@ -1,137 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#N0[`N0`] -| link:#N4[`N4`] -| link:#N7[`N7`] -|=== - -[#N0] -== N0 - -=== Functions - -[cols=1] -|=== -| Name -| link:#N0-f0[`f0`] -|=== - -[#N0-f0] -== link:#N0[N0]::f0 - -=== Synopsis - -Declared in `<blacklist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f0(); ----- - -[#N4] -== N4 - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#N4-N5[`N5`] -| link:#N4-N6[`N6`] -|=== - -[#N4-N5] -== link:#N4[N4]::N5 - -=== Functions - -[cols=1] -|=== -| Name -| link:#N4-N5-f1[`f1`] -|=== - -[#N4-N5-f1] -== link:#N4[N4]::link:#N4-N5[N5]::f1 - -=== Synopsis - -Declared in `<blacklist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1(); ----- - -[#N4-N6] -== link:#N4[N4]::N6 - -=== Functions - -[cols=1] -|=== -| Name -| link:#N4-N6-f1[`f1`] -|=== - -[#N4-N6-f1] -== link:#N4[N4]::link:#N4-N6[N6]::f1 - -=== Synopsis - -Declared in `<blacklist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1(); ----- - -[#N7] -== N7 - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#N7-N9[`N9`] -|=== - -[#N7-N9] -== link:#N7[N7]::N9 - -=== Functions - -[cols=1] -|=== -| Name -| link:#N7-N9-g0[`g0`] -|=== - -[#N7-N9-g0] -== link:#N7[N7]::link:#N7-N9[N9]::g0 - -=== Synopsis - -Declared in `<blacklist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -g0(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/symbol-name/blacklist_0.cpp b/test-files/golden-tests/filters/symbol-name/blacklist_0.cpp deleted file mode 100644 index 353ac8c96..000000000 --- a/test-files/golden-tests/filters/symbol-name/blacklist_0.cpp +++ /dev/null @@ -1,88 +0,0 @@ -namespace N0 -{ - void f0(); - - namespace N1_BL - { - void f1(); - } - - struct S0_BL - { - void f2(); - }; -} - -void N0::f0(); -void N0::N1_BL::f1(); -void N0::S0_BL::f2() { } - -namespace N2_BL -{ - void f0_BL(); - - namespace N3_BL - { - void f1(); - } - - void f2(); -} - -namespace N3 -{ - void f0_BL(); - void f1_BL(); -} - -namespace N4 -{ - namespace N5 - { - void f0_BL(); - void f1(); - } - - namespace N6 - { - void f0_BL(); - void f1(); - } -} - -namespace N7 -{ - namespace N8 - { - void f0_BL(); - void g0_BL(); - } - - namespace N9 - { - void f0_BL(); - void g0(); - } -} - -namespace N10 -{ - void f0_BL(); - namespace N11 - { - void f1_BL(); - } -} - -namespace N12 -{ - void f0_BL(); - namespace N13 - { - void f1_BL(); - namespace N14 - { - void f2_BL(); - } - } -} diff --git a/test-files/golden-tests/filters/symbol-name/blacklist_0.html b/test-files/golden-tests/filters/symbol-name/blacklist_0.html deleted file mode 100644 index f4e2e9c1e..000000000 --- a/test-files/golden-tests/filters/symbol-name/blacklist_0.html +++ /dev/null @@ -1,207 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - - - -
Name
N0
N4
N7
- -
-
-
-

N0

-
-

Functions

- - - - - - - - - - -
Name
f0
- -
-
-
-

N0::f0

-
-
-

Synopsis

-
-Declared in <blacklist_0.cpp>
-
-void
-f0();
-
-
-
-
-
-
-
-

N4

-
-

Namespaces

- - - - - - - - - - - -
Name
N5
N6
- -
-
-
-

N4::N5

-
-

Functions

- - - - - - - - - - -
Name
f1
- -
-
- -
-

Synopsis

-
-Declared in <blacklist_0.cpp>
-
-void
-f1();
-
-
-
-
-
-
-
-

N4::N6

-
-

Functions

- - - - - - - - - - -
Name
f1
- -
-
- -
-

Synopsis

-
-Declared in <blacklist_0.cpp>
-
-void
-f1();
-
-
-
-
-
-
-
-

N7

-
-

Namespaces

- - - - - - - - - - -
Name
N9
- -
-
-
-

N7::N9

-
-

Functions

- - - - - - - - - - -
Name
g0
- -
-
- -
-

Synopsis

-
-Declared in <blacklist_0.cpp>
-
-void
-g0();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/blacklist_0.xml b/test-files/golden-tests/filters/symbol-name/blacklist_0.xml deleted file mode 100644 index 2a6e8810f..000000000 --- a/test-files/golden-tests/filters/symbol-name/blacklist_0.xml +++ /dev/null @@ -1,31 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/filters/symbol-name/blacklist_0.yml b/test-files/golden-tests/filters/symbol-name/blacklist_0.yml deleted file mode 100644 index 0f40b1b79..000000000 --- a/test-files/golden-tests/filters/symbol-name/blacklist_0.yml +++ /dev/null @@ -1,14 +0,0 @@ -exclude-symbols: - - 'N0::N1_BL' - - 'N0::S0_BL' - - 'N2_BL' - - 'N2_BL::N3_BL' - - 'N2_BL::f0_BL' - - 'N3::f*' - - 'N4::N*::f0_BL' - - 'N7::N*::f*' - - 'N7::N8::g*' - - 'N10' - - 'N10::N11' - - 'N12' - - 'N12::N14' diff --git a/test-files/golden-tests/filters/symbol-name/excluded-base-class.adoc b/test-files/golden-tests/filters/symbol-name/excluded-base-class.adoc deleted file mode 100644 index 275311b63..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-base-class.adoc +++ /dev/null @@ -1,204 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#A[`A`] -|=== - -[#A] -== A - -=== Types - -[cols=1] -|=== -| Name -| link:#A-D[`D`] -| link:#A-E[`E`] -|=== - -[#A-D] -== link:#A[A]::D - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class D - : public B::C ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `B::C` -| -|=== - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#A-D-f[`f`] -| link:#A-D-g[`g`] [.small]#[virtual]# -| link:#A-D-h[`h`] [.small]#[virtual]# -| link:#A-D-i[`i`] -|=== - -[#A-D-f] -== link:#A[A]::link:#A-D[D]::f - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - -[#A-D-g] -== link:#A[A]::link:#A-D[D]::g - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -virtual -void -g() override; ----- - -[#A-D-h] -== link:#A[A]::link:#A-D[D]::h - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -virtual -void -h() override; ----- - -[#A-D-i] -== link:#A[A]::link:#A-D[D]::i - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -i(); ----- - -[#A-E] -== link:#A[A]::E - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -class E - : public B::C ----- - -=== Base Classes - -[cols=2] -|=== -| Name -| Description -| `B::C` -| -|=== - -=== Member Functions - -[cols=1] -|=== -| Name -| link:#A-E-f[`f`] -| link:#A-E-g[`g`] [.small]#[virtual]# -| link:#A-E-h[`h`] [.small]#[virtual]# -| link:#A-E-i[`i`] -|=== - -[#A-E-f] -== link:#A[A]::link:#A-E[E]::f - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(); ----- - -[#A-E-g] -== link:#A[A]::link:#A-E[E]::g - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -virtual -void -g(); ----- - -[#A-E-h] -== link:#A[A]::link:#A-E[E]::h - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -virtual -void -h() override; ----- - -[#A-E-i] -== link:#A[A]::link:#A-E[E]::i - -=== Synopsis - -Declared in `<excluded‐base‐class.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -i(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/symbol-name/excluded-base-class.cpp b/test-files/golden-tests/filters/symbol-name/excluded-base-class.cpp deleted file mode 100644 index 7686f3f53..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-base-class.cpp +++ /dev/null @@ -1,32 +0,0 @@ -namespace A { - // This namespace and everything in it should be excluded - namespace B { - class C { - public: - void f(); - virtual void g(); - virtual void h() = 0; - }; - } - - // B::C and its members will be extracted as - // dependencies so that this information can - // be used by D. - class D : public B::C { - public: - void g() override; - void h() override; - void i(); - }; - - // B::C and its members will be extracted as - // dependencies so that this information can - // be used by D. - // g() is not defined and is only inherited - // from B::C - class E : public B::C { - public: - void h() override; - void i(); - }; -} diff --git a/test-files/golden-tests/filters/symbol-name/excluded-base-class.html b/test-files/golden-tests/filters/symbol-name/excluded-base-class.html deleted file mode 100644 index 0157aa71a..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-base-class.html +++ /dev/null @@ -1,279 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - -
Name
A
- -
-
-
-

A

-
-

Types

- - - - - - - - - - - -
Name
D
E
- -
-
-
-

A::D

-
-
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-class D
-    : public B::C
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
B::C
-
-

Member Functions

- - - - - - - - - - - - - -
Name
f
g [virtual]
h [virtual]
i
- - - -
-
- -
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-void
-f();
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-virtual
-void
-g() override;
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-virtual
-void
-h() override;
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-void
-i();
-
-
-
-
-
-
-
-

A::E

-
-
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-class E
-    : public B::C
-
-
-
-
-
-

Base Classes

- - - - - - - - - - -
NameDescription
B::C
-
-

Member Functions

- - - - - - - - - - - - - -
Name
f
g [virtual]
h [virtual]
i
- - - -
-
- -
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-void
-f();
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-virtual
-void
-g();
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-virtual
-void
-h() override;
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <excluded-base-class.cpp>
-
-void
-i();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/excluded-base-class.xml b/test-files/golden-tests/filters/symbol-name/excluded-base-class.xml deleted file mode 100644 index e33b54280..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-base-class.xml +++ /dev/null @@ -1,48 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/filters/symbol-name/excluded-base-class.yml b/test-files/golden-tests/filters/symbol-name/excluded-base-class.yml deleted file mode 100644 index 22984b9c9..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-base-class.yml +++ /dev/null @@ -1,3 +0,0 @@ -exclude-symbols: - - 'A::B' - - 'A::B::**' \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.adoc b/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.adoc deleted file mode 100644 index 2fcb76a45..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.adoc +++ /dev/null @@ -1,50 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#B[`B`] -|=== - -[#B] -== B - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#B-U[`U`] -|=== - -[#B-U] -== link:#B[B]::U - -=== Namespace Aliases - -[cols=1] -|=== -| Name -| link:#B-U-E[`E`] -|=== - -[#B-U-E] -== link:#B[B]::link:#B-U[U]::E - -=== Synopsis - -Declared in `<excluded‐namespace‐alias.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -namespace E = B::S::E; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.cpp b/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.cpp deleted file mode 100644 index 55502563b..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.cpp +++ /dev/null @@ -1,9 +0,0 @@ -namespace B { - namespace S { - namespace E {} - } - - namespace U { - namespace E = B::S::E; - } -} \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.html b/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.html deleted file mode 100644 index 0ab80d792..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.html +++ /dev/null @@ -1,83 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - -
Name
B
- -
-
-
-

B

-
-

Namespaces

- - - - - - - - - - -
Name
U
- -
-
-
-

B::U

-
-

Namespace Aliases

- - - - - - - - - - -
Name
E
- -
-
- -
-

Synopsis

-
-Declared in <excluded-namespace-alias.cpp>
-
-namespace E = B::S::E;
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.xml b/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.xml deleted file mode 100644 index e2af59001..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.xml +++ /dev/null @@ -1,14 +0,0 @@ - - - - - - - - - - - - - diff --git a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.yml b/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.yml deleted file mode 100644 index 3e51e752a..000000000 --- a/test-files/golden-tests/filters/symbol-name/excluded-namespace-alias.yml +++ /dev/null @@ -1,6 +0,0 @@ -include-symbols: - - 'B::U' - - 'B::U::**' -exclude-symbols: - - 'B::S' - - 'B::S::**' diff --git a/test-files/golden-tests/filters/symbol-name/extraction-mode.adoc b/test-files/golden-tests/filters/symbol-name/extraction-mode.adoc deleted file mode 100644 index 58fc6a599..000000000 --- a/test-files/golden-tests/filters/symbol-name/extraction-mode.adoc +++ /dev/null @@ -1,628 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=2] -|=== -| Name -| Description -| link:#regular_ns[`regular_ns`] -| A regular namespace with different filters for members -| link:#see_below_ns[`see_below_ns`] -| A see‐below namespace -|=== - -=== Namespace Aliases - -[cols=2] -|=== -| Name -| Description -| link:#dependency_ns_alias[`dependency_ns_alias`] -| Namespace alias to form the dependency on dependency_ns -| link:#implementation_defined_ns_alias[`implementation_defined_ns_alias`] -| Namespace alias to form a dependency on the implementation‐defined namespace -| link:#see_below_ns_alias[`see_below_ns_alias`] -| Namespace alias to form a dependency on the see‐below namespace -|=== - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#regular[`regular`] -| A regular symbol in the global namespace -| link:#see_below[`see_below`] -| A see‐below symbol in the global namespace -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#get_dependency[`get_dependency`] -| A function to get a dependency symbol on the global namespace -| link:#get_implementation_defined[`get_implementation_defined`] -| A function to get an implementation‐defined symbol in the global namespace -| link:#get_regular[`get_regular`] -| A function to get a regular symbol in the global namespace -| link:#get_see_below[`get_see_below`] -| A function to get a see‐below symbol in the global namespace -|=== - -[#regular_ns] -== regular_ns - -A regular namespace with different filters for members - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#regular_ns-regular[`regular`] -| A symbol that passes the filters -| link:#regular_ns-see_below[`see_below`] -| A symbol that passes the see‐below filter -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#regular_ns-get_dependency[`get_dependency`] -| A function to get an excluded symbol -| link:#regular_ns-get_implementation_defined[`get_implementation_defined`] -| A function to get an implementation‐defined symbol -| link:#regular_ns-get_regular[`get_regular`] -| A function to get a regular symbol -| link:#regular_ns-get_see_below[`get_see_below`] -| A function to get a see‐below symbol -|=== - -[#regular_ns-regular] -== link:#regular_ns[regular_ns]::regular - -A symbol that passes the filters - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct regular; ----- - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#regular_ns-regular-also_regular[`also_regular`] -| Child of a regular symbol extracted as regular -|=== - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#regular_ns-get_regular[`get_regular`] -| A function to get a regular symbol -|=== - -=== Description - -The symbol should have a page as usual - -[#regular_ns-regular-also_regular] -== link:#regular_ns[regular_ns]::link:#regular_ns-regular[regular]::also_regular - -Child of a regular symbol extracted as regular - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct also_regular; ----- - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#regular_ns-regular-also_regular-regular_as_well[`regular_as_well`] -| Grandchild of a regular symbol extracted as regular -|=== - -[#regular_ns-regular-also_regular-regular_as_well] -== link:#regular_ns[regular_ns]::link:#regular_ns-regular[regular]::link:#regular_ns-regular-also_regular[also_regular]::regular_as_well - -Grandchild of a regular symbol extracted as regular - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct regular_as_well; ----- - -[#regular_ns-see_below] -== link:#regular_ns[regular_ns]::see_below - -A symbol that passes the see‐below filter - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct see_below { /* see-below */ }; ----- - -=== Description - -A symbol that passes the filters and the see‐below filter. The symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page. - -[#regular_ns-get_dependency] -== link:#regular_ns[regular_ns]::get_dependency - -A function to get an excluded symbol - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -dependency -get_dependency(); ----- - -=== Description - -When used in a function, only the symbol name should be shown. No links should be generated for this symbol. - -[#regular_ns-get_implementation_defined] -== link:#regular_ns[regular_ns]::get_implementation_defined - -A function to get an implementation‐defined symbol - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -/* implementation-defined */ -get_implementation_defined(); ----- - -=== Description - -When used in a function, the implementation‐defined comment should replace the real type. - -It's the responsibility of the function documentation to explain the implementation‐defined symbol. - -=== Return Value - -A symbol that passes the implementation‐defined filter - -[#regular_ns-get_regular] -== link:#regular_ns[regular_ns]::get_regular - -A function to get a regular symbol - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#regular_ns-regular[regular] -get_regular(); ----- - -=== Description - -When used in a function, the symbol should be shown as usual with a link to the page. - -=== Return Value - -A symbol that passes the filters - -[#regular_ns-get_see_below] -== link:#regular_ns[regular_ns]::get_see_below - -A function to get a see‐below symbol - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#regular_ns-see_below[see_below] -get_see_below(); ----- - -=== Description - -When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere. - -=== Return Value - -A symbol that passes the see‐below filter - -[#see_below_ns] -== see_below_ns - -A see‐below namespace - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#see_below_ns-regular[`regular`] -| Regular symbol in a see‐below namespace -| link:#see_below_ns-see_below[`see_below`] -| See‐below symbol in a see‐below namespace -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#see_below_ns-get_dependency[`get_dependency`] -| A function to get a dependency symbol in a see‐below namespace -| link:#see_below_ns-get_implementation_defined[`get_implementation_defined`] -| A function to get an implementation‐defined symbol in a see‐below namespace -|=== - -=== Description - -All member symbols should become see‐below. All members are traversed as see‐below. - -The documentation page for these symbols should include the see‐below comment. - -[#see_below_ns-regular] -== link:#see_below_ns[see_below_ns]::regular - -Regular symbol in a see‐below namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct regular { /* see-below */ }; ----- - -=== Description - -The symbol becomes see‐below because the whole namespace is see‐below. - -[#see_below_ns-see_below] -== link:#see_below_ns[see_below_ns]::see_below - -See‐below symbol in a see‐below namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct see_below { /* see-below */ }; ----- - -=== Description - -The symbol becomes see‐below because the whole namespace is see‐below and because it's explicitly marked as see‐below. - -[#see_below_ns-get_dependency] -== link:#see_below_ns[see_below_ns]::get_dependency - -A function to get a dependency symbol in a see‐below namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -dependency -get_dependency(); ----- - -=== Description - -The symbol should be extracted as a dependency because the exclude filter has precedence over the see‐below filter. Only included symbols can be promoted to see‐below. - -It's the responsibility of the function documentation to explain the dependency. - -[#see_below_ns-get_implementation_defined] -== link:#see_below_ns[see_below_ns]::get_implementation_defined - -A function to get an implementation‐defined symbol in a see‐below namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -/* implementation-defined */ -get_implementation_defined(); ----- - -=== Description - -When used in a function, the implementation‐defined comment should replace the real type. - -It's the responsibility of the function documentation to explain the implementation‐defined symbol. - -=== Return Value - -Implementation‐defined symbol in a see‐below namespace - -[#dependency_ns_alias] -== dependency_ns_alias - -Namespace alias to form the dependency on dependency_ns - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -namespace dependency_ns_alias = dependency_ns; ----- - -[#implementation_defined_ns_alias] -== implementation_defined_ns_alias - -Namespace alias to form a dependency on the implementation‐defined namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -namespace implementation_defined_ns_alias = /* implementation-defined */; ----- - -[#see_below_ns_alias] -== see_below_ns_alias - -Namespace alias to form a dependency on the see‐below namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -namespace see_below_ns_alias = link:#see_below_ns[see_below_ns]; ----- - -=== Description - -The alias should be linked as usual and, because it's a namespace, the members should be listed on the page. - -[#regular] -== regular - -A regular symbol in the global namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct regular; ----- - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#regular-also_regular[`also_regular`] -| Child of a regular symbol: should be traversed as usual -|=== - -=== Non-Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#get_regular[`get_regular`] -| A function to get a regular symbol in the global namespace -|=== - -=== Description - -This symbol should have a page as usual. - -[#regular-also_regular] -== link:#regular[regular]::also_regular - -Child of a regular symbol: should be traversed as usual - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct also_regular; ----- - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#regular-also_regular-regular_as_well[`regular_as_well`] -| Grandchild of a regular symbol: should be traversed as usual -|=== - -[#regular-also_regular-regular_as_well] -== link:#regular[regular]::link:#regular-also_regular[also_regular]::regular_as_well - -Grandchild of a regular symbol: should be traversed as usual - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct regular_as_well; ----- - -[#see_below] -== see_below - -A see‐below symbol in the global namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct see_below { /* see-below */ }; ----- - -=== Description - -This symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page. - -The synopsis should say "See below". - -[#get_dependency] -== get_dependency - -A function to get a dependency symbol on the global namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -dependency -get_dependency(); ----- - -=== Description - -The symbol should be extracted as a dependency but its members should not be traversed. - -[#get_implementation_defined] -== get_implementation_defined - -A function to get an implementation‐defined symbol in the global namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -/* implementation-defined */ -get_implementation_defined(); ----- - -=== Description - -When used in a function, the implementation‐defined comment should replace the real type. - -It's the responsibility of the function documentation to explain the implementation‐defined symbol. - -=== Return Value - -An implementation‐defined symbol in the global namespace - -[#get_regular] -== get_regular - -A function to get a regular symbol in the global namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#regular[regular] -get_regular(); ----- - -=== Description - -When used in a function, the symbol should be shown as usual with a link to the page. - -=== Return Value - -A regular symbol in the global namespace - -[#get_see_below] -== get_see_below - -A function to get a see‐below symbol in the global namespace - -=== Synopsis - -Declared in `<extraction‐mode.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#see_below[see_below] -get_see_below(); ----- - -=== Description - -When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere. - -=== Return Value - -A see‐below symbol in the global namespace - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/symbol-name/extraction-mode.cpp b/test-files/golden-tests/filters/symbol-name/extraction-mode.cpp deleted file mode 100644 index 4793d5195..000000000 --- a/test-files/golden-tests/filters/symbol-name/extraction-mode.cpp +++ /dev/null @@ -1,316 +0,0 @@ -/* - The test explores all combinations of filters and extraction modes: - - * Global namespace that includes symbols with different filters - * Namespaces that pass each of the filters - * Each namespace has a symbol that passes each of the filters - - */ - -/// A regular namespace with different filters for members -namespace regular_ns -{ - /// A symbol that passes the filters - /// - /// The symbol should have a page as usual - struct regular { - /// Child of a regular symbol extracted as regular - struct also_regular { - /// Grandchild of a regular symbol extracted as regular - struct regular_as_well {}; - }; - }; - - /// A function to get a regular symbol - /// - /// When used in a function, the symbol should be shown as usual - /// with a link to the page. - regular get_regular() { return {}; } - - /// A symbol that passes the see-below filter - /// - /// A symbol that passes the filters and the see-below filter. - /// The symbol should have a page as usual but, because it's a scope - /// and not a namespace, the members should not be listed on that page. - struct see_below { - /// Child of a see-below struct: should not be traversed - struct also_see_below { - /// Grandchild of a see-below struct: should not be traversed - struct hidden_from_page {}; - }; - }; - - /// A function to get a see-below symbol - /// - /// When used in a function, the symbol name should be shown as usual. - /// The page for this symbol is what should be different because - /// the synopsis should say "See below" and the members are not - /// listed unless it's a namespace or the symbol has been explicitly - /// used as a dependency elsewhere. - see_below get_see_below() { return {}; } - - /// A symbol that passes the implementation-defined filter - /// - /// A symbol that passes the filters and the implementation-defined filter - /// The symbol is implementation defined and should not have a page. - /// Members of an implementation-defined scope should not be traversed. - /// If they are traversed for some other reason, they should also become - /// implementation-defined. - struct implementation_defined { - /// Child of an implementation-defined struct - /// - /// Child of an implementation-defined struct: should not be traversed - /// and, if traversed for some other reason, should also be - /// implementation-defined. - struct also_implementation_defined { - /// Grandchild of an implementation-defined struct - /// - /// Grandchild of an implementation-defined struct: should not be - /// traversed and, if traversed for some other reason, should also - /// be implementation-defined. - struct hidden_from_page {}; - }; - }; - - /// A function to get an implementation-defined symbol - /// - /// When used in a function, the implementation-defined - /// comment should replace the real type. - /// - /// It's the responsibility of the function documentation - /// to explain the implementation-defined symbol. - implementation_defined get_implementation_defined() { return {}; } - - /// An excluded symbol used as a dependency by a regular symbol - /// - /// A symbol excluded by filters but is used as a dependency - /// The symbol should be extracted as a dependency but its - /// members should not be traversed. - struct dependency { - /// Child of a dependency struct - /// - /// Child of a dependency struct: should not be traversed - /// and, if traversed for some other reason, should also be - /// a dependency. - struct hidden_from_page; - }; - - /// A function to get an excluded symbol - /// - /// When used in a function, only the symbol name should be shown. - /// No links should be generated for this symbol. - dependency get_dependency() { return {}; } - - /// A symbol excluded by filters - /// - /// A symbol excluded by filters and should not have a page. - struct excluded { - struct also_excluded { - struct hidden_from_page {}; - }; - }; -} - -/// A see-below namespace -/// -/// All member symbols should become see-below. All members are -/// traversed as see-below. -/// -/// The documentation page for these symbols should include -/// the see-below comment. -namespace see_below_ns -{ - /// Regular symbol in a see-below namespace - /// - /// The symbol becomes see-below because the whole namespace - /// is see-below. - struct regular { - /// Child of a regular symbol in a see-below namespace - /// - /// This symbol should not have a page because regular - /// became see-below. - struct also_regular { - /// Grandchild of a regular symbol in a see-below namespace - /// - /// This symbol should not have a page because regular - /// became see-below. - struct regular_as_well {}; - }; - }; - - /// See-below symbol in a see-below namespace - /// - /// The symbol becomes see-below because the whole namespace - /// is see-below and because it's explicitly marked as see-below. - struct see_below {}; - - /// Implementation-defined symbol in a see-below namespace - /// - /// The symbol does not become see-below because the - /// the implentation-defined filter has precedence over the - /// see-below filter. - /// - /// Functions using this symbol should explain the implementation-defined - /// nature of the symbol. - struct implementation_defined {}; - - /// A function to get an implementation-defined symbol in a see-below namespace - /// - /// When used in a function, the implementation-defined - /// comment should replace the real type. - /// - /// It's the responsibility of the function documentation - /// to explain the implementation-defined symbol. - implementation_defined get_implementation_defined() { return {}; } - - /// A dependency symbol in a see-below namespace - /// - /// The symbol should be extracted as a dependency because the - /// exclude filter has precedence over the see-below filter. - /// Only included symbols can be promoted to see-below. - /// - /// This will not have a page and functions using this symbol - /// should explain the dependency. - struct dependency {}; - - /// A function to get a dependency symbol in a see-below namespace - /// - /// The symbol should be extracted as a dependency because the - /// exclude filter has precedence over the see-below filter. - /// Only included symbols can be promoted to see-below. - /// - /// It's the responsibility of the function documentation - /// to explain the dependency. - dependency get_dependency() { return {}; } - - /// A symbol excluded by filters in a see-below namespace - /// - /// The symbol is excluded by filters and should not have a page. - struct excluded {}; -} - -/// Namespace alias to form a dependency on the see-below namespace -/// -/// The alias should be linked as usual and, because it's a namespace, -/// the members should be listed on the page. -namespace see_below_ns_alias = see_below_ns; - -/// An implementation-defined namespace -/// -/// Members are not traversed and, if traversed for some -/// other reason, they also become implementation-defined. -namespace implementation_defined_ns -{ - // Symbols directly filtered - struct regular {}; - struct see_below {}; - struct implementation_defined {}; - struct dependency {}; - struct excluded {}; - - dependency f() { return {}; } -} - -/// Namespace alias to form a dependency on the implementation-defined namespace -namespace implementation_defined_ns_alias = implementation_defined_ns; - -// A dependency namespace: all member symbols become dependencies -// Members should not be traversed and if they are, they should -// become dependencies. -namespace dependency_ns -{ - // Symbols directly filtered - struct regular {}; - struct see_below {}; - struct implementation_defined {}; - struct dependency {}; - struct excluded {}; - - dependency f() { return {}; } -} - -/// Namespace alias to form the dependency on dependency_ns -namespace dependency_ns_alias = dependency_ns; - -// An excluded namespace: all member symbols are excluded. -namespace excluded_ns -{ - // Symbols directly filtered - struct regular {}; - struct see_below {}; - struct implementation_defined {}; - struct dependency {}; - struct excluded {}; - - dependency f() { return {}; } -} - -/// A regular symbol in the global namespace -/// -/// This symbol should have a page as usual. -struct regular { - /// Child of a regular symbol: should be traversed as usual - struct also_regular { - /// Grandchild of a regular symbol: should be traversed as usual - struct regular_as_well {}; - }; -}; - -/// A function to get a regular symbol in the global namespace -/// -/// When used in a function, the symbol should be shown as usual -/// with a link to the page. -regular get_regular() { return {}; } - -/// A see-below symbol in the global namespace -/// -/// This symbol should have a page as usual but, because it's a scope -/// and not a namespace, the members should not be listed on that page. -/// -/// The synopsis should say "See below". -struct see_below { - /// Child of a see-below struct: should not be traversed - /// and, if traversed for some other reason, should also be see-below. - /// The symbol should not have a page. - struct also_see_below { - /// Grandchild of a see-below struct: should not be traversed - /// and, if traversed for some other reason, should also be see-below. - /// The symbol should not have a page. - struct hidden_from_page {}; - }; -}; - -/// A function to get a see-below symbol in the global namespace -/// -/// When used in a function, the symbol name should be shown as usual. -/// The page for this symbol is what should be different because -/// the synopsis should say "See below" and the members are not -/// listed unless it's a namespace or the symbol has been explicitly -/// used as a dependency elsewhere. -see_below get_see_below() { return {}; } - -/// An implementation-defined symbol in the global namespace -/// -/// The symbol is implementation defined and should not have a page. -struct implementation_defined {}; - -/// A function to get an implementation-defined symbol in the global namespace -/// -/// When used in a function, the implementation-defined -/// comment should replace the real type. -/// -/// It's the responsibility of the function documentation -/// to explain the implementation-defined symbol. -implementation_defined get_implementation_defined() { return {}; } - -/// A dependency symbol in the global namespace -struct dependency {}; - -/// A function to get a dependency symbol on the global namespace -/// -/// The symbol should be extracted as a dependency but its -/// members should not be traversed. -dependency get_dependency() { return {}; } - -/// An excluded symbol in the global namespace -struct excluded {}; diff --git a/test-files/golden-tests/filters/symbol-name/extraction-mode.html b/test-files/golden-tests/filters/symbol-name/extraction-mode.html deleted file mode 100644 index 56606c8db..000000000 --- a/test-files/golden-tests/filters/symbol-name/extraction-mode.html +++ /dev/null @@ -1,819 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - - - -
NameDescription
regular_ns A regular namespace with different filters for members
see_below_ns A see-below namespace
- -

Namespace Aliases

- - - - - - - - - - - - - -
NameDescription
dependency_ns_alias Namespace alias to form the dependency on dependency_ns
implementation_defined_ns_alias Namespace alias to form a dependency on the implementation-defined namespace
see_below_ns_alias Namespace alias to form a dependency on the see-below namespace
- -

Types

- - - - - - - - - - - - -
NameDescription
regular A regular symbol in the global namespace
see_below A see-below symbol in the global namespace
- -

Functions

- - - - - - - - - - - - - - -
NameDescription
get_dependency A function to get a dependency symbol on the global namespace
get_implementation_defined A function to get an implementation-defined symbol in the global namespace
get_regular A function to get a regular symbol in the global namespace
get_see_below A function to get a see-below symbol in the global namespace
- -
-
-
-

regular_ns

-
-A regular namespace with different filters for members - -
-
-

Types

- - - - - - - - - - - - -
NameDescription
regular A symbol that passes the filters
see_below A symbol that passes the see-below filter
- -

Functions

- - - - - - - - - - - - - - -
NameDescription
get_dependency A function to get an excluded symbol
get_implementation_defined A function to get an implementation-defined symbol
get_regular A function to get a regular symbol
get_see_below A function to get a see-below symbol
- -
-
-
-

regular_ns::regular

-
-A symbol that passes the filters - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct regular;
-
-
-
-
-

Types

- - - - - - - - - - - -
NameDescription
also_regular Child of a regular symbol extracted as regular
- - - -
-

Non-Member Functions

- - - - - - - - - - -
NameDescription
get_regularA function to get a regular symbol
-
-
-

Description

-

The symbol should have a page as usual

-
-
-
-
-

regular_ns::regular::also_regular

-
-Child of a regular symbol extracted as regular - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct also_regular;
-
-
-
-
-

Types

- - - - - - - - - - - -
NameDescription
regular_as_well Grandchild of a regular symbol extracted as regular
- - - -
-
-
-

regular_ns::regular::also_regular::regular_as_well

-
-Grandchild of a regular symbol extracted as regular - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct regular_as_well;
-
-
-
-
- - -
-
-
-

regular_ns::see_below

-
-A symbol that passes the see-below filter - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct see_below { /* see-below */ };
-
-
-
-
- - -
-

Description

-

A symbol that passes the filters and the see-below filter. The symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page.

-
-
-
-
-

regular_ns::get_dependency

-
-A function to get an excluded symbol - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-dependency
-get_dependency();
-
-
-
-
-
-

Description

-

When used in a function, only the symbol name should be shown. No links should be generated for this symbol.

-
-
-
-
-

regular_ns::get_implementation_defined

-
-A function to get an implementation-defined symbol - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-/* implementation-defined */
-get_implementation_defined();
-
-
-
-
-
-

Description

-

When used in a function, the implementation-defined comment should replace the real type.

-

It's the responsibility of the function documentation to explain the implementation-defined symbol.

-
-
-

Return Value

-A symbol that passes the implementation-defined filter -
-
-
-
-

regular_ns::get_regular

-
-A function to get a regular symbol - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-regular
-get_regular();
-
-
-
-
-
-

Description

-

When used in a function, the symbol should be shown as usual with a link to the page.

-
-
-

Return Value

-A symbol that passes the filters -
-
-
-
-

regular_ns::get_see_below

-
-A function to get a see-below symbol - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-see_below
-get_see_below();
-
-
-
-
-
-

Description

-

When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere.

-
-
-

Return Value

-A symbol that passes the see-below filter -
-
-
-
-

see_below_ns

-
-A see-below namespace - -
-
-

Types

- - - - - - - - - - - - -
NameDescription
regular Regular symbol in a see-below namespace
see_below See-below symbol in a see-below namespace
- -

Functions

- - - - - - - - - - - - -
NameDescription
get_dependency A function to get a dependency symbol in a see-below namespace
get_implementation_defined A function to get an implementation-defined symbol in a see-below namespace
- -
-

Description

-

All member symbols should become see-below. All members are traversed as see-below.

-

The documentation page for these symbols should include the see-below comment.

-
-
-
-
-

see_below_ns::regular

-
-Regular symbol in a see-below namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct regular { /* see-below */ };
-
-
-
-
- - -
-

Description

-

The symbol becomes see-below because the whole namespace is see-below.

-
-
-
-
-

see_below_ns::see_below

-
-See-below symbol in a see-below namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct see_below { /* see-below */ };
-
-
-
-
- - -
-

Description

-

The symbol becomes see-below because the whole namespace is see-below and because it's explicitly marked as see-below.

-
-
-
-
-

see_below_ns::get_dependency

-
-A function to get a dependency symbol in a see-below namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-dependency
-get_dependency();
-
-
-
-
-
-

Description

-

The symbol should be extracted as a dependency because the exclude filter has precedence over the see-below filter. Only included symbols can be promoted to see-below.

-

It's the responsibility of the function documentation to explain the dependency.

-
-
-
-
-

see_below_ns::get_implementation_defined

-
-A function to get an implementation-defined symbol in a see-below namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-/* implementation-defined */
-get_implementation_defined();
-
-
-
-
-
-

Description

-

When used in a function, the implementation-defined comment should replace the real type.

-

It's the responsibility of the function documentation to explain the implementation-defined symbol.

-
-
-

Return Value

-Implementation-defined symbol in a see-below namespace -
-
-
-
-

dependency_ns_alias

-
-Namespace alias to form the dependency on dependency_ns - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-namespace dependency_ns_alias = dependency_ns;
-
-
-
-
-
-
-
-

implementation_defined_ns_alias

-
-Namespace alias to form a dependency on the implementation-defined namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-namespace implementation_defined_ns_alias = /* implementation-defined */;
-
-
-
-
-
-
-
-

see_below_ns_alias

-
-Namespace alias to form a dependency on the see-below namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-namespace see_below_ns_alias = see_below_ns;
-
-
-
-
-
-

Description

-

The alias should be linked as usual and, because it's a namespace, the members should be listed on the page.

-
-
-
-
-

regular

-
-A regular symbol in the global namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct regular;
-
-
-
-
-

Types

- - - - - - - - - - - -
NameDescription
also_regular Child of a regular symbol: should be traversed as usual
- - - -
-

Non-Member Functions

- - - - - - - - - - -
NameDescription
get_regularA function to get a regular symbol in the global namespace
-
-
-

Description

-

This symbol should have a page as usual.

-
-
-
-
-

regular::also_regular

-
-Child of a regular symbol: should be traversed as usual - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct also_regular;
-
-
-
-
-

Types

- - - - - - - - - - - -
NameDescription
regular_as_well Grandchild of a regular symbol: should be traversed as usual
- - - -
-
-
-

regular::also_regular::regular_as_well

-
-Grandchild of a regular symbol: should be traversed as usual - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct regular_as_well;
-
-
-
-
- - -
-
-
-

see_below

-
-A see-below symbol in the global namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-struct see_below { /* see-below */ };
-
-
-
-
- - -
-

Description

-

This symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page.

-

The synopsis should say "See below".

-
-
-
-
-

get_dependency

-
-A function to get a dependency symbol on the global namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-dependency
-get_dependency();
-
-
-
-
-
-

Description

-

The symbol should be extracted as a dependency but its members should not be traversed.

-
-
-
-
-

get_implementation_defined

-
-A function to get an implementation-defined symbol in the global namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-/* implementation-defined */
-get_implementation_defined();
-
-
-
-
-
-

Description

-

When used in a function, the implementation-defined comment should replace the real type.

-

It's the responsibility of the function documentation to explain the implementation-defined symbol.

-
-
-

Return Value

-An implementation-defined symbol in the global namespace -
-
-
-
-

get_regular

-
-A function to get a regular symbol in the global namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-regular
-get_regular();
-
-
-
-
-
-

Description

-

When used in a function, the symbol should be shown as usual with a link to the page.

-
-
-

Return Value

-A regular symbol in the global namespace -
-
-
-
-

get_see_below

-
-A function to get a see-below symbol in the global namespace - -
-
-
-

Synopsis

-
-Declared in <extraction-mode.cpp>
-
-see_below
-get_see_below();
-
-
-
-
-
-

Description

-

When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere.

-
-
-

Return Value

-A see-below symbol in the global namespace -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/extraction-mode.xml b/test-files/golden-tests/filters/symbol-name/extraction-mode.xml deleted file mode 100644 index e2f4695d9..000000000 --- a/test-files/golden-tests/filters/symbol-name/extraction-mode.xml +++ /dev/null @@ -1,388 +0,0 @@ - - - - - - - An implementation-defined namespace - - - Members are not traversed and, if traversed for some other reason, they also become implementation-defined. - - - - - - - A regular namespace with different filters for members - - - - - - - A symbol that passes the implementation-defined filter - - - A symbol that passes the filters and the implementation-defined filter The symbol is implementation defined and should not have a page. Members of an implementation-defined scope should not be traversed. If they are traversed for some other reason, they should also become implementation-defined. - - - - - - - - A symbol that passes the filters - - - The symbol should have a page as usual - - - get_regular - - - - - - - Child of a regular symbol extracted as regular - - - - - - - Grandchild of a regular symbol extracted as regular - - - - - - - - - - A symbol that passes the see-below filter - - - A symbol that passes the filters and the see-below filter. The symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page. - - - - - - - - - - - A function to get an excluded symbol - - - When used in a function, only the symbol name should be shown. No links should be generated for this symbol. - - - - - - - - - - - A function to get an implementation-defined symbol - - - When used in a function, the implementation-defined comment should replace the real type. - - - It's the responsibility of the function documentation to explain the implementation-defined symbol. - - - A symbol that passes the implementation-defined filter - - - - - - - - - - - A function to get a regular symbol - - - When used in a function, the symbol should be shown as usual with a link to the page. - - - A symbol that passes the filters - - - regular - - - - - - - - - - - A function to get a see-below symbol - - - When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere. - - - A symbol that passes the see-below filter - - - - - - - - A see-below namespace - - - All member symbols should become see-below. All members are traversed as see-below. - - - The documentation page for these symbols should include the see-below comment. - - - - - - - Implementation-defined symbol in a see-below namespace - - - The symbol does not become see-below because the the implentation-defined filter has precedence over the see-below filter. - - - Functions using this symbol should explain the implementation-defined nature of the symbol. - - - - - - - - Regular symbol in a see-below namespace - - - The symbol becomes see-below because the whole namespace is see-below. - - - - - - - - See-below symbol in a see-below namespace - - - The symbol becomes see-below because the whole namespace is see-below and because it's explicitly marked as see-below. - - - - - - - - - - - A function to get a dependency symbol in a see-below namespace - - - The symbol should be extracted as a dependency because the exclude filter has precedence over the see-below filter. Only included symbols can be promoted to see-below. - - - It's the responsibility of the function documentation to explain the dependency. - - - - - - - - - - - A function to get an implementation-defined symbol in a see-below namespace - - - When used in a function, the implementation-defined comment should replace the real type. - - - It's the responsibility of the function documentation to explain the implementation-defined symbol. - - - Implementation-defined symbol in a see-below namespace - - - - - - - - - Namespace alias to form the dependency on dependency_ns - - - - - - - - - Namespace alias to form a dependency on the implementation-defined namespace - - - - - - - - - Namespace alias to form a dependency on the see-below namespace - - - The alias should be linked as usual and, because it's a namespace, the members should be listed on the page. - - - - - - - - - An implementation-defined symbol in the global namespace - - - The symbol is implementation defined and should not have a page. - - - - - - - - A regular symbol in the global namespace - - - This symbol should have a page as usual. - - - get_regular - - - - - - - Child of a regular symbol: should be traversed as usual - - - - - - - Grandchild of a regular symbol: should be traversed as usual - - - - - - - - - - A see-below symbol in the global namespace - - - This symbol should have a page as usual but, because it's a scope and not a namespace, the members should not be listed on that page. - - - The synopsis should say "See below". - - - - - - - - - - - A function to get a dependency symbol on the global namespace - - - The symbol should be extracted as a dependency but its members should not be traversed. - - - - - - - - - - - A function to get an implementation-defined symbol in the global namespace - - - When used in a function, the implementation-defined comment should replace the real type. - - - It's the responsibility of the function documentation to explain the implementation-defined symbol. - - - An implementation-defined symbol in the global namespace - - - - - - - - - - - A function to get a regular symbol in the global namespace - - - When used in a function, the symbol should be shown as usual with a link to the page. - - - A regular symbol in the global namespace - - - regular - - - - - - - - - - - A function to get a see-below symbol in the global namespace - - - When used in a function, the symbol name should be shown as usual. The page for this symbol is what should be different because the synopsis should say "See below" and the members are not listed unless it's a namespace or the symbol has been explicitly used as a dependency elsewhere. - - - A see-below symbol in the global namespace - - - - - diff --git a/test-files/golden-tests/filters/symbol-name/extraction-mode.yml b/test-files/golden-tests/filters/symbol-name/extraction-mode.yml deleted file mode 100644 index 08d310ddb..000000000 --- a/test-files/golden-tests/filters/symbol-name/extraction-mode.yml +++ /dev/null @@ -1,32 +0,0 @@ -exclude-symbols: - - 'regular_ns::dependency' - - 'regular_ns::excluded' - - 'see_below_ns::dependency' - - 'see_below_ns::excluded' - - 'implementation_defined_ns::dependency' - - 'implementation_defined_ns::excluded' - - 'dependency_ns::dependency' - - 'dependency_ns::excluded' - - 'excluded_ns::dependency' - - 'excluded_ns::excluded' - - 'dependency_ns' - - 'excluded_ns' - - 'dependency' - - 'excluded' -see-below: - - 'regular_ns::see_below' - - 'see_below_ns::see_below' - - 'implementation_defined_ns::see_below' - - 'dependency_ns::see_below' - - 'excluded_ns::see_below' - - 'see_below_ns' - - 'see_below' -implementation-defined: - - 'regular_ns::implementation_defined' - - 'see_below_ns::implementation_defined' - - 'implementation_defined_ns::implementation_defined' - - 'dependency_ns::implementation_defined' - - 'excluded_ns::implementation_defined' - - 'implementation_defined_ns' - - 'implementation_defined' -warn-no-paramdoc: false \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/impl-defined-member.adoc b/test-files/golden-tests/filters/symbol-name/impl-defined-member.adoc deleted file mode 100644 index b2c082164..000000000 --- a/test-files/golden-tests/filters/symbol-name/impl-defined-member.adoc +++ /dev/null @@ -1,72 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=1] -|=== -| Name -| link:#regular[`regular`] -|=== - -=== Variables - -[cols=1] -|=== -| Name -| link:#absolute_uri_rule[`absolute_uri_rule`] -| link:#regular_absolute_uri_rule[`regular_absolute_uri_rule`] -|=== - -[#regular] -== regular - -=== Types - -[cols=1] -|=== -| Name -| link:#regular-absolute_uri_rule_t[`absolute_uri_rule_t`] -|=== - -[#regular-absolute_uri_rule_t] -== link:#regular[regular]::absolute_uri_rule_t - -=== Synopsis - -Declared in `<impl‐defined‐member.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct absolute_uri_rule_t; ----- - -[#absolute_uri_rule] -== absolute_uri_rule - -=== Synopsis - -Declared in `<impl‐defined‐member.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -constexpr /* implementation-defined */ absolute_uri_rule = {}; ----- - -[#regular_absolute_uri_rule] -== regular_absolute_uri_rule - -=== Synopsis - -Declared in `<impl‐defined‐member.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -constexpr link:#regular-absolute_uri_rule_t[regular::absolute_uri_rule_t] regular_absolute_uri_rule = {}; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/symbol-name/impl-defined-member.cpp b/test-files/golden-tests/filters/symbol-name/impl-defined-member.cpp deleted file mode 100644 index 6e5c7cd90..000000000 --- a/test-files/golden-tests/filters/symbol-name/impl-defined-member.cpp +++ /dev/null @@ -1,11 +0,0 @@ -namespace detail { - struct absolute_uri_rule_t {}; -} - -namespace regular { - struct absolute_uri_rule_t {}; -} - -constexpr detail::absolute_uri_rule_t absolute_uri_rule = {}; - -constexpr regular::absolute_uri_rule_t regular_absolute_uri_rule = {}; diff --git a/test-files/golden-tests/filters/symbol-name/impl-defined-member.html b/test-files/golden-tests/filters/symbol-name/impl-defined-member.html deleted file mode 100644 index cb8f26140..000000000 --- a/test-files/golden-tests/filters/symbol-name/impl-defined-member.html +++ /dev/null @@ -1,111 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - -
Name
regular
- -

Variables

- - - - - - - - - - - -
Name
absolute_uri_rule
regular_absolute_uri_rule
- -
-
- -

Types

- - - - - - - - - - -
Name
absolute_uri_rule_t
- -
-
- -
-

Synopsis

-
-Declared in <impl-defined-member.cpp>
-
-struct absolute_uri_rule_t;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <impl-defined-member.cpp>
-
-constexpr /* implementation-defined */ absolute_uri_rule = {};
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <impl-defined-member.cpp>
-
-constexpr regular::absolute_uri_rule_t regular_absolute_uri_rule = {};
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/impl-defined-member.xml b/test-files/golden-tests/filters/symbol-name/impl-defined-member.xml deleted file mode 100644 index fc7d9b530..000000000 --- a/test-files/golden-tests/filters/symbol-name/impl-defined-member.xml +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/filters/symbol-name/impl-defined-member.yml b/test-files/golden-tests/filters/symbol-name/impl-defined-member.yml deleted file mode 100644 index f0855b226..000000000 --- a/test-files/golden-tests/filters/symbol-name/impl-defined-member.yml +++ /dev/null @@ -1,2 +0,0 @@ -implementation-defined: - - detail \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/whitelist_0.adoc b/test-files/golden-tests/filters/symbol-name/whitelist_0.adoc deleted file mode 100644 index 043588a56..000000000 --- a/test-files/golden-tests/filters/symbol-name/whitelist_0.adoc +++ /dev/null @@ -1,319 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Namespaces - -[cols=2] -|=== -| Name -| Description -| link:#N0[`N0`] -| This namespace should extracted because it's implied by `N0::f0_WL` -| link:#N1[`N1`] -| This namespace should extracted because it's implied by `N1::N3_WL` and `N1::N4::f1_WL` -| link:#N5[`N5`] -| This namespace should extracted because it's implied by `N5::N6::*7` -|=== - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#C[`C`] -| This namespace should be included because it strictly matches `C` -|=== - -[#N0] -== N0 - -This namespace should extracted because it's implied by `N0::f0_WL` - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#N0-f0_WL[`f0_WL`] -| This function should be included because it matches `N0::f0_WL` -|=== - -[#N0-f0_WL] -== link:#N0[N0]::f0_WL - -This function should be included because it matches `N0::f0_WL` - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f0_WL(); ----- - -[#N1] -== N1 - -This namespace should extracted because it's implied by `N1::N3_WL` and `N1::N4::f1_WL` - -=== Namespaces - -[cols=2] -|=== -| Name -| Description -| link:#N1-N3_WL[`N3_WL`] -| This namespace should extracted because it's explicitly included by `N1::N3_WL` -| link:#N1-N4[`N4`] -| This namespace should extracted because it's implied by `N1::N4::f1_WL` -|=== - -[#N1-N3_WL] -== link:#N1[N1]::N3_WL - -This namespace should extracted because it's explicitly included by `N1::N3_WL` - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#N1-N3_WL-f1_WL[`f1_WL`] -| This function should extracted because the namespace `N1::N3_WL` is included as a literal. -|=== - -[#N1-N3_WL-f1_WL] -== link:#N1[N1]::link:#N1-N3_WL[N3_WL]::f1_WL - -This function should extracted because the namespace `N1::N3_WL` is included as a literal. - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1_WL(); ----- - -[#N1-N4] -== link:#N1[N1]::N4 - -This namespace should extracted because it's implied by `N1::N4::f1_WL` - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#N1-N4-f1_WL[`f1_WL`] -| This function should extracted because it matches `N1::N4::f1_WL` -|=== - -[#N1-N4-f1_WL] -== link:#N1[N1]::link:#N1-N4[N4]::f1_WL - -This function should extracted because it matches `N1::N4::f1_WL` - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1_WL(); ----- - -[#N5] -== N5 - -This namespace should extracted because it's implied by `N5::N6::*7` - -=== Namespaces - -[cols=2] -|=== -| Name -| Description -| link:#N5-N6[`N6`] -| This namespace should extracted because it's implied by `N5::N6::*7` -|=== - -[#N5-N6] -== link:#N5[N5]::N6 - -This namespace should extracted because it's implied by `N5::N6::*7` - -=== Namespaces - -[cols=2] -|=== -| Name -| Description -| link:#N5-N6-M7[`M7`] -| This namespace should be included because it matches `N5::N6::*7` -| link:#N5-N6-N7[`N7`] -| This namespace should be included because it matches `N5::N6::*7` -|=== - -[#N5-N6-M7] -== link:#N5[N5]::link:#N5-N6[N6]::M7 - -This namespace should be included because it matches `N5::N6::*7` - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#N5-N6-M7-f2_WL[`f2_WL`] -| This function should be included because it's a member of `M7`, which matches `N5::N6::*7` -|=== - -[#N5-N6-M7-f2_WL] -== link:#N5[N5]::link:#N5-N6[N6]::link:#N5-N6-M7[M7]::f2_WL - -This function should be included because it's a member of `M7`, which matches `N5::N6::*7` - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f2_WL(); ----- - -[#N5-N6-N7] -== link:#N5[N5]::link:#N5-N6[N6]::N7 - -This namespace should be included because it matches `N5::N6::*7` - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#N5-N6-N7-f2_WL[`f2_WL`] -| This function should be included because it's a member of `N7`, which matches `N5::N6::*7` -|=== - -[#N5-N6-N7-f2_WL] -== link:#N5[N5]::link:#N5-N6[N6]::link:#N5-N6-N7[N7]::f2_WL - -This function should be included because it's a member of `N7`, which matches `N5::N6::*7` - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f2_WL(); ----- - -[#C] -== C - -This namespace should be included because it strictly matches `C` - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct C; ----- - -=== Types - -[cols=2] -|=== -| Name -| Description -| link:#C-D[`D`] -| This struct should be included because it's a member of `C` -|=== - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#C-f0_WL[`f0_WL`] -| This function should be included because it's a member of `C` -|=== - -[#C-D] -== link:#C[C]::D - -This struct should be included because it's a member of `C` - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct D; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#C-D-f1_WL[`f1_WL`] -| This function should be included because it's a member of `D` -|=== - -[#C-D-f1_WL] -== link:#C[C]::link:#C-D[D]::f1_WL - -This function should be included because it's a member of `D` - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f1_WL(); ----- - -[#C-f0_WL] -== link:#C[C]::f0_WL - -This function should be included because it's a member of `C` - -=== Synopsis - -Declared in `<whitelist_0.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f0_WL(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/symbol-name/whitelist_0.cpp b/test-files/golden-tests/filters/symbol-name/whitelist_0.cpp deleted file mode 100644 index 16ec260e8..000000000 --- a/test-files/golden-tests/filters/symbol-name/whitelist_0.cpp +++ /dev/null @@ -1,129 +0,0 @@ -/// This namespace should extracted because -/// it's implied by `N0::f0_WL` -namespace N0 -{ - /// This function should be included because - /// it matches `N0::f0_WL` - void f0_WL(); - - /// This function should be excluded because - /// it doesn't match `N0::f0_WL` - void f1_BL(); -} - -/// This namespace should extracted because -/// it's implied by `N1::N3_WL` and `N1::N4::f1_WL` -namespace N1 -{ - /// This function should be excluded because - /// it doesn't match `N1::N3_WL` or `N1::N4::f1_WL` - void f0_BL(); - - /// This namespace should be excluded because - /// it doesn't match `N1::N3_WL` or `N1::N4::f1_WL` - namespace N2 - { - /// This function should be excluded because - /// it doesn't match `N1::N3_WL` or `N1::N4::f1_WL` - void f1_BL(); - } - - /// This namespace should extracted because - /// it's explicitly included by `N1::N3_WL` - namespace N3_WL - { - /// This function should extracted because - /// the namespace `N1::N3_WL` is included - /// as a literal. - void f1_WL(); - } - - /// This namespace should extracted because - /// it's implied by `N1::N4::f1_WL` - namespace N4 - { - /// This function should extracted because - /// it matches `N1::N4::f1_WL` - void f1_WL(); - - /// This function should be excluded because - /// it doesn't match `N1::N4::f1_WL` - void f2_BL(); - } -} - -/// This namespace should extracted because -/// it's implied by `N5::N6::*7` -namespace N5 -{ - /// This function should be excluded because - /// it doesn't match `N5::N6::*7` - void f0(); - - /// This namespace should extracted because - /// it's implied by `N5::N6::*7` - namespace N6 - { - /// This function should be excluded because - /// it doesn't match `N5::N6::*7` - void f1_BL(); - - /// This namespace should be included because - /// it matches `N5::N6::*7` - namespace N7 - { - /// This function should be included because - /// it's a member of `N7`, which matches - /// `N5::N6::*7` - void f2_WL(); - } - - /// This namespace should be included because - /// it matches `N5::N6::*7` - namespace M7 - { - /// This function should be included because - /// it's a member of `M7`, which matches - /// `N5::N6::*7` - void f2_WL(); - } - - /// This namespace should be excluded because - /// it doesn't match or is implied by - /// `N5::N6::*7` - namespace N8 - { - /// This function should be excluded because - /// it doesn't match `N5::N6::*7` - void f2_BL(); - } - } -} - -/// This namespace should be included because -/// it strictly matches `C` -struct C -{ - /// This function should be included because - /// it's a member of `C` - void f0_WL(); - - /// This struct should be included because - /// it's a member of `C` - struct D { - /// This function should be included because - /// it's a member of `D` - void f1_WL(); - }; -}; - -/// This namespace should be excluded even -/// though it matches the prefix of `N9::*_WL` -/// because there are no members of `N9` that -/// actually match the filters. -namespace N9 -{ - /// This function should be excluded because - /// it doesn't match `N9::*_WL` - void f0_BL(); -} \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/whitelist_0.html b/test-files/golden-tests/filters/symbol-name/whitelist_0.html deleted file mode 100644 index f2b02e598..000000000 --- a/test-files/golden-tests/filters/symbol-name/whitelist_0.html +++ /dev/null @@ -1,459 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Namespaces

- - - - - - - - - - - - - -
NameDescription
N0 This namespace should extracted because it's implied by N0::f0_WL
N1 This namespace should extracted because it's implied by N1::N3_WL and N1::N4::f1_WL
N5 This namespace should extracted because it's implied by N5::N6::*7
- -

Types

- - - - - - - - - - - -
NameDescription
C This namespace should be included because it strictly matches C
- -
-
-
-

N0

-
-This namespace should extracted because it's implied by N0::f0_WL - -
-
-

Functions

- - - - - - - - - - - -
NameDescription
f0_WL This function should be included because it matches N0::f0_WL
- -
-
-
-

N0::f0_WL

-
-This function should be included because it matches N0::f0_WL - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-void
-f0_WL();
-
-
-
-
-
-
-
-

N1

-
-This namespace should extracted because it's implied by N1::N3_WL and N1::N4::f1_WL - -
-
-

Namespaces

- - - - - - - - - - - - -
NameDescription
N3_WL This namespace should extracted because it's explicitly included by N1::N3_WL
N4 This namespace should extracted because it's implied by N1::N4::f1_WL
- -
-
-
-

N1::N3_WL

-
-This namespace should extracted because it's explicitly included by N1::N3_WL - -
-
-

Functions

- - - - - - - - - - - -
NameDescription
f1_WL This function should extracted because the namespace N1::N3_WL is included as a literal.
- -
-
-
-

N1::N3_WL::f1_WL

-
-This function should extracted because the namespace N1::N3_WL is included as a literal. - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-void
-f1_WL();
-
-
-
-
-
-
-
-

N1::N4

-
-This namespace should extracted because it's implied by N1::N4::f1_WL - -
-
-

Functions

- - - - - - - - - - - -
NameDescription
f1_WL This function should extracted because it matches N1::N4::f1_WL
- -
-
-
-

N1::N4::f1_WL

-
-This function should extracted because it matches N1::N4::f1_WL - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-void
-f1_WL();
-
-
-
-
-
-
-
-

N5

-
-This namespace should extracted because it's implied by N5::N6::*7 - -
-
-

Namespaces

- - - - - - - - - - - -
NameDescription
N6 This namespace should extracted because it's implied by N5::N6::*7
- -
-
-
-

N5::N6

-
-This namespace should extracted because it's implied by N5::N6::*7 - -
-
-

Namespaces

- - - - - - - - - - - - -
NameDescription
M7 This namespace should be included because it matches N5::N6::*7
N7 This namespace should be included because it matches N5::N6::*7
- -
-
-
-

N5::N6::M7

-
-This namespace should be included because it matches N5::N6::*7 - -
-
-

Functions

- - - - - - - - - - - -
NameDescription
f2_WL This function should be included because it's a member of M7, which matches N5::N6::*7
- -
-
-
-

N5::N6::M7::f2_WL

-
-This function should be included because it's a member of M7, which matches N5::N6::*7 - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-void
-f2_WL();
-
-
-
-
-
-
-
-

N5::N6::N7

-
-This namespace should be included because it matches N5::N6::*7 - -
-
-

Functions

- - - - - - - - - - - -
NameDescription
f2_WL This function should be included because it's a member of N7, which matches N5::N6::*7
- -
-
-
-

N5::N6::N7::f2_WL

-
-This function should be included because it's a member of N7, which matches N5::N6::*7 - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-void
-f2_WL();
-
-
-
-
-
-
-
-

C

-
-This namespace should be included because it strictly matches C - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-struct C;
-
-
-
-
-

Types

- - - - - - - - - - - -
NameDescription
D This struct should be included because it's a member of C
- -

Member Functions

- - - - - - - - - - - -
NameDescription
f0_WL This function should be included because it's a member of C
- - - -
-
-
-

C::D

-
-This struct should be included because it's a member of C - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-struct D;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
f1_WL This function should be included because it's a member of D
- - - -
-
-
-

C::D::f1_WL

-
-This function should be included because it's a member of D - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-void
-f1_WL();
-
-
-
-
-
-
-
-

C::f0_WL

-
-This function should be included because it's a member of C - -
-
-
-

Synopsis

-
-Declared in <whitelist_0.cpp>
-
-void
-f0_WL();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-name/whitelist_0.xml b/test-files/golden-tests/filters/symbol-name/whitelist_0.xml deleted file mode 100644 index 1150be74d..000000000 --- a/test-files/golden-tests/filters/symbol-name/whitelist_0.xml +++ /dev/null @@ -1,161 +0,0 @@ - - - - - - - This namespace should extracted because it's implied by - N0::f0_WL - - - - - - - This function should be included because it matches - N0::f0_WL - - - - - - - - This namespace should extracted because it's implied by - N1::N3_WL - and - N1::N4::f1_WL - - - - - - This namespace should extracted because it's explicitly included by - N1::N3_WL - - - - - - - This function should extracted because the namespace - N1::N3_WL - is included - as a literal. - - - - - - - - This namespace should extracted because it's implied by - N1::N4::f1_WL - - - - - - - This function should extracted because it matches - N1::N4::f1_WL - - - - - - - - - This namespace should extracted because it's implied by - N5::N6::*7 - - - - - - This namespace should extracted because it's implied by - N5::N6::*7 - - - - - - This namespace should be included because it matches - N5::N6::*7 - - - - - - - This function should be included because it's a member of - M7 - , which matches - - N5::N6::*7 - - - - - - - - This namespace should be included because it matches - N5::N6::*7 - - - - - - - This function should be included because it's a member of - N7 - , which matches - - N5::N6::*7 - - - - - - - - - - - This namespace should be included because it strictly matches - C - - - - - - - This struct should be included because it's a member of - C - - - - - - - This function should be included because it's a member of - D - - - - - - - - - This function should be included because it's a member of - C - - - - - - diff --git a/test-files/golden-tests/filters/symbol-name/whitelist_0.yml b/test-files/golden-tests/filters/symbol-name/whitelist_0.yml deleted file mode 100644 index 084ffdeb0..000000000 --- a/test-files/golden-tests/filters/symbol-name/whitelist_0.yml +++ /dev/null @@ -1,7 +0,0 @@ -include-symbols: - - 'N0::f0_WL' - - 'N1::N3_WL' - - 'N1::N4::f1_WL' - - 'N5::N6::*7' - - 'C' - - 'N9::*_WL' diff --git a/test-files/golden-tests/filters/symbol-type/nested-private-template.adoc b/test-files/golden-tests/filters/symbol-type/nested-private-template.adoc deleted file mode 100644 index 563aac48d..000000000 --- a/test-files/golden-tests/filters/symbol-type/nested-private-template.adoc +++ /dev/null @@ -1,66 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#range[`range`] -|=== - -[#range] -== range - -=== Synopsis - -Declared in `<nested‐private‐template.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -class range; ----- - -=== Private Types - -[cols=1] -|=== -| Name -| link:#range-impl-0e[`impl`] -| link:#range-impl-00[`impl<R, false>`] -|=== - -[#range-impl-0e] -== link:#range[range]::impl - -=== Synopsis - -Declared in `<nested‐private‐template.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template< - class R, - bool> -struct impl; ----- - -[#range-impl-00] -== link:#range[range]::link:#range-impl-0e[impl]<R, false> - -=== Synopsis - -Declared in `<nested‐private‐template.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class R> -struct link:#range-impl-0e[impl]<R, false>; ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/filters/symbol-type/nested-private-template.cpp b/test-files/golden-tests/filters/symbol-type/nested-private-template.cpp deleted file mode 100644 index 5d758cd27..000000000 --- a/test-files/golden-tests/filters/symbol-type/nested-private-template.cpp +++ /dev/null @@ -1,12 +0,0 @@ -template -class range -{ - template - struct impl; -}; - -template -template -struct range::impl -{ -}; diff --git a/test-files/golden-tests/filters/symbol-type/nested-private-template.html b/test-files/golden-tests/filters/symbol-type/nested-private-template.html deleted file mode 100644 index 85405ef6c..000000000 --- a/test-files/golden-tests/filters/symbol-type/nested-private-template.html +++ /dev/null @@ -1,102 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
range
- -
-
-
-

range

-
-
-

Synopsis

-
-Declared in <nested-private-template.cpp>
-
-template<class T>
-class range;
-
-
-
-
- - -

Private Types

- - - - - - - - - - - -
Name
impl
impl<R, false>
- -
-
- -
-

Synopsis

-
-Declared in <nested-private-template.cpp>
-
-template<
-    class R,
-    bool>
-struct impl;
-
-
-
-
- - -
-
- -
-

Synopsis

-
-Declared in <nested-private-template.cpp>
-
-template<class R>
-struct impl<R, false>;
-
-
-
-
- - -
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/filters/symbol-type/nested-private-template.xml b/test-files/golden-tests/filters/symbol-type/nested-private-template.xml deleted file mode 100644 index ba14e83fc..000000000 --- a/test-files/golden-tests/filters/symbol-type/nested-private-template.xml +++ /dev/null @@ -1,27 +0,0 @@ - - - - - - diff --git a/test-files/golden-tests/filters/symbol-type/nested-private-template.yml b/test-files/golden-tests/filters/symbol-type/nested-private-template.yml deleted file mode 100644 index 85d1347f1..000000000 --- a/test-files/golden-tests/filters/symbol-type/nested-private-template.yml +++ /dev/null @@ -1 +0,0 @@ -extract-private: true \ No newline at end of file diff --git a/test-files/golden-tests/snippets/distance.adoc b/test-files/golden-tests/snippets/distance.adoc deleted file mode 100644 index 35c404084..000000000 --- a/test-files/golden-tests/snippets/distance.adoc +++ /dev/null @@ -1,48 +0,0 @@ -= Reference -:mrdocs: - -[#distance] -== distance - -Return the distance between two points - -=== Synopsis - -Declared in `<distance.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -double -distance( - double x0, - double y0, - double x1, - double y1); ----- - -=== Description - -This function returns the distance between two points according to the Euclidean distance formula. - -=== Return Value - -The distance between the two points - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *x0* -| The x‐coordinate of the first point -| *y0* -| The y‐coordinate of the first point -| *x1* -| The x‐coordinate of the second point -| *y1* -| The y‐coordinate of the second point -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/snippets/distance.cpp b/test-files/golden-tests/snippets/distance.cpp deleted file mode 100644 index 8983087c6..000000000 --- a/test-files/golden-tests/snippets/distance.cpp +++ /dev/null @@ -1,13 +0,0 @@ -/** Return the distance between two points - - This function returns the distance between two points - according to the Euclidean distance formula. - - @param x0 The x-coordinate of the first point - @param y0 The y-coordinate of the first point - @param x1 The x-coordinate of the second point - @param y1 The y-coordinate of the second point - @return The distance between the two points -*/ -double -distance(double x0, double y0, double x1, double y1); \ No newline at end of file diff --git a/test-files/golden-tests/snippets/distance.html b/test-files/golden-tests/snippets/distance.html deleted file mode 100644 index 03711e3e1..000000000 --- a/test-files/golden-tests/snippets/distance.html +++ /dev/null @@ -1,75 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

distance

-
-Return the distance between two points - -
-
-
-

Synopsis

-
-Declared in <distance.cpp>
-
-double
-distance(
-    double x0,
-    double y0,
-    double x1,
-    double y1);
-
-
-
-
-
-

Description

-

This function returns the distance between two points according to the Euclidean distance formula.

-
-
-

Return Value

-The distance between the two points -
-
-

Parameters

- - - - - - - - - - - - - - - - - - - - - - - - - -
NameDescription
x0The x-coordinate of the first point
y0The y-coordinate of the first point
x1The x-coordinate of the second point
y1The y-coordinate of the second point
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/snippets/distance.xml b/test-files/golden-tests/snippets/distance.xml deleted file mode 100644 index 839e18c1d..000000000 --- a/test-files/golden-tests/snippets/distance.xml +++ /dev/null @@ -1,47 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - Return the distance between two points - - - This function returns the distance between two points according to the Euclidean distance formula. - - - The distance between the two points - - - The x-coordinate of the first point - - - The y-coordinate of the first point - - - The x-coordinate of the second point - - - The y-coordinate of the second point - - - - - diff --git a/test-files/golden-tests/snippets/is_prime.adoc b/test-files/golden-tests/snippets/is_prime.adoc deleted file mode 100644 index 3c2597476..000000000 --- a/test-files/golden-tests/snippets/is_prime.adoc +++ /dev/null @@ -1,39 +0,0 @@ -= Reference -:mrdocs: - -[#is_prime] -== is_prime - -Return true if a number is prime. - -=== Synopsis - -Declared in `<is_prime.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -bool -is_prime(unsigned long long n) noexcept; ----- - -=== Description - -=== Complexity -Linear in n. - -=== Return Value - -Whether or not n is prime. - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *n* -| The number to test -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/snippets/is_prime.cpp b/test-files/golden-tests/snippets/is_prime.cpp deleted file mode 100644 index b13810c01..000000000 --- a/test-files/golden-tests/snippets/is_prime.cpp +++ /dev/null @@ -1,12 +0,0 @@ -/** Return true if a number is prime. - - @par Complexity - - Linear in n. - - @return Whether or not n is prime. - @param n The number to test - -*/ -bool -is_prime(unsigned long long n) noexcept; \ No newline at end of file diff --git a/test-files/golden-tests/snippets/is_prime.html b/test-files/golden-tests/snippets/is_prime.html deleted file mode 100644 index 9953d6a86..000000000 --- a/test-files/golden-tests/snippets/is_prime.html +++ /dev/null @@ -1,60 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

is_prime

-
-Return true if a number is prime. - -
-
-
-

Synopsis

-
-Declared in <is_prime.cpp>
-
-bool
-is_prime(unsigned long long n) noexcept;
-
-
-
-
-
-

Description

-

Complexity

-

Linear in n.

-
-
-

Return Value

-Whether or not n is prime. -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
nThe number to test
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/snippets/is_prime.xml b/test-files/golden-tests/snippets/is_prime.xml deleted file mode 100644 index de0670265..000000000 --- a/test-files/golden-tests/snippets/is_prime.xml +++ /dev/null @@ -1,30 +0,0 @@ - - - - - - - - - - - - - - Return true if a number is prime. - - Complexity - - Linear in n. - - - Whether or not n is prime. - - - The number to test - - - - - diff --git a/test-files/golden-tests/snippets/mrdocs.yml b/test-files/golden-tests/snippets/mrdocs.yml deleted file mode 100644 index 11a371ee4..000000000 --- a/test-files/golden-tests/snippets/mrdocs.yml +++ /dev/null @@ -1,4 +0,0 @@ -source-root: . -input: - - . -show-namespaces: false \ No newline at end of file diff --git a/test-files/golden-tests/snippets/sqrt.adoc b/test-files/golden-tests/snippets/sqrt.adoc deleted file mode 100644 index 5c35b2eeb..000000000 --- a/test-files/golden-tests/snippets/sqrt.adoc +++ /dev/null @@ -1,60 +0,0 @@ -= Reference -:mrdocs: - -[#sqrt] -== sqrt - -Computes the square root of an integral value. - -=== Synopsis - -Declared in `<sqrt.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -T -sqrt(T value) -requires std::is_integral_v<T>; ----- - -=== Description - -This function calculates the square root of a given integral value using bit manipulation. - -=== Exceptions - -[cols=2] -|=== -| Name -| Thrown on -| `std::invalid_argument` -| if the input value is negative. -|=== - -=== Return Value - -The square root of the input value. - -=== Template Parameters - -[cols=2] -|=== -| Name -| Description -| *T* -| The type of the input value. Must be an integral type. -|=== - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The integral value to compute the square root of. -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/snippets/sqrt.cpp b/test-files/golden-tests/snippets/sqrt.cpp deleted file mode 100644 index 24d30487a..000000000 --- a/test-files/golden-tests/snippets/sqrt.cpp +++ /dev/null @@ -1,34 +0,0 @@ -#include -#include - -/** Computes the square root of an integral value. - - This function calculates the square root of a - given integral value using bit manipulation. - - @throws std::invalid_argument if the input value is negative. - - @tparam T The type of the input value. Must be an integral type. - @param value The integral value to compute the square root of. - @return The square root of the input value. - */ -template -std::enable_if_t, T> sqrt(T value) { - if (value < 0) { - throw std::invalid_argument( - "Cannot compute square root of a negative number"); - } - T result = 0; - // The second-to-top bit is set - T bit = 1 << (sizeof(T) * 8 - 2); - while (bit > value) bit >>= 2; - while (bit != 0) { - if (value >= result + bit) { - value -= result + bit; - result += bit << 1; - } - result >>= 1; - bit >>= 2; - } - return result; -} diff --git a/test-files/golden-tests/snippets/sqrt.html b/test-files/golden-tests/snippets/sqrt.html deleted file mode 100644 index ef3f3bbe6..000000000 --- a/test-files/golden-tests/snippets/sqrt.html +++ /dev/null @@ -1,95 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

sqrt

-
-Computes the square root of an integral value. - -
-
-
-

Synopsis

-
-Declared in <sqrt.cpp>
-
-template<typename T>
-T
-sqrt(T value)
-requires std::is_integral_v<T>;
-
-
-
-
-
-

Description

-

This function calculates the square root of a given integral value using bit manipulation.

-
-
-

Exceptions

- - - - - - - - - - - - - -
NameThrown on
std::invalid_argumentif the input value is negative.
-
-
-

Return Value

-The square root of the input value. -
-
-

Template Parameters

- - - - - - - - - - - - - -
NameDescription
TThe type of the input value. Must be an integral type.
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe integral value to compute the square root of.
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/snippets/sqrt.xml b/test-files/golden-tests/snippets/sqrt.xml deleted file mode 100644 index ef5b19c51..000000000 --- a/test-files/golden-tests/snippets/sqrt.xml +++ /dev/null @@ -1,38 +0,0 @@ - - - - - - diff --git a/test-files/golden-tests/snippets/terminate.adoc b/test-files/golden-tests/snippets/terminate.adoc deleted file mode 100644 index 5798be6df..000000000 --- a/test-files/golden-tests/snippets/terminate.adoc +++ /dev/null @@ -1,28 +0,0 @@ -= Reference -:mrdocs: - -[#terminate] -== terminate - -Exit the program. - -=== Synopsis - -Declared in `<terminate.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -[[noreturn]] -void -terminate() noexcept; ----- - -=== Description - -The program will end immediately. - -[NOTE] -This function does not return. - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/snippets/terminate.cpp b/test-files/golden-tests/snippets/terminate.cpp deleted file mode 100644 index b3e291bc5..000000000 --- a/test-files/golden-tests/snippets/terminate.cpp +++ /dev/null @@ -1,9 +0,0 @@ -/** Exit the program. - - The program will end immediately. - - @note This function does not return. -*/ -[[noreturn]] -void -terminate() noexcept; \ No newline at end of file diff --git a/test-files/golden-tests/snippets/terminate.html b/test-files/golden-tests/snippets/terminate.html deleted file mode 100644 index b96f942b5..000000000 --- a/test-files/golden-tests/snippets/terminate.html +++ /dev/null @@ -1,43 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

terminate

-
-Exit the program. - -
-
-
-

Synopsis

-
-Declared in <terminate.cpp>
-
-[[noreturn]]
-void
-terminate() noexcept;
-
-
-
-
-
-

Description

-

The program will end immediately.

-
-

NOTE

-

This function does not return.

-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/snippets/terminate.xml b/test-files/golden-tests/snippets/terminate.xml deleted file mode 100644 index a47f44fa8..000000000 --- a/test-files/golden-tests/snippets/terminate.xml +++ /dev/null @@ -1,21 +0,0 @@ - - - - - - - - - Exit the program. - - - The program will end immediately. - - - This function does not return. - - - - - diff --git a/test-files/golden-tests/symbols/concept/concept.adoc b/test-files/golden-tests/symbols/concept/concept.adoc deleted file mode 100644 index 7cba22191..000000000 --- a/test-files/golden-tests/symbols/concept/concept.adoc +++ /dev/null @@ -1,71 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#f[`f`] -|=== - -=== Variables - -[cols=1] -|=== -| Name -| link:#x[`x`] -|=== - -=== Concepts - -[cols=1] -|=== -| Name -| link:#C[`C`] -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<concept.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<link:#C[C] T> -void -f(); ----- - -[#x] -== x - -=== Synopsis - -Declared in `<concept.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -link:#C[C] auto x = 0; ----- - -[#C] -== C - -=== Synopsis - -Declared in `<concept.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -concept C = sizeof(T) == sizeof(int); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/concept/concept.cpp b/test-files/golden-tests/symbols/concept/concept.cpp deleted file mode 100644 index b8abe9d69..000000000 --- a/test-files/golden-tests/symbols/concept/concept.cpp +++ /dev/null @@ -1,7 +0,0 @@ -template -concept C = sizeof(T) == sizeof(int); - -template -void f(); - -C auto x = 0; diff --git a/test-files/golden-tests/symbols/concept/concept.html b/test-files/golden-tests/symbols/concept/concept.html deleted file mode 100644 index cc30d6c1e..000000000 --- a/test-files/golden-tests/symbols/concept/concept.html +++ /dev/null @@ -1,106 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - -
Name
f
- -

Variables

- - - - - - - - - - -
Name
x
- -

Concepts

- - - - - - - - - - -
Name
C
- -
-
-
-

f

-
-
-

Synopsis

-
-Declared in <concept.cpp>
-
-template<C T>
-void
-f();
-
-
-
-
-
-
-
-

x

-
-
-

Synopsis

-
-Declared in <concept.cpp>
-
-C auto x = 0;
-
-
-
-
-
-
-
-

C

-
-
-

Synopsis

-
-Declared in <concept.cpp>
-
-template<typename T>
-concept C = sizeof(T) == sizeof(int);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/concept/concept.xml b/test-files/golden-tests/symbols/concept/concept.xml deleted file mode 100644 index 4cf58ad32..000000000 --- a/test-files/golden-tests/symbols/concept/concept.xml +++ /dev/null @@ -1,23 +0,0 @@ - - - - - - - - - - - - diff --git a/test-files/golden-tests/symbols/concept/requires-clause.adoc b/test-files/golden-tests/symbols/concept/requires-clause.adoc deleted file mode 100644 index 766a1318c..000000000 --- a/test-files/golden-tests/symbols/concept/requires-clause.adoc +++ /dev/null @@ -1,157 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#A-08[`A`] -| link:#A-0b[`A`] -|=== - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f[`f`] -| -| link:#g-0f[`g`] -| -|=== - -[#A-08] -== A - -=== Synopsis - -Declared in `<requires‐clause.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -requires (sizeof(T) == 2) -struct A; ----- - -[#A-0b] -== A - -=== Synopsis - -Declared in `<requires‐clause.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename U> -requires (sizeof(U) == 2) -struct A; ----- - -[#f] -== f - -=== Synopsis - -Declared in `<requires‐clause.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -void -f() -requires (sizeof(U) == 2); ----- - -[#g-0f] -== g - -=== Synopses - -Declared in `<requires‐clause.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -requires (sizeof(T) == 2) -void -link:#g-0e[g](); ----- - -[.small]#link:#g-0e[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -requires (sizeof(T) == 4) -void -link:#g-02[g](); ----- - -[.small]#link:#g-02[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename U> -requires (sizeof(U) == 2) -void -link:#g-08[g](); ----- - -[.small]#link:#g-08[_» more..._]# - -[#g-0e] -== g - -=== Synopsis - -Declared in `<requires‐clause.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -requires (sizeof(T) == 2) -void -g(); ----- - -[#g-02] -== g - -=== Synopsis - -Declared in `<requires‐clause.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename T> -requires (sizeof(T) == 4) -void -g(); ----- - -[#g-08] -== g - -=== Synopsis - -Declared in `<requires‐clause.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename U> -requires (sizeof(U) == 2) -void -g(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/concept/requires-clause.cpp b/test-files/golden-tests/symbols/concept/requires-clause.cpp deleted file mode 100644 index e8e84f926..000000000 --- a/test-files/golden-tests/symbols/concept/requires-clause.cpp +++ /dev/null @@ -1,23 +0,0 @@ -template -void f() requires (sizeof(T) == 4); - -template -void f() requires (sizeof(T) == 2); - -template -void f() requires (sizeof(U) == 2); - -template requires (sizeof(T) == 4) -void g(); - -template requires (sizeof(T) == 2) -void g(); - -template requires (sizeof(U) == 2) -void g(); - -template requires (sizeof(T) == 2) -struct A; - -template requires (sizeof(U) == 2) -struct A; diff --git a/test-files/golden-tests/symbols/concept/requires-clause.html b/test-files/golden-tests/symbols/concept/requires-clause.html deleted file mode 100644 index 51fb8055c..000000000 --- a/test-files/golden-tests/symbols/concept/requires-clause.html +++ /dev/null @@ -1,199 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
Name
A
A
- -

Functions

- - - - - - - - - - - - -
NameDescription
f
g
- -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <requires-clause.cpp>
-
-template<typename T>
-requires (sizeof(T) == 2)
-struct A;
-
-
-
-
- - -
-
-
-

A

-
-
-

Synopsis

-
-Declared in <requires-clause.cpp>
-
-template<typename U>
-requires (sizeof(U) == 2)
-struct A;
-
-
-
-
- - -
-
-
-

f

-
-
-

Synopsis

-
-Declared in <requires-clause.cpp>
-
-template<typename T>
-void
-f()
-requires (sizeof(U) == 2);
-
-
-
-
-
-
-
-

g

-
-
-

Synopses

-
-Declared in <requires-clause.cpp>
- -
-template<typename T>
-requires (sizeof(T) == 2)
-void
-g();
-
-
-
» more... - - -
-template<typename T>
-requires (sizeof(T) == 4)
-void
-g();
-
-
-
» more... - - -
-template<typename U>
-requires (sizeof(U) == 2)
-void
-g();
-
-
-
» more... - - -
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <requires-clause.cpp>
-
-template<typename T>
-requires (sizeof(T) == 2)
-void
-g();
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <requires-clause.cpp>
-
-template<typename T>
-requires (sizeof(T) == 4)
-void
-g();
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <requires-clause.cpp>
-
-template<typename U>
-requires (sizeof(U) == 2)
-void
-g();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/concept/requires-clause.xml b/test-files/golden-tests/symbols/concept/requires-clause.xml deleted file mode 100644 index b699c46b6..000000000 --- a/test-files/golden-tests/symbols/concept/requires-clause.xml +++ /dev/null @@ -1,44 +0,0 @@ - - - - - - - - - - - diff --git a/test-files/golden-tests/symbols/enum/enum.adoc b/test-files/golden-tests/symbols/enum/enum.adoc deleted file mode 100644 index e3afeb014..000000000 --- a/test-files/golden-tests/symbols/enum/enum.adoc +++ /dev/null @@ -1,136 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Enums - -[cols=2] -|=== -| Name -| Description -| link:#E0[`E0`] -| E0 brief. -| link:#E1[`E1`] -| -| link:#E2[`E2`] -| E2 brief. -| link:#E3[`E3`] -| -|=== - -[#E0] -== E0 - -E0 brief. - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -enum E0; ----- - -=== Members - - -[cols=2] -|=== -| Name -| Description -|`e0` -|e0 brief. -|`e1` -|e1 brief. -|=== - -=== Description - -E0 description. - -[#E1] -== E1 - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -enum E1 : char; ----- - -=== Members - - -[cols=2] -|=== -| Name -| Description -|`e2` -| -|`e3` -| -|=== - -[#E2] -== E2 - -E2 brief. - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -enum class E2 : int; ----- - -=== Members - - -[cols=2] -|=== -| Name -| Description -|`e4` -|e4 brief. -|`e5` -|e5 brief. -|=== - -=== Description - -E2 description. - -[#E3] -== E3 - -=== Synopsis - -Declared in `<enum.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -enum class E3 : char; ----- - -=== Members - - -[cols=2] -|=== -| Name -| Description -|`e6` -| -|`e7` -| -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/enum/enum.cpp b/test-files/golden-tests/symbols/enum/enum.cpp deleted file mode 100644 index a636a5d50..000000000 --- a/test-files/golden-tests/symbols/enum/enum.cpp +++ /dev/null @@ -1,47 +0,0 @@ -/** E0 brief. - - E0 description. -*/ -enum E0 -{ - /** e0 brief. - - e0 description. - */ - e0 = 1, - /** e1 brief. - - e1 description. - */ - e1 -}; - -enum E1 : char -{ - e2, - e3 -}; - -/** E2 brief. - - E2 description. -*/ -enum class E2 -{ - /** e4 brief. - - e4 description. - */ - e4, - /** e5 brief. - - e5 description. - */ - e5 -}; - -enum class E3 : char -{ - e6, - e7 -}; diff --git a/test-files/golden-tests/symbols/enum/enum.html b/test-files/golden-tests/symbols/enum/enum.html deleted file mode 100644 index 014393e77..000000000 --- a/test-files/golden-tests/symbols/enum/enum.html +++ /dev/null @@ -1,196 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Enums

- - - - - - - - - - - - - - -
NameDescription
E0 E0 brief.
E1
E2 E2 brief.
E3
- -
-
-
-

E0

-
-E0 brief. - -
-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-enum E0;
-
-
-
-
-
-

Members

- - - - - - - - - - - - - - - - - -
NameDescription
e0e0 brief.
e1e1 brief.
-
-
-

Description

-

E0 description.

-
-
-
-
-

E1

-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-enum E1 : char;
-
-
-
-
-
-

Members

- - - - - - - - - - - - - - - - - -
NameDescription
e2
e3
-
-
-
-
-

E2

-
-E2 brief. - -
-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-enum class E2 : int;
-
-
-
-
-
-

Members

- - - - - - - - - - - - - - - - - -
NameDescription
e4e4 brief.
e5e5 brief.
-
-
-

Description

-

E2 description.

-
-
-
-
-

E3

-
-
-

Synopsis

-
-Declared in <enum.cpp>
-
-enum class E3 : char;
-
-
-
-
-
-

Members

- - - - - - - - - - - - - - - - - -
NameDescription
e6
e7
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/enum/enum.xml b/test-files/golden-tests/symbols/enum/enum.xml deleted file mode 100644 index a8b139bb0..000000000 --- a/test-files/golden-tests/symbols/enum/enum.xml +++ /dev/null @@ -1,99 +0,0 @@ - - - - - - - - E0 brief. - - - E0 description. - - - - - - - e0 brief. - - - e0 description. - - - - - - - - e1 brief. - - - e1 description. - - - - - - - - - - - - - - - - - - - - - - - - E2 brief. - - - E2 description. - - - - - - - e4 brief. - - - e4 description. - - - - - - - - e5 brief. - - - e5 description. - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/symbols/enum/enum.yml b/test-files/golden-tests/symbols/enum/enum.yml deleted file mode 100644 index c5464a44c..000000000 --- a/test-files/golden-tests/symbols/enum/enum.yml +++ /dev/null @@ -1 +0,0 @@ -warn-if-undoc-enum-val: false \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/attributes-2.adoc b/test-files/golden-tests/symbols/function/attributes-2.adoc deleted file mode 100644 index 180cb7bc9..000000000 --- a/test-files/golden-tests/symbols/function/attributes-2.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#f[`f`] -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<attributes‐2.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<class T> -[[nodiscard]] -int -f(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/function/attributes-2.cpp b/test-files/golden-tests/symbols/function/attributes-2.cpp deleted file mode 100644 index 1340ffbe1..000000000 --- a/test-files/golden-tests/symbols/function/attributes-2.cpp +++ /dev/null @@ -1,4 +0,0 @@ -// issue #851 - -template -[[nodiscard]] int f(); diff --git a/test-files/golden-tests/symbols/function/attributes-2.html b/test-files/golden-tests/symbols/function/attributes-2.html deleted file mode 100644 index be20c3787..000000000 --- a/test-files/golden-tests/symbols/function/attributes-2.html +++ /dev/null @@ -1,50 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - -
Name
f
- -
-
-
-

f

-
-
-

Synopsis

-
-Declared in <attributes-2.cpp>
-
-template<class T>
-[[nodiscard]]
-int
-f();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/attributes-2.xml b/test-files/golden-tests/symbols/function/attributes-2.xml deleted file mode 100644 index 7ca447518..000000000 --- a/test-files/golden-tests/symbols/function/attributes-2.xml +++ /dev/null @@ -1,16 +0,0 @@ - - - - - - diff --git a/test-files/golden-tests/symbols/function/attributes_1.adoc b/test-files/golden-tests/symbols/function/attributes_1.adoc deleted file mode 100644 index 7c51921dd..000000000 --- a/test-files/golden-tests/symbols/function/attributes_1.adoc +++ /dev/null @@ -1,30 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#f[`f`] -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<attributes_1.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -[[nodiscard]] -bool -f(); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/function/attributes_1.cpp b/test-files/golden-tests/symbols/function/attributes_1.cpp deleted file mode 100644 index b701df6e2..000000000 --- a/test-files/golden-tests/symbols/function/attributes_1.cpp +++ /dev/null @@ -1,2 +0,0 @@ -// check attributes -[[nodiscard]] bool f(); diff --git a/test-files/golden-tests/symbols/function/attributes_1.html b/test-files/golden-tests/symbols/function/attributes_1.html deleted file mode 100644 index 6b37c6d90..000000000 --- a/test-files/golden-tests/symbols/function/attributes_1.html +++ /dev/null @@ -1,49 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - -
Name
f
- -
-
-
-

f

-
-
-

Synopsis

-
-Declared in <attributes_1.cpp>
-
-[[nodiscard]]
-bool
-f();
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/attributes_1.xml b/test-files/golden-tests/symbols/function/attributes_1.xml deleted file mode 100644 index b7a1d59c1..000000000 --- a/test-files/golden-tests/symbols/function/attributes_1.xml +++ /dev/null @@ -1,13 +0,0 @@ - - - - - - - - - - - - diff --git a/test-files/golden-tests/symbols/function/auto.adoc b/test-files/golden-tests/symbols/function/auto.adoc deleted file mode 100644 index bf102041d..000000000 --- a/test-files/golden-tests/symbols/function/auto.adoc +++ /dev/null @@ -1,47 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=2] -|=== -| Name -| Description -| link:#f[`f`] -| A function that uses auto -|=== - -[#f] -== f - -A function that uses auto - -=== Synopsis - -Declared in `<auto.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -int -f(auto value); ----- - -=== Return Value - -The result. - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *value* -| The value to use. -|=== - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/function/auto.cpp b/test-files/golden-tests/symbols/function/auto.cpp deleted file mode 100644 index 7b4fbce90..000000000 --- a/test-files/golden-tests/symbols/function/auto.cpp +++ /dev/null @@ -1,7 +0,0 @@ -/** A function that uses auto - - @param value The value to use. - @return The result. - */ -int -f(auto value); diff --git a/test-files/golden-tests/symbols/function/auto.html b/test-files/golden-tests/symbols/function/auto.html deleted file mode 100644 index 85f24da73..000000000 --- a/test-files/golden-tests/symbols/function/auto.html +++ /dev/null @@ -1,74 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Functions

- - - - - - - - - - - -
NameDescription
f A function that uses auto
- -
-
-
-

f

-
-A function that uses auto - -
-
-
-

Synopsis

-
-Declared in <auto.cpp>
-
-int
-f(auto value);
-
-
-
-
-
-

Return Value

-The result. -
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
valueThe value to use.
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/auto.xml b/test-files/golden-tests/symbols/function/auto.xml deleted file mode 100644 index 920ff40d4..000000000 --- a/test-files/golden-tests/symbols/function/auto.xml +++ /dev/null @@ -1,26 +0,0 @@ - - - - - - - - - - - - - - A function that uses auto - - - The result. - - - The value to use. - - - - - diff --git a/test-files/golden-tests/symbols/function/explicit-conv-operator.adoc b/test-files/golden-tests/symbols/function/explicit-conv-operator.adoc deleted file mode 100644 index 7fd174b66..000000000 --- a/test-files/golden-tests/symbols/function/explicit-conv-operator.adoc +++ /dev/null @@ -1,184 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#Explicit[`Explicit`] -| link:#ExplicitExpression[`ExplicitExpression`] -| link:#ExplicitFalse[`ExplicitFalse`] -| link:#ExplicitTrue[`ExplicitTrue`] -|=== - -[#Explicit] -== Explicit - -=== Synopsis - -Declared in `<explicit‐conv‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Explicit; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Explicit-2conversion[`operator bool`] -| Conversion to `bool` -|=== - -[#Explicit-2conversion] -== link:#Explicit[Explicit]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<explicit‐conv‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -operator bool(); ----- - -=== Return Value - -The object converted to `bool` - -[#ExplicitExpression] -== ExplicitExpression - -=== Synopsis - -Declared in `<explicit‐conv‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<bool B> -struct ExplicitExpression; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#ExplicitExpression-2conversion[`operator bool`] -| Conversion to `bool` -|=== - -[#ExplicitExpression-2conversion] -== link:#ExplicitExpression[ExplicitExpression]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<explicit‐conv‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -operator bool(); ----- - -=== Return Value - -The object converted to `bool` - -[#ExplicitFalse] -== ExplicitFalse - -=== Synopsis - -Declared in `<explicit‐conv‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct ExplicitFalse; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#ExplicitFalse-2conversion[`operator bool`] -| Conversion to `bool` -|=== - -[#ExplicitFalse-2conversion] -== link:#ExplicitFalse[ExplicitFalse]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<explicit‐conv‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -operator bool(); ----- - -=== Return Value - -The object converted to `bool` - -[#ExplicitTrue] -== ExplicitTrue - -=== Synopsis - -Declared in `<explicit‐conv‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct ExplicitTrue; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#ExplicitTrue-2conversion[`operator bool`] -| Conversion to `bool` -|=== - -[#ExplicitTrue-2conversion] -== link:#ExplicitTrue[ExplicitTrue]::operator bool - -Conversion to `bool` - -=== Synopsis - -Declared in `<explicit‐conv‐operator.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -operator bool(); ----- - -=== Return Value - -The object converted to `bool` - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/function/explicit-conv-operator.cpp b/test-files/golden-tests/symbols/function/explicit-conv-operator.cpp deleted file mode 100644 index 8ab71d70c..000000000 --- a/test-files/golden-tests/symbols/function/explicit-conv-operator.cpp +++ /dev/null @@ -1,18 +0,0 @@ -//Test conversion operators that can be "explicit", "explicit(true)", "explicit(false)" and "explicit(EXPR)" - -struct Explicit { - explicit operator bool(); -}; - -struct ExplicitFalse { - explicit(false) operator bool(); -}; - -struct ExplicitTrue { - explicit(true) operator bool(); -}; - -template -struct ExplicitExpression { - explicit(B) operator bool(); -}; \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/explicit-conv-operator.html b/test-files/golden-tests/symbols/function/explicit-conv-operator.html deleted file mode 100644 index 3a8a1b31f..000000000 --- a/test-files/golden-tests/symbols/function/explicit-conv-operator.html +++ /dev/null @@ -1,256 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - -
Name
Explicit
ExplicitExpression
ExplicitFalse
ExplicitTrue
- -
-
- -
-

Synopsis

-
-Declared in <explicit-conv-operator.cpp>
-
-struct Explicit;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
operator bool Conversion to bool
- - - -
-
-
-

Explicit::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <explicit-conv-operator.cpp>
-
-explicit
-operator bool();
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
- -
-

Synopsis

-
-Declared in <explicit-conv-operator.cpp>
-
-template<bool B>
-struct ExplicitExpression;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
operator bool Conversion to bool
- - - -
-
-
-

ExplicitExpression::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <explicit-conv-operator.cpp>
-
-explicit(B)
-operator bool();
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
- -
-

Synopsis

-
-Declared in <explicit-conv-operator.cpp>
-
-struct ExplicitFalse;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
operator bool Conversion to bool
- - - -
-
-
-

ExplicitFalse::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <explicit-conv-operator.cpp>
-
-explicit(false)
-operator bool();
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
-
- -
-

Synopsis

-
-Declared in <explicit-conv-operator.cpp>
-
-struct ExplicitTrue;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
operator bool Conversion to bool
- - - -
-
-
-

ExplicitTrue::operator bool

-
-Conversion to bool - -
-
-
-

Synopsis

-
-Declared in <explicit-conv-operator.cpp>
-
-explicit(true)
-operator bool();
-
-
-
-
-
-

Return Value

-The object converted to bool -
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/explicit-conv-operator.xml b/test-files/golden-tests/symbols/function/explicit-conv-operator.xml deleted file mode 100644 index c4b72a0be..000000000 --- a/test-files/golden-tests/symbols/function/explicit-conv-operator.xml +++ /dev/null @@ -1,85 +0,0 @@ - - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - - - - - - - - - Conversion to - bool - - - The object converted to - bool - - - - - - diff --git a/test-files/golden-tests/symbols/function/explicit-ctor.adoc b/test-files/golden-tests/symbols/function/explicit-ctor.adoc deleted file mode 100644 index 7760af067..000000000 --- a/test-files/golden-tests/symbols/function/explicit-ctor.adoc +++ /dev/null @@ -1,656 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#Explicit[`Explicit`] -| link:#ExplicitExpression[`ExplicitExpression`] -| link:#ExplicitFalse[`ExplicitFalse`] -| link:#ExplicitTrue[`ExplicitTrue`] -|=== - -[#Explicit] -== Explicit - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Explicit; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Explicit-2constructor-04[`Explicit`] [.small]#[constructor]# -| Constructors -|=== - -[#Explicit-2constructor-04] -== link:#Explicit[Explicit]::Explicit - -Constructors - -=== Synopses - -Declared in `<explicit‐ctor.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -link:#Explicit-2constructor-02[Explicit](); ----- - -[.small]#link:#Explicit-2constructor-02[_» more..._]# - -Copy constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -link:#Explicit-2constructor-00[Explicit](link:#Explicit[Explicit] const& other); ----- - -[.small]#link:#Explicit-2constructor-00[_» more..._]# - -Move constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -link:#Explicit-2constructor-0b[Explicit](link:#Explicit[Explicit]&& other) noexcept; ----- - -[.small]#link:#Explicit-2constructor-0b[_» more..._]# - -Constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -link:#Explicit-2constructor-03[Explicit]( - int, - int); ----- - -[.small]#link:#Explicit-2constructor-03[_» more..._]# - -[#Explicit-2constructor-02] -== link:#Explicit[Explicit]::Explicit - -Default constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -Explicit(); ----- - -[#Explicit-2constructor-00] -== link:#Explicit[Explicit]::Explicit - -Copy constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -Explicit(link:#Explicit[Explicit] const& other); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy construct from -|=== - -[#Explicit-2constructor-0b] -== link:#Explicit[Explicit]::Explicit - -Move constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -Explicit(link:#Explicit[Explicit]&& other) noexcept; ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move construct from -|=== - -[#Explicit-2constructor-03] -== link:#Explicit[Explicit]::Explicit - -Constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit -Explicit( - int, - int); ----- - -[#ExplicitExpression] -== ExplicitExpression - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<bool B> -struct ExplicitExpression; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#ExplicitExpression-2constructor-07[`ExplicitExpression`] [.small]#[constructor]# -| Constructors -|=== - -[#ExplicitExpression-2constructor-07] -== link:#ExplicitExpression[ExplicitExpression]::ExplicitExpression - -Constructors - -=== Synopses - -Declared in `<explicit‐ctor.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -link:#ExplicitExpression-2constructor-0b[ExplicitExpression](); ----- - -[.small]#link:#ExplicitExpression-2constructor-0b[_» more..._]# - -Copy constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -link:#ExplicitExpression-2constructor-04[ExplicitExpression](link:#ExplicitExpression[ExplicitExpression] const& other); ----- - -[.small]#link:#ExplicitExpression-2constructor-04[_» more..._]# - -Move constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -link:#ExplicitExpression-2constructor-08[ExplicitExpression](link:#ExplicitExpression[ExplicitExpression]&& other) noexcept; ----- - -[.small]#link:#ExplicitExpression-2constructor-08[_» more..._]# - -Constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -link:#ExplicitExpression-2constructor-02[ExplicitExpression]( - int, - int); ----- - -[.small]#link:#ExplicitExpression-2constructor-02[_» more..._]# - -[#ExplicitExpression-2constructor-0b] -== link:#ExplicitExpression[ExplicitExpression]::ExplicitExpression - -Default constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -ExplicitExpression(); ----- - -[#ExplicitExpression-2constructor-04] -== link:#ExplicitExpression[ExplicitExpression]::ExplicitExpression - -Copy constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -ExplicitExpression(link:#ExplicitExpression[ExplicitExpression] const& other); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy construct from -|=== - -[#ExplicitExpression-2constructor-08] -== link:#ExplicitExpression[ExplicitExpression]::ExplicitExpression - -Move constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -ExplicitExpression(link:#ExplicitExpression[ExplicitExpression]&& other) noexcept; ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move construct from -|=== - -[#ExplicitExpression-2constructor-02] -== link:#ExplicitExpression[ExplicitExpression]::ExplicitExpression - -Constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(B) -ExplicitExpression( - int, - int); ----- - -[#ExplicitFalse] -== ExplicitFalse - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct ExplicitFalse; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#ExplicitFalse-2constructor-07[`ExplicitFalse`] [.small]#[constructor]# -| Constructors -|=== - -[#ExplicitFalse-2constructor-07] -== link:#ExplicitFalse[ExplicitFalse]::ExplicitFalse - -Constructors - -=== Synopses - -Declared in `<explicit‐ctor.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -link:#ExplicitFalse-2constructor-01[ExplicitFalse](); ----- - -[.small]#link:#ExplicitFalse-2constructor-01[_» more..._]# - -Copy constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -link:#ExplicitFalse-2constructor-08[ExplicitFalse](link:#ExplicitFalse[ExplicitFalse] const& other); ----- - -[.small]#link:#ExplicitFalse-2constructor-08[_» more..._]# - -Move constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -link:#ExplicitFalse-2constructor-0a[ExplicitFalse](link:#ExplicitFalse[ExplicitFalse]&& other) noexcept; ----- - -[.small]#link:#ExplicitFalse-2constructor-0a[_» more..._]# - -Constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -link:#ExplicitFalse-2constructor-04[ExplicitFalse]( - int, - int); ----- - -[.small]#link:#ExplicitFalse-2constructor-04[_» more..._]# - -[#ExplicitFalse-2constructor-01] -== link:#ExplicitFalse[ExplicitFalse]::ExplicitFalse - -Default constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -ExplicitFalse(); ----- - -[#ExplicitFalse-2constructor-08] -== link:#ExplicitFalse[ExplicitFalse]::ExplicitFalse - -Copy constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -ExplicitFalse(link:#ExplicitFalse[ExplicitFalse] const& other); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy construct from -|=== - -[#ExplicitFalse-2constructor-0a] -== link:#ExplicitFalse[ExplicitFalse]::ExplicitFalse - -Move constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -ExplicitFalse(link:#ExplicitFalse[ExplicitFalse]&& other) noexcept; ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move construct from -|=== - -[#ExplicitFalse-2constructor-04] -== link:#ExplicitFalse[ExplicitFalse]::ExplicitFalse - -Constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(false) -ExplicitFalse( - int, - int); ----- - -[#ExplicitTrue] -== ExplicitTrue - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct ExplicitTrue; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#ExplicitTrue-2constructor-01[`ExplicitTrue`] [.small]#[constructor]# -| Constructors -|=== - -[#ExplicitTrue-2constructor-01] -== link:#ExplicitTrue[ExplicitTrue]::ExplicitTrue - -Constructors - -=== Synopses - -Declared in `<explicit‐ctor.cpp>` - -Default constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -link:#ExplicitTrue-2constructor-0d[ExplicitTrue](); ----- - -[.small]#link:#ExplicitTrue-2constructor-0d[_» more..._]# - -Copy constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -link:#ExplicitTrue-2constructor-04[ExplicitTrue](link:#ExplicitTrue[ExplicitTrue] const& other); ----- - -[.small]#link:#ExplicitTrue-2constructor-04[_» more..._]# - -Move constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -link:#ExplicitTrue-2constructor-08[ExplicitTrue](link:#ExplicitTrue[ExplicitTrue]&& other) noexcept; ----- - -[.small]#link:#ExplicitTrue-2constructor-08[_» more..._]# - -Constructor - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -link:#ExplicitTrue-2constructor-05[ExplicitTrue]( - int, - int); ----- - -[.small]#link:#ExplicitTrue-2constructor-05[_» more..._]# - -[#ExplicitTrue-2constructor-0d] -== link:#ExplicitTrue[ExplicitTrue]::ExplicitTrue - -Default constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -ExplicitTrue(); ----- - -[#ExplicitTrue-2constructor-04] -== link:#ExplicitTrue[ExplicitTrue]::ExplicitTrue - -Copy constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -ExplicitTrue(link:#ExplicitTrue[ExplicitTrue] const& other); ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to copy construct from -|=== - -[#ExplicitTrue-2constructor-08] -== link:#ExplicitTrue[ExplicitTrue]::ExplicitTrue - -Move constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -ExplicitTrue(link:#ExplicitTrue[ExplicitTrue]&& other) noexcept; ----- - -=== Parameters - -[cols=2] -|=== -| Name -| Description -| *other* -| The object to move construct from -|=== - -[#ExplicitTrue-2constructor-05] -== link:#ExplicitTrue[ExplicitTrue]::ExplicitTrue - -Constructor - -=== Synopsis - -Declared in `<explicit‐ctor.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -explicit(true) -ExplicitTrue( - int, - int); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/function/explicit-ctor.cpp b/test-files/golden-tests/symbols/function/explicit-ctor.cpp deleted file mode 100644 index f78b831e7..000000000 --- a/test-files/golden-tests/symbols/function/explicit-ctor.cpp +++ /dev/null @@ -1,30 +0,0 @@ -//Test constructors that can be "explicit", "explicit(true)", "explicit(false)" and "explicit(EXPR)" - -struct Explicit { - explicit Explicit(); - explicit Explicit(Explicit const&); - explicit Explicit(Explicit&&) noexcept; - explicit Explicit(int, int); -}; - -struct ExplicitTrue { - explicit(true) ExplicitTrue(); - explicit(true) ExplicitTrue(ExplicitTrue const&); - explicit(true) ExplicitTrue(ExplicitTrue&&) noexcept; - explicit(true) ExplicitTrue(int, int); -}; - -struct ExplicitFalse { - explicit(false) ExplicitFalse(); - explicit(false) ExplicitFalse(ExplicitFalse const&); - explicit(false) ExplicitFalse(ExplicitFalse&&) noexcept; - explicit(false) ExplicitFalse(int, int); -}; - -template -struct ExplicitExpression { - explicit(B) ExplicitExpression(); - explicit(B) ExplicitExpression(ExplicitExpression const&); - explicit(B) ExplicitExpression(ExplicitExpression&&) noexcept; - explicit(B) ExplicitExpression(int, int); -}; \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/explicit-ctor.html b/test-files/golden-tests/symbols/function/explicit-ctor.html deleted file mode 100644 index 0c1abfe4f..000000000 --- a/test-files/golden-tests/symbols/function/explicit-ctor.html +++ /dev/null @@ -1,820 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - - - -
Name
Explicit
ExplicitExpression
ExplicitFalse
ExplicitTrue
- -
-
- -
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-struct Explicit;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
Explicit [constructor]Constructors
- - - -
-
-
-

Explicit::Explicit

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <explicit-ctor.cpp>
-Default constructor -
-explicit
-Explicit();
-
-
-
» more... - -Copy constructor -
-explicit
-Explicit(Explicit const& other);
-
-
-
» more... - -Move constructor -
-explicit
-Explicit(Explicit&& other) noexcept;
-
-
-
» more... - -Constructor -
-explicit
-Explicit(
-    int,
-    int);
-
-
-
» more... - - -
-
-
-
-

Explicit::Explicit

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit
-Explicit();
-
-
-
-
-
-
-
-

Explicit::Explicit

-
-Copy constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit
-Explicit(Explicit const& other);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy construct from
-
-
-
-
-

Explicit::Explicit

-
-Move constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit
-Explicit(Explicit&& other) noexcept;
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move construct from
-
-
-
-
-

Explicit::Explicit

-
-Constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit
-Explicit(
-    int,
-    int);
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-template<bool B>
-struct ExplicitExpression;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
ExplicitExpression [constructor]Constructors
- - - -
-
- -
-

Synopses

-
-Declared in <explicit-ctor.cpp>
-Default constructor -
-explicit(B)
-ExplicitExpression();
-
-
-
» more... - -Copy constructor -
-explicit(B)
-ExplicitExpression(ExplicitExpression const& other);
-
-
-
» more... - -Move constructor -
-explicit(B)
-ExplicitExpression(ExplicitExpression&& other) noexcept;
-
-
-
» more... - -Constructor -
-explicit(B)
-ExplicitExpression(
-    int,
-    int);
-
-
-
» more... - - -
-
-
-
-

ExplicitExpression::ExplicitExpression

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(B)
-ExplicitExpression();
-
-
-
-
-
-
-
-

ExplicitExpression::ExplicitExpression

-
-Copy constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(B)
-ExplicitExpression(ExplicitExpression const& other);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy construct from
-
-
-
-
-

ExplicitExpression::ExplicitExpression

-
-Move constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(B)
-ExplicitExpression(ExplicitExpression&& other) noexcept;
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move construct from
-
-
-
- -
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(B)
-ExplicitExpression(
-    int,
-    int);
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-struct ExplicitFalse;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
ExplicitFalse [constructor]Constructors
- - - -
-
-
-

ExplicitFalse::ExplicitFalse

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <explicit-ctor.cpp>
-Default constructor -
-explicit(false)
-ExplicitFalse();
-
-
-
» more... - -Copy constructor -
-explicit(false)
-ExplicitFalse(ExplicitFalse const& other);
-
-
-
» more... - -Move constructor -
-explicit(false)
-ExplicitFalse(ExplicitFalse&& other) noexcept;
-
-
-
» more... - -Constructor -
-explicit(false)
-ExplicitFalse(
-    int,
-    int);
-
-
-
» more... - - -
-
-
-
-

ExplicitFalse::ExplicitFalse

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(false)
-ExplicitFalse();
-
-
-
-
-
-
-
-

ExplicitFalse::ExplicitFalse

-
-Copy constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(false)
-ExplicitFalse(ExplicitFalse const& other);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy construct from
-
-
-
-
-

ExplicitFalse::ExplicitFalse

-
-Move constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(false)
-ExplicitFalse(ExplicitFalse&& other) noexcept;
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move construct from
-
-
-
-
-

ExplicitFalse::ExplicitFalse

-
-Constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(false)
-ExplicitFalse(
-    int,
-    int);
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-struct ExplicitTrue;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
ExplicitTrue [constructor]Constructors
- - - -
-
-
-

ExplicitTrue::ExplicitTrue

-
-Constructors - -
-
-
-

Synopses

-
-Declared in <explicit-ctor.cpp>
-Default constructor -
-explicit(true)
-ExplicitTrue();
-
-
-
» more... - -Copy constructor -
-explicit(true)
-ExplicitTrue(ExplicitTrue const& other);
-
-
-
» more... - -Move constructor -
-explicit(true)
-ExplicitTrue(ExplicitTrue&& other) noexcept;
-
-
-
» more... - -Constructor -
-explicit(true)
-ExplicitTrue(
-    int,
-    int);
-
-
-
» more... - - -
-
-
-
-

ExplicitTrue::ExplicitTrue

-
-Default constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(true)
-ExplicitTrue();
-
-
-
-
-
-
-
-

ExplicitTrue::ExplicitTrue

-
-Copy constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(true)
-ExplicitTrue(ExplicitTrue const& other);
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to copy construct from
-
-
-
-
-

ExplicitTrue::ExplicitTrue

-
-Move constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(true)
-ExplicitTrue(ExplicitTrue&& other) noexcept;
-
-
-
-
-
-

Parameters

- - - - - - - - - - - - - -
NameDescription
otherThe object to move construct from
-
-
-
-
-

ExplicitTrue::ExplicitTrue

-
-Constructor - -
-
-
-

Synopsis

-
-Declared in <explicit-ctor.cpp>
-
-explicit(true)
-ExplicitTrue(
-    int,
-    int);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/explicit-ctor.xml b/test-files/golden-tests/symbols/function/explicit-ctor.xml deleted file mode 100644 index 91753effa..000000000 --- a/test-files/golden-tests/symbols/function/explicit-ctor.xml +++ /dev/null @@ -1,237 +0,0 @@ - - - - - - - - - - Default constructor - - - - - - - - - - - - - Copy constructor - - - The object to copy construct from - - - - - - - - - - - - - Move constructor - - - The object to move construct from - - - - - - - - - - - - - - Constructor - - - - - - - - - - - - Default constructor - - - - - - - - - - - - - Copy constructor - - - The object to copy construct from - - - - - - - - - - - - - Move constructor - - - The object to move construct from - - - - - - - - - - - - - - Constructor - - - - - - - - - - - Default constructor - - - - - - - - - - - - - Copy constructor - - - The object to copy construct from - - - - - - - - - - - - - Move constructor - - - The object to move construct from - - - - - - - - - - - - - - Constructor - - - - - - diff --git a/test-files/golden-tests/symbols/function/explicit-object-parameter.adoc b/test-files/golden-tests/symbols/function/explicit-object-parameter.adoc deleted file mode 100644 index a401df24a..000000000 --- a/test-files/golden-tests/symbols/function/explicit-object-parameter.adoc +++ /dev/null @@ -1,101 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#Optional[`Optional`] -|=== - -[#Optional] -== Optional - -=== Synopsis - -Declared in `<explicit‐object‐parameter.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -struct Optional; ----- - -=== Member Functions - -[cols=2] -|=== -| Name -| Description -| link:#Optional-value-0c[`value`] -| -|=== - -[#Optional-value-0c] -== link:#Optional[Optional]::value - -=== Synopses - -Declared in `<explicit‐object‐parameter.cpp>` - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename Self> -constexpr -auto&& -link:#Optional-value-05[value](this Self&& self); ----- - -[.small]#link:#Optional-value-05[_» more..._]# - - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename Self> -constexpr -auto&& -link:#Optional-value-06[value](this - Self&& self, - int x); ----- - -[.small]#link:#Optional-value-06[_» more..._]# - -[#Optional-value-05] -== link:#Optional[Optional]::value - -=== Synopsis - -Declared in `<explicit‐object‐parameter.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename Self> -constexpr -auto&& -value(this Self&& self); ----- - -[#Optional-value-06] -== link:#Optional[Optional]::value - -=== Synopsis - -Declared in `<explicit‐object‐parameter.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<typename Self> -constexpr -auto&& -value(this - Self&& self, - int x); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/function/explicit-object-parameter.cpp b/test-files/golden-tests/symbols/function/explicit-object-parameter.cpp deleted file mode 100644 index 24ec2a9dd..000000000 --- a/test-files/golden-tests/symbols/function/explicit-object-parameter.cpp +++ /dev/null @@ -1,8 +0,0 @@ -struct Optional -{ - template - constexpr auto&& value(this Self&& self); - - template - constexpr auto&& value(this Self&& self, int x); -}; diff --git a/test-files/golden-tests/symbols/function/explicit-object-parameter.html b/test-files/golden-tests/symbols/function/explicit-object-parameter.html deleted file mode 100644 index eed5310c4..000000000 --- a/test-files/golden-tests/symbols/function/explicit-object-parameter.html +++ /dev/null @@ -1,134 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - -
Name
Optional
- -
-
- -
-

Synopsis

-
-Declared in <explicit-object-parameter.cpp>
-
-struct Optional;
-
-
-
-
-

Member Functions

- - - - - - - - - - - -
NameDescription
value
- - - -
-
- -
-

Synopses

-
-Declared in <explicit-object-parameter.cpp>
- -
-template<typename Self>
-constexpr
-auto&&
-value(this Self&& self);
-
-
-
» more... - - -
-template<typename Self>
-constexpr
-auto&&
-value(this 
-    Self&& self,
-    int x);
-
-
-
» more... - - -
-
-
- -
-

Synopsis

-
-Declared in <explicit-object-parameter.cpp>
-
-template<typename Self>
-constexpr
-auto&&
-value(this Self&& self);
-
-
-
-
-
-
- -
-

Synopsis

-
-Declared in <explicit-object-parameter.cpp>
-
-template<typename Self>
-constexpr
-auto&&
-value(this 
-    Self&& self,
-    int x);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/explicit-object-parameter.xml b/test-files/golden-tests/symbols/function/explicit-object-parameter.xml deleted file mode 100644 index ebcb0bfeb..000000000 --- a/test-files/golden-tests/symbols/function/explicit-object-parameter.xml +++ /dev/null @@ -1,50 +0,0 @@ - - - - - - - - - - diff --git a/test-files/golden-tests/symbols/function/function-parm-decay.adoc b/test-files/golden-tests/symbols/function/function-parm-decay.adoc deleted file mode 100644 index e367174b7..000000000 --- a/test-files/golden-tests/symbols/function/function-parm-decay.adoc +++ /dev/null @@ -1,104 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Types - -[cols=1] -|=== -| Name -| link:#T[`T`] -| link:#U[`U`] -|=== - -=== Functions - -[cols=1] -|=== -| Name -| link:#f[`f`] -| link:#g[`g`] -| link:#h[`h`] -| link:#i[`i`] -|=== - -[#T] -== T - -=== Synopsis - -Declared in `<function‐parm‐decay.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -using T = int; ----- - -[#U] -== U - -=== Synopsis - -Declared in `<function‐parm‐decay.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -using U = int const; ----- - -[#f] -== f - -=== Synopsis - -Declared in `<function‐parm‐decay.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -f(int const x); ----- - -[#g] -== g - -=== Synopsis - -Declared in `<function‐parm‐decay.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -g(int* x); ----- - -[#h] -== h - -=== Synopsis - -Declared in `<function‐parm‐decay.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -h(int x(bool)); ----- - -[#i] -== i - -=== Synopsis - -Declared in `<function‐parm‐decay.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -void -i(link:#T[T]); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/function/function-parm-decay.cpp b/test-files/golden-tests/symbols/function/function-parm-decay.cpp deleted file mode 100644 index 459901b39..000000000 --- a/test-files/golden-tests/symbols/function/function-parm-decay.cpp +++ /dev/null @@ -1,24 +0,0 @@ -#pragma clang diagnostic ignored "-Wdeprecated-volatile" - -void f(const int x); -void f(volatile int x); -void f(const volatile int x); -void f(int x); - -void g(int* x); -void g(int* const x); -void g(int x[]); -void g(int x[4]); - -void h(int x(bool)); -void h(int x(const bool)); -void h(int (*x)(bool)); -void h(int (*x)(const bool)); - -using T = int; -using U = const int; - -void i(T); -void i(U); -void i(const T); -void i(const U); diff --git a/test-files/golden-tests/symbols/function/function-parm-decay.html b/test-files/golden-tests/symbols/function/function-parm-decay.html deleted file mode 100644 index c7190bc31..000000000 --- a/test-files/golden-tests/symbols/function/function-parm-decay.html +++ /dev/null @@ -1,143 +0,0 @@ - - -Reference - - -
-

Reference

-
-
-

-
-

Types

- - - - - - - - - - - -
Name
T
U
- -

Functions

- - - - - - - - - - - - - -
Name
f
g
h
i
- -
-
-
-

T

-
-
-

Synopsis

-
-Declared in <function-parm-decay.cpp>
-
-using T = int;
-
-
-
-
-
-
-
-

U

-
-
-

Synopsis

-
-Declared in <function-parm-decay.cpp>
-
-using U = int const;
-
-
-
-
-
-
-
-

f

-
-
-

Synopsis

-
-Declared in <function-parm-decay.cpp>
-
-void
-f(int const x);
-
-
-
-
-
-
-
-

g

-
-
-

Synopsis

-
-Declared in <function-parm-decay.cpp>
-
-void
-g(int* x);
-
-
-
-
-
-
-
-

h

-
-
-

Synopsis

-
-Declared in <function-parm-decay.cpp>
-
-void
-h(int x(bool));
-
-
-
-
-
-
-
-

i

-
-
-

Synopsis

-
-Declared in <function-parm-decay.cpp>
-
-void
-i(T);
-
-
-
-
-
- -
-
-

Created with MrDocs

-
- - \ No newline at end of file diff --git a/test-files/golden-tests/symbols/function/function-parm-decay.xml b/test-files/golden-tests/symbols/function/function-parm-decay.xml deleted file mode 100644 index cf67b720f..000000000 --- a/test-files/golden-tests/symbols/function/function-parm-decay.xml +++ /dev/null @@ -1,55 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/test-files/golden-tests/symbols/function/function-template-template.adoc b/test-files/golden-tests/symbols/function/function-template-template.adoc deleted file mode 100644 index 9d18393ae..000000000 --- a/test-files/golden-tests/symbols/function/function-template-template.adoc +++ /dev/null @@ -1,31 +0,0 @@ -= Reference -:mrdocs: - -[#index] -== Global namespace - -=== Functions - -[cols=1] -|=== -| Name -| link:#f[`f`] -|=== - -[#f] -== f - -=== Synopsis - -Declared in `<function‐template‐template.cpp>` - -[source,cpp,subs="verbatim,replacements,macros,-callouts"] ----- -template<template<class...> typename ListType> -constexpr -void -f(ListType<int> param); ----- - - -[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/golden-tests/symbols/function/function-template-template.cpp b/test-files/golden-tests/symbols/function/function-template-template.cpp deleted file mode 100644 index 8411ea759..000000000 --- a/test-files/golden-tests/symbols/function/function-template-template.cpp +++ /dev/null @@ -1,4 +0,0 @@ -template