From 6ece1433c3c1cbf80564c5ae44d7e1b5634be5c5 Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Tue, 21 Jan 2025 20:58:41 -0300 Subject: [PATCH 1/5] unify test files #refactor --- test-files/adoc/compile_commands.json | 7 - test-files/adoc/mrdocs.yml | 13 -- test-files/adoc/test.cpp | 27 --- test-files/adoc/test.xml | 45 ---- test-files/golden-tests/javadoc/brief-4.adoc | 82 +++++++ .../javadoc/brief-4.cpp} | 0 test-files/golden-tests/javadoc/brief-4.html | 98 ++++++++ .../javadoc/brief-4.xml} | 10 +- test-files/golden-tests/javadoc/brief-5.adoc | 134 +++++++++++ .../javadoc/brief-5.cpp} | 0 test-files/golden-tests/javadoc/brief-5.html | 162 +++++++++++++ .../javadoc/brief-5.xml} | 14 +- test-files/golden-tests/javadoc/brief-6.adoc | 45 ++++ .../javadoc/brief-6.cpp} | 0 test-files/golden-tests/javadoc/brief-6.html | 60 +++++ .../javadoc/brief-6.xml} | 4 +- test-files/golden-tests/javadoc/copydoc.adoc | 92 ++++++++ .../{ => golden-tests}/javadoc/copydoc.cpp | 0 test-files/golden-tests/javadoc/copydoc.html | 114 ++++++++++ .../{ => golden-tests}/javadoc/copydoc.xml | 16 +- test-files/golden-tests/javadoc/listitem.adoc | 126 +++++++++++ .../{ => golden-tests}/javadoc/listitem.cpp | 0 test-files/golden-tests/javadoc/listitem.html | 150 +++++++++++++ test-files/golden-tests/javadoc/listitem.xml | 64 ++++++ test-files/golden-tests/javadoc/param-1.adoc | 170 ++++++++++++++ .../{ => golden-tests}/javadoc/param-1.cpp | 0 test-files/golden-tests/javadoc/param-1.html | 212 ++++++++++++++++++ .../{ => golden-tests}/javadoc/param-1.xml | 12 +- test-files/golden-tests/javadoc/tparam-1.adoc | 91 ++++++++ .../{ => golden-tests}/javadoc/tparam-1.cpp | 0 test-files/golden-tests/javadoc/tparam-1.html | 120 ++++++++++ .../{ => golden-tests}/javadoc/tparam-1.xml | 8 +- test-files/javadoc/listitem.xml | 56 ----- test-files/javadoc/mrdocs.yml | 4 - 34 files changed, 1755 insertions(+), 181 deletions(-) delete mode 100644 test-files/adoc/compile_commands.json delete mode 100644 test-files/adoc/mrdocs.yml delete mode 100644 test-files/adoc/test.cpp delete mode 100644 test-files/adoc/test.xml create mode 100644 test-files/golden-tests/javadoc/brief-4.adoc rename test-files/{javadoc/brief-1.cpp => golden-tests/javadoc/brief-4.cpp} (100%) create mode 100644 test-files/golden-tests/javadoc/brief-4.html rename test-files/{javadoc/brief-1.xml => golden-tests/javadoc/brief-4.xml} (60%) create mode 100644 test-files/golden-tests/javadoc/brief-5.adoc rename test-files/{javadoc/brief-2.cpp => golden-tests/javadoc/brief-5.cpp} (100%) create mode 100644 test-files/golden-tests/javadoc/brief-5.html rename test-files/{javadoc/brief-2.xml => golden-tests/javadoc/brief-5.xml} (68%) create mode 100644 test-files/golden-tests/javadoc/brief-6.adoc rename test-files/{javadoc/brief-3.cpp => golden-tests/javadoc/brief-6.cpp} (100%) create mode 100644 test-files/golden-tests/javadoc/brief-6.html rename test-files/{javadoc/brief-3.xml => golden-tests/javadoc/brief-6.xml} (78%) create mode 100644 test-files/golden-tests/javadoc/copydoc.adoc rename test-files/{ => golden-tests}/javadoc/copydoc.cpp (100%) create mode 100644 test-files/golden-tests/javadoc/copydoc.html rename test-files/{ => golden-tests}/javadoc/copydoc.xml (54%) create mode 100644 test-files/golden-tests/javadoc/listitem.adoc rename test-files/{ => golden-tests}/javadoc/listitem.cpp (100%) create mode 100644 test-files/golden-tests/javadoc/listitem.html create mode 100644 test-files/golden-tests/javadoc/listitem.xml create mode 100644 test-files/golden-tests/javadoc/param-1.adoc rename test-files/{ => golden-tests}/javadoc/param-1.cpp (100%) create mode 100644 test-files/golden-tests/javadoc/param-1.html rename test-files/{ => golden-tests}/javadoc/param-1.xml (78%) create mode 100644 test-files/golden-tests/javadoc/tparam-1.adoc rename test-files/{ => golden-tests}/javadoc/tparam-1.cpp (100%) create mode 100644 test-files/golden-tests/javadoc/tparam-1.html rename test-files/{ => golden-tests}/javadoc/tparam-1.xml (75%) delete mode 100644 test-files/javadoc/listitem.xml delete mode 100644 test-files/javadoc/mrdocs.yml diff --git a/test-files/adoc/compile_commands.json b/test-files/adoc/compile_commands.json deleted file mode 100644 index a7b785ffc..000000000 --- a/test-files/adoc/compile_commands.json +++ /dev/null @@ -1,7 +0,0 @@ -[ - { - "directory": ".", - "command": "clang test.cpp", - "file": "test.cpp" - } -] diff --git a/test-files/adoc/mrdocs.yml b/test-files/adoc/mrdocs.yml deleted file mode 100644 index 1bd325dbf..000000000 --- a/test-files/adoc/mrdocs.yml +++ /dev/null @@ -1,13 +0,0 @@ -#ignore-failures: true -extract: - inaccessible-members: never -concurrency: 1 -source-root: . -single-page: true -input: - include: - #- test.cpp -defines: - #- BOOST_URL_DOCS -generator: - adoc: diff --git a/test-files/adoc/test.cpp b/test-files/adoc/test.cpp deleted file mode 100644 index 7c614f495..000000000 --- a/test-files/adoc/test.cpp +++ /dev/null @@ -1,27 +0,0 @@ -/** The type of string_view used by the library - - String views are used to pass character - buffers into or out of functions. Ownership - of the underlying character buffer is not - transferred; the caller is responsible for - ensuring that the lifetime of character - buffer extends until it is no longer - referenced. - - @note This alias is no longer supported and - should not be used in new code. Please use - `core::string_view` instead. - - This alias is included for backwards - compatibility with earlier versions of the - library. - - However, it will be removed in future releases, - and using it in new code is not recommended. - - Please use the updated version instead to - ensure compatibility with future versions of - the library. - -*/ -struct string_view{}; diff --git a/test-files/adoc/test.xml b/test-files/adoc/test.xml deleted file mode 100644 index 29456a520..000000000 --- a/test-files/adoc/test.xml +++ /dev/null @@ -1,45 +0,0 @@ - - - - - - - - The type of string_view used by the library - - - String views are used to pass character - buffers into or out of functions. Ownership - of the underlying character buffer is not - transferred; the caller is responsible for - ensuring that the lifetime of character - buffer extends until it is no longer - referenced. - - - - - - This alias is no longer supported and - should not be used in new code. Please use - `core::string_view` instead. - - - This alias is included for backwards - compatibility with earlier versions of the - library. - - - However, it will be removed in future releases, - and using it in new code is not recommended. - - - Please use the updated version instead to - ensure compatibility with future versions of - the library. - - - - - diff --git a/test-files/golden-tests/javadoc/brief-4.adoc b/test-files/golden-tests/javadoc/brief-4.adoc new file mode 100644 index 000000000..48c79c0d8 --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-4.adoc @@ -0,0 +1,82 @@ += Reference +:mrdocs: + +[#index] +== Global namespace + + +=== Functions + +[cols=1] +|=== +| Name + +| <> +| <> +| <> +| <> +|=== + +[#f0] +== f0 + + +=== Synopsis + + +Declared in `<brief‐4.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f0(); +---- + +[#f1] +== f1 + + +=== Synopsis + + +Declared in `<brief‐4.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f1(); +---- + +[#f2] +== f2 + + +=== Synopsis + + +Declared in `<brief‐4.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f2(); +---- + +[#f3] +== f3 + + +=== Synopsis + + +Declared in `<brief‐4.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f3(); +---- + + + +[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/javadoc/brief-1.cpp b/test-files/golden-tests/javadoc/brief-4.cpp similarity index 100% rename from test-files/javadoc/brief-1.cpp rename to test-files/golden-tests/javadoc/brief-4.cpp diff --git a/test-files/golden-tests/javadoc/brief-4.html b/test-files/golden-tests/javadoc/brief-4.html new file mode 100644 index 000000000..165d1bee9 --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-4.html @@ -0,0 +1,98 @@ + + +Reference + + +
+

Reference

+
+
+

Global namespace

+
+

Functions

+ + + + + + + + + + + + + +
Name
f0
f1
f2
f3
+
+
+
+

f0

+
+
+

Synopsis

+
+Declared in <brief-4.cpp>
+
+
+void
+f0();
+
+
+
+
+
+
+

f1

+
+
+

Synopsis

+
+Declared in <brief-4.cpp>
+
+
+void
+f1();
+
+
+
+
+
+
+

f2

+
+
+

Synopsis

+
+Declared in <brief-4.cpp>
+
+
+void
+f2();
+
+
+
+
+
+
+

f3

+
+
+

Synopsis

+
+Declared in <brief-4.cpp>
+
+
+void
+f3();
+
+
+
+
+ +
+
+

Created with MrDocs

+
+ + \ No newline at end of file diff --git a/test-files/javadoc/brief-1.xml b/test-files/golden-tests/javadoc/brief-4.xml similarity index 60% rename from test-files/javadoc/brief-1.xml rename to test-files/golden-tests/javadoc/brief-4.xml index c37d45bb6..4c0057769 100644 --- a/test-files/javadoc/brief-1.xml +++ b/test-files/golden-tests/javadoc/brief-4.xml @@ -1,18 +1,18 @@ - + - + - + - + - + diff --git a/test-files/golden-tests/javadoc/brief-5.adoc b/test-files/golden-tests/javadoc/brief-5.adoc new file mode 100644 index 000000000..afc36fa37 --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-5.adoc @@ -0,0 +1,134 @@ += Reference +:mrdocs: + +[#index] +== Global namespace + + +=== Functions + +[cols=2] +|=== +| Name | Description + +| <> +| brief + +| <> +| + +| <> +| + +| <> +| brief + +| <> +| brief + +| <> +| brief + +|=== + +[#f0] +== f0 + + +brief + +=== Synopsis + + +Declared in `<brief‐5.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f0(); +---- + +[#f1] +== f1 + + +=== Synopsis + + +Declared in `<brief‐5.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f1(); +---- + +[#f2] +== f2 + + +=== Synopsis + + +Declared in `<brief‐5.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f2(); +---- + +[#f3] +== f3 + + +brief + +=== Synopsis + + +Declared in `<brief‐5.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f3(); +---- + +[#f4] +== f4 + + +brief + +=== Synopsis + + +Declared in `<brief‐5.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f4(); +---- + +[#f5] +== f5 + + +brief + +=== Synopsis + + +Declared in `<brief‐5.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f5(); +---- + + + +[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/javadoc/brief-2.cpp b/test-files/golden-tests/javadoc/brief-5.cpp similarity index 100% rename from test-files/javadoc/brief-2.cpp rename to test-files/golden-tests/javadoc/brief-5.cpp diff --git a/test-files/golden-tests/javadoc/brief-5.html b/test-files/golden-tests/javadoc/brief-5.html new file mode 100644 index 000000000..5c92ec043 --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-5.html @@ -0,0 +1,162 @@ + + +Reference + + +
+

Reference

+
+
+

Global namespace

+
+

Functions

+ + + + + + + + + + + + + + + +
NameDescription
f0 brief + +
f1 +
f2 +
f3 brief + +
f4 brief + +
f5 brief + +
+
+
+
+

f0

+
+brief + + +
+
+
+

Synopsis

+
+Declared in <brief-5.cpp>
+
+
+void
+f0();
+
+
+
+
+
+
+

f1

+
+
+

Synopsis

+
+Declared in <brief-5.cpp>
+
+
+void
+f1();
+
+
+
+
+
+
+

f2

+
+
+

Synopsis

+
+Declared in <brief-5.cpp>
+
+
+void
+f2();
+
+
+
+
+
+
+

f3

+
+brief + + +
+
+
+

Synopsis

+
+Declared in <brief-5.cpp>
+
+
+void
+f3();
+
+
+
+
+
+
+

f4

+
+brief + + +
+
+
+

Synopsis

+
+Declared in <brief-5.cpp>
+
+
+void
+f4();
+
+
+
+
+
+
+

f5

+
+brief + + +
+
+
+

Synopsis

+
+Declared in <brief-5.cpp>
+
+
+void
+f5();
+
+
+
+
+ +
+
+

Created with MrDocs

+
+ + \ No newline at end of file diff --git a/test-files/javadoc/brief-2.xml b/test-files/golden-tests/javadoc/brief-5.xml similarity index 68% rename from test-files/javadoc/brief-2.xml rename to test-files/golden-tests/javadoc/brief-5.xml index 3a9b2c13c..cb5a31453 100644 --- a/test-files/javadoc/brief-2.xml +++ b/test-files/golden-tests/javadoc/brief-5.xml @@ -1,9 +1,9 @@ - + - + brief @@ -11,21 +11,21 @@ - + - + - + brief @@ -33,7 +33,7 @@ - + brief @@ -41,7 +41,7 @@ - + brief diff --git a/test-files/golden-tests/javadoc/brief-6.adoc b/test-files/golden-tests/javadoc/brief-6.adoc new file mode 100644 index 000000000..e3680abb7 --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-6.adoc @@ -0,0 +1,45 @@ += Reference +:mrdocs: + +[#index] +== Global namespace + + +=== Functions + +[cols=2] +|=== +| Name | Description + +| <> +| brief + +|=== + +[#f0] +== f0 + + +brief + +=== Synopsis + + +Declared in `<brief‐6.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f0(); +---- + +=== Description + + +desc + + + + + +[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/javadoc/brief-3.cpp b/test-files/golden-tests/javadoc/brief-6.cpp similarity index 100% rename from test-files/javadoc/brief-3.cpp rename to test-files/golden-tests/javadoc/brief-6.cpp diff --git a/test-files/golden-tests/javadoc/brief-6.html b/test-files/golden-tests/javadoc/brief-6.html new file mode 100644 index 000000000..5676651ac --- /dev/null +++ b/test-files/golden-tests/javadoc/brief-6.html @@ -0,0 +1,60 @@ + + +Reference + + +
+

Reference

+
+
+

Global namespace

+
+

Functions

+ + + + + + + + + + +
NameDescription
f0 brief + +
+
+
+
+

f0

+
+brief + + +
+
+
+

Synopsis

+
+Declared in <brief-6.cpp>
+
+
+void
+f0();
+
+
+
+
+

Description

+

desc

+ + +
+
+ +
+
+

Created with MrDocs

+
+ + \ No newline at end of file diff --git a/test-files/javadoc/brief-3.xml b/test-files/golden-tests/javadoc/brief-6.xml similarity index 78% rename from test-files/javadoc/brief-3.xml rename to test-files/golden-tests/javadoc/brief-6.xml index c4ea330bc..f9b13d634 100644 --- a/test-files/javadoc/brief-3.xml +++ b/test-files/golden-tests/javadoc/brief-6.xml @@ -1,9 +1,9 @@ - + - + desc diff --git a/test-files/golden-tests/javadoc/copydoc.adoc b/test-files/golden-tests/javadoc/copydoc.adoc new file mode 100644 index 000000000..b6694d478 --- /dev/null +++ b/test-files/golden-tests/javadoc/copydoc.adoc @@ -0,0 +1,92 @@ += Reference +:mrdocs: + +[#index] +== Global namespace + + +=== Functions + +[cols=2] +|=== +| Name | Description + +| <> +| brief1 + +| <> +| brief1 + +| <> +| brief1 + +|=== + +[#f1] +== f1 + + +brief1 + +=== Synopsis + + +Declared in `<copydoc.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f1(); +---- + +[#f2] +== f2 + + +brief1 + +=== Synopsis + + +Declared in `<copydoc.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f2(); +---- + +=== Description + + +xref:#f1[f1] + + + +[#f3] +== f3 + + +brief1 + +=== Synopsis + + +Declared in `<copydoc.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f3(); +---- + +=== Description + + +xref:#f1[f1] f2 + + + + + +[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/javadoc/copydoc.cpp b/test-files/golden-tests/javadoc/copydoc.cpp similarity index 100% rename from test-files/javadoc/copydoc.cpp rename to test-files/golden-tests/javadoc/copydoc.cpp diff --git a/test-files/golden-tests/javadoc/copydoc.html b/test-files/golden-tests/javadoc/copydoc.html new file mode 100644 index 000000000..1278ae7ab --- /dev/null +++ b/test-files/golden-tests/javadoc/copydoc.html @@ -0,0 +1,114 @@ + + +Reference + + +
+

Reference

+
+
+

Global namespace

+
+

Functions

+ + + + + + + + + + + + +
NameDescription
f1 brief1 + +
f2 brief1 + +
f3 brief1 + +
+
+
+
+

f1

+
+brief1 + + +
+
+
+

Synopsis

+
+Declared in <copydoc.cpp>
+
+
+void
+f1();
+
+
+
+
+
+
+

f2

+
+brief1 + + +
+
+
+

Synopsis

+
+Declared in <copydoc.cpp>
+
+
+void
+f2();
+
+
+
+
+

Description

+

f1

+ + +
+
+
+
+

f3

+
+brief1 + + +
+
+
+

Synopsis

+
+Declared in <copydoc.cpp>
+
+
+void
+f3();
+
+
+
+
+

Description

+

f1 f2

+ + +
+
+ +
+
+

Created with MrDocs

+
+ + \ No newline at end of file diff --git a/test-files/javadoc/copydoc.xml b/test-files/golden-tests/javadoc/copydoc.xml similarity index 54% rename from test-files/javadoc/copydoc.xml rename to test-files/golden-tests/javadoc/copydoc.xml index 27b364d45..460f77ca9 100644 --- a/test-files/javadoc/copydoc.xml +++ b/test-files/golden-tests/javadoc/copydoc.xml @@ -1,9 +1,9 @@ - + - + brief1 @@ -11,13 +11,19 @@ - + + + + f1 + + - + - f2 + f1 + f2 diff --git a/test-files/golden-tests/javadoc/listitem.adoc b/test-files/golden-tests/javadoc/listitem.adoc new file mode 100644 index 000000000..9d332c408 --- /dev/null +++ b/test-files/golden-tests/javadoc/listitem.adoc @@ -0,0 +1,126 @@ += Reference +:mrdocs: + +[#index] +== Global namespace + + +=== Functions + +[cols=2] +|=== +| Name | Description + +| <> +| + +| <> +| + +| <> +| brief + +| <> +| brief + +|=== + +[#f0] +== f0 + + +=== Synopsis + + +Declared in `<listitem.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f0(); +---- + +=== Description + + +* item + + + +[#f1] +== f1 + + +=== Synopsis + + +Declared in `<listitem.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f1(); +---- + +=== Description + + +* item 1 +* item 2 + + + +[#f2] +== f2 + + +brief + +=== Synopsis + + +Declared in `<listitem.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f2(); +---- + +=== Description + + +* item 1 +* item 2 + + + +[#f3] +== f3 + + +brief + +=== Synopsis + + +Declared in `<listitem.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f3(); +---- + +=== Description + + +* item 1 +* item 2 +* item 3 + + + + + +[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/javadoc/listitem.cpp b/test-files/golden-tests/javadoc/listitem.cpp similarity index 100% rename from test-files/javadoc/listitem.cpp rename to test-files/golden-tests/javadoc/listitem.cpp diff --git a/test-files/golden-tests/javadoc/listitem.html b/test-files/golden-tests/javadoc/listitem.html new file mode 100644 index 000000000..5286571e0 --- /dev/null +++ b/test-files/golden-tests/javadoc/listitem.html @@ -0,0 +1,150 @@ + + +Reference + + +
+

Reference

+
+
+

Global namespace

+
+

Functions

+ + + + + + + + + + + + + +
NameDescription
f0 +
f1 +
f2 brief + +
f3 brief + +
+
+
+
+

f0

+
+
+

Synopsis

+
+Declared in <listitem.cpp>
+
+
+void
+f0();
+
+
+
+
+

Description

+
    +
  • item
    • +
+ + +
+
+
+
+

f1

+
+
+

Synopsis

+
+Declared in <listitem.cpp>
+
+
+void
+f1();
+
+
+
+
+

Description

+
    +
  • item 1
    • +
  • item 2
    • +
+ + +
+
+
+
+

f2

+
+brief + + +
+
+
+

Synopsis

+
+Declared in <listitem.cpp>
+
+
+void
+f2();
+
+
+
+
+

Description

+
    +
  • item 1
    • +
  • item 2
    • +
+ + +
+
+
+
+

f3

+
+brief + + +
+
+
+

Synopsis

+
+Declared in <listitem.cpp>
+
+
+void
+f3();
+
+
+
+
+

Description

+
    +
  • item 1
    • +
  • item 2
    • +
  • item 3
    • +
+ + +
+
+ +
+
+

Created with MrDocs

+
+ + \ No newline at end of file diff --git a/test-files/golden-tests/javadoc/listitem.xml b/test-files/golden-tests/javadoc/listitem.xml new file mode 100644 index 000000000..6859aa490 --- /dev/null +++ b/test-files/golden-tests/javadoc/listitem.xml @@ -0,0 +1,64 @@ + + + + + + + + + item + + + + + + + + + + item 1 + + + item 2 + + + + + + + + + brief + + + + item 1 + + + item 2 + + + + + + + + + brief + + + + item 1 + + + item 2 + + + item 3 + + + + + + diff --git a/test-files/golden-tests/javadoc/param-1.adoc b/test-files/golden-tests/javadoc/param-1.adoc new file mode 100644 index 000000000..9f3b82a4e --- /dev/null +++ b/test-files/golden-tests/javadoc/param-1.adoc @@ -0,0 +1,170 @@ += Reference +:mrdocs: + +[#index] +== Global namespace + + +=== Functions + +[cols=2] +|=== +| Name | Description + +| <> +| + +| <> +| + +| <> +| + +| <> +| + +| <> +| + +|=== + +[#f0] +== f0 + + +=== Synopsis + + +Declared in `<param‐1.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f0(int i); +---- + +=== Parameters + + +|=== +| Name | Description + +| *i* +| int + + +|=== + +[#f1] +== f1 + + +=== Synopsis + + +Declared in `<param‐1.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f1(int i); +---- + +=== Parameters + + +|=== +| Name | Description + +| *i* [in] +| int + + +|=== + +[#f2] +== f2 + + +=== Synopsis + + +Declared in `<param‐1.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f2(int& i); +---- + +=== Parameters + + +|=== +| Name | Description + +| *i* [out] +| int + + +|=== + +[#f3] +== f3 + + +=== Synopsis + + +Declared in `<param‐1.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f3(int& i); +---- + +=== Parameters + + +|=== +| Name | Description + +| *i* [inout] +| int + + +|=== + +[#f4] +== f4 + + +=== Synopsis + + +Declared in `<param‐1.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +void +f4( + int i, + double j); +---- + +=== Parameters + + +|=== +| Name | Description + +| *i,j* +| numbers + + +|=== + + + +[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/javadoc/param-1.cpp b/test-files/golden-tests/javadoc/param-1.cpp similarity index 100% rename from test-files/javadoc/param-1.cpp rename to test-files/golden-tests/javadoc/param-1.cpp diff --git a/test-files/golden-tests/javadoc/param-1.html b/test-files/golden-tests/javadoc/param-1.html new file mode 100644 index 000000000..cd69602d2 --- /dev/null +++ b/test-files/golden-tests/javadoc/param-1.html @@ -0,0 +1,212 @@ + + +Reference + + +
+

Reference

+
+
+

Global namespace

+
+

Functions

+ + + + + + + + + + + + + + +
NameDescription
f0 +
f1 +
f2 +
f3 +
f4 +
+
+
+
+

f0

+
+
+

Synopsis

+
+Declared in <param-1.cpp>
+
+
+void
+f0(int i);
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + +
NameDescription
i

int

+
+
+
+
+
+

f1

+
+
+

Synopsis

+
+Declared in <param-1.cpp>
+
+
+void
+f1(int i);
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + +
NameDescription
i [in]

int

+
+
+
+
+
+

f2

+
+
+

Synopsis

+
+Declared in <param-1.cpp>
+
+
+void
+f2(int& i);
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + +
NameDescription
i [out]

int

+
+
+
+
+
+

f3

+
+
+

Synopsis

+
+Declared in <param-1.cpp>
+
+
+void
+f3(int& i);
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + +
NameDescription
i [inout]

int

+
+
+
+
+
+

f4

+
+
+

Synopsis

+
+Declared in <param-1.cpp>
+
+
+void
+f4(
+    int i,
+    double j);
+
+
+
+
+

Parameters

+ + + + + + + + + + + + + +
NameDescription
i,j

numbers

+
+
+
+ +
+
+

Created with MrDocs

+
+ + \ No newline at end of file diff --git a/test-files/javadoc/param-1.xml b/test-files/golden-tests/javadoc/param-1.xml similarity index 78% rename from test-files/javadoc/param-1.xml rename to test-files/golden-tests/javadoc/param-1.xml index afe386412..aa73ab91e 100644 --- a/test-files/javadoc/param-1.xml +++ b/test-files/golden-tests/javadoc/param-1.xml @@ -1,9 +1,9 @@ - + - + @@ -14,7 +14,7 @@ - + @@ -25,7 +25,7 @@ - + @@ -38,7 +38,7 @@ - + @@ -51,7 +51,7 @@ - + diff --git a/test-files/golden-tests/javadoc/tparam-1.adoc b/test-files/golden-tests/javadoc/tparam-1.adoc new file mode 100644 index 000000000..fecc4ba7a --- /dev/null +++ b/test-files/golden-tests/javadoc/tparam-1.adoc @@ -0,0 +1,91 @@ += Reference +:mrdocs: + +[#index] +== Global namespace + + +=== Functions + +[cols=2] +|=== +| Name | Description + +| <> +| + +| <> +| brief + +|=== + +[#f0] +== f0 + + +=== Synopsis + + +Declared in `<tparam‐1.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +template<class T> +void +f0(); +---- + +=== Template Parameters + + +|=== +| Name | Description + +| *T* +| +|=== + +[#f1] +== f1 + + +brief + +=== Synopsis + + +Declared in `<tparam‐1.cpp>` + +[source,cpp,subs="verbatim,replacements,macros,-callouts"] +---- +template<class T> +void +f1(); +---- + +=== Description + + +desc + + + +=== Template Parameters + + +|=== +| Name | Description + +| *T* +| type + + +| *T* +| type + + +|=== + + + +[.small]#Created with https://www.mrdocs.com[MrDocs]# diff --git a/test-files/javadoc/tparam-1.cpp b/test-files/golden-tests/javadoc/tparam-1.cpp similarity index 100% rename from test-files/javadoc/tparam-1.cpp rename to test-files/golden-tests/javadoc/tparam-1.cpp diff --git a/test-files/golden-tests/javadoc/tparam-1.html b/test-files/golden-tests/javadoc/tparam-1.html new file mode 100644 index 000000000..b3ca4db30 --- /dev/null +++ b/test-files/golden-tests/javadoc/tparam-1.html @@ -0,0 +1,120 @@ + + +Reference + + +
+

Reference

+
+
+

Global namespace

+
+

Functions

+ + + + + + + + + + + +
NameDescription
f0 +
f1 brief + +
+
+
+
+

f0

+
+
+

Synopsis

+
+Declared in <tparam-1.cpp>
+
+
+template<class T>
+void
+f0();
+
+
+
+
+

Template Parameters

+ + + + + + + + + + + + + +
NameDescription
T
+
+
+
+
+

f1

+
+brief + + +
+
+
+

Synopsis

+
+Declared in <tparam-1.cpp>
+
+
+template<class T>
+void
+f1();
+
+
+
+
+

Description

+

desc

+ + +
+
+

Template Parameters

+ + + + + + + + + + + + + + + + + +
NameDescription
T

type

+
T

type

+
+
+
+ +
+
+

Created with MrDocs

+
+ + \ No newline at end of file diff --git a/test-files/javadoc/tparam-1.xml b/test-files/golden-tests/javadoc/tparam-1.xml similarity index 75% rename from test-files/javadoc/tparam-1.xml rename to test-files/golden-tests/javadoc/tparam-1.xml index 1b8aec9bd..44099e459 100644 --- a/test-files/javadoc/tparam-1.xml +++ b/test-files/golden-tests/javadoc/tparam-1.xml @@ -1,11 +1,11 @@ - +