Skip to content

Commit ca3bbb6

Browse files
alandefreitasalandefreitas
committed
docs: antora includes self reference
1 parent 1cdff11 commit ca3bbb6

File tree

1,393 files changed

+22309
-3
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

1,393 files changed

+22309
-3
lines changed

Diff for: ‎CMakeLists.txt

+5-1
Original file line numberDiff line numberDiff line change
@@ -301,6 +301,10 @@ if (MRDOX_BUILD_DOCS)
301301
OUTPUT ${MRDOX_REFERENCE_OUTPUT_DIR}
302302
${REFERENCE_SOURCES})
303303
set(MRDOX_ANTORA_REFERENCE_DIR ${CMAKE_CURRENT_SOURCE_DIR}/docs/modules/ROOT/pages/reference)
304+
add_custom_target(generate_antora_reference
305+
COMMAND ${CMAKE_COMMAND} -E copy_directory ${MRDOX_REFERENCE_OUTPUT_DIR} ${MRDOX_ANTORA_REFERENCE_DIR}
306+
DEPENDS generate_reference
307+
COMMENT "Copy MrDox reference to Antora")
304308
endif()
305309

306310
#-------------------------------------------------
@@ -329,7 +333,7 @@ if (MRDOX_BUILD_DOCS)
329333
USES_TERMINAL
330334
)
331335
if (MRDOX_GENERATE_REFERENCE)
332-
add_dependencies(generate_docs generate_reference)
336+
add_dependencies(generate_docs generate_antora_reference)
333337
endif()
334338
else()
335339
message(WARNING "NPM or NPX not found. Unable to generate documentation.")

Diff for: ‎docs/modules/ROOT/pages/reference/00019F5471B9668638ADFDA031ED90ABE99D2D22.adoc

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[#00019F5471B9668638ADFDA031ED90ABE99D2D22]
2+
== displayName
3+
4+
Return the display name of the generator.
5+
6+
7+
8+
=== Synopsis
9+
10+
[source,cpp,subs=+macros]
11+
----
12+
xref:A3D7BA4F269E88A5D6613D73944B49C2BC1D672B[string_view]
13+
displayName() noexcept;
14+
----
15+
16+
Declared in file <mrdox/Generator.hpp> at line 55
17+

Diff for: ‎docs/modules/ROOT/pages/reference/000DE970ACC25E81283B198D89F0814DDCD324FC.adoc

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[#000DE970ACC25E81283B198D89F0814DDCD324FC]
2+
== getGenerators
3+
4+
Return a reference to the global Generators instance.
5+
6+
7+
8+
=== Synopsis
9+
10+
[source,cpp,subs=+macros]
11+
----
12+
const xref:B6C9D556A4C8E518CE51C5EDEAD8919438C83570[Generators]&
13+
getGenerators() noexcept;
14+
----
15+
16+
Declared in file <mrdox/Generators.hpp> at line 76
17+

Diff for: ‎docs/modules/ROOT/pages/reference/000F33B46E817602ECA667A1456230EFBCB61D9A.adoc

Whitespace-only changes.

Diff for: ‎docs/modules/ROOT/pages/reference/00345B2727B5ACDA1083422BA279747F09D4A1DD.adoc

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[#00345B2727B5ACDA1083422BA279747F09D4A1DD]
2+
== callImpl
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
xref:B96E05314FCFFCF3EE9E2B38B14453AFBA7F9C70[Expected]<xref:83ABF2657537BBFCBC4AABD902EE81582CF9239D[Value]>
11+
callImpl(
12+
const xref:84A0AA351AAB4E229A641157419A6FA400E2082D[Param]* data,
13+
xref:46BC85EE6CEC669FF49DB8FB4CCBD1B3290C5E78[size_t] size);
14+
----
15+
16+
Declared in file <mrdox/Support/JavaScript.hpp> at line 298
17+

Diff for: ‎docs/modules/ROOT/pages/reference/00346EBE6CF38FCF85BF7C8D6DFE57B152AA6F23.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[#00346EBE6CF38FCF85BF7C8D6DFE57B152AA6F23]
2+
== isNonType
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
bool
11+
isNonType() noexcept;
12+
----
13+
14+
Declared in file <mrdox/Metadata/Template.hpp> at line 167
15+

Diff for: ‎docs/modules/ROOT/pages/reference/0036CCBF93D09A133E9639ABB8036C0A8591C3E5.adoc

Whitespace-only changes.

Diff for: ‎docs/modules/ROOT/pages/reference/004438934B137BFC6A0E1EB5F1C4D90AE1567C38.adoc

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[#004438934B137BFC6A0E1EB5F1C4D90AE1567C38]
2+
== operator=
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
xref:C1029F5516FACDDA6690FADD330859010DF27072[Param]&
11+
operator=(
12+
const xref:C1029F5516FACDDA6690FADD330859010DF27072[Param]&) = delete;
13+
----
14+
15+
Declared in file <mrdox/Support/Lua.hpp> at line 212
16+

Diff for: ‎docs/modules/ROOT/pages/reference/00B9CD0CAA1D02FE711268DF8CD4C91FB3A10A88.adoc

+29
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
[#00B9CD0CAA1D02FE711268DF8CD4C91FB3A10A88]
2+
== output
3+
4+
Get the output stream used by the environment to render the template
5+
6+
7+
8+
=== Synopsis
9+
10+
[source,cpp,subs=+macros]
11+
----
12+
xref:E29BAC156AFB998B1C860C0E6947A921F76BFFE8[OutputRef]
13+
output();
14+
----
15+
16+
Declared in file <mrdox/Support/Handlebars.hpp> at line 607
17+
18+
=== Description
19+
20+
This function returns an output stream where a helper can directly write its output.
21+
22+
This is particularly useful for helpers that render long blocks,
23+
so that they can write directly to the output stream instead of
24+
building a string in dynamic memory before returning it.
25+
26+
27+
28+
29+

Diff for: ‎docs/modules/ROOT/pages/reference/00C8F0636EDC97D838D7824AE21669FC966A9EC6.adoc

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
[#00C8F0636EDC97D838D7824AE21669FC966A9EC6]
2+
== swap
3+
4+
Swap two objects.
5+
6+
7+
8+
=== Synopsis
9+
10+
[source,cpp,subs=+macros]
11+
----
12+
void
13+
swap(
14+
xref:D25AF7C3B942021830F47709DFDC0A6F8E861A39[Object]& other) noexcept;
15+
----
16+
17+
Declared in file <mrdox/Support/Dom.hpp> at line 683
18+

Diff for: ‎docs/modules/ROOT/pages/reference/00CB6EA1F0F2CA88A1816060CD4FB0A5FE8AA7FB.adoc

Whitespace-only changes.

Diff for: ‎docs/modules/ROOT/pages/reference/010862895CF33D4F09DD016ECAF0C4306329E9A1.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[#010862895CF33D4F09DD016ECAF0C4306329E9A1]
2+
== isArray
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
bool
11+
isArray() noexcept;
12+
----
13+
14+
Declared in file <mrdox/Support/JavaScript.hpp> at line 259
15+

Diff for: ‎docs/modules/ROOT/pages/reference/013A6046FCD4917B521653DB065D94D560581E84.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[#013A6046FCD4917B521653DB065D94D560581E84]
2+
== isBoolean
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
bool
11+
isBoolean() noexcept;
12+
----
13+
14+
Declared in file <mrdox/Support/Lua.hpp> at line 363
15+

Diff for: ‎docs/modules/ROOT/pages/reference/0175016F319217F485BCE6ECC62F095E905E54A7.adoc

Whitespace-only changes.

Diff for: ‎docs/modules/ROOT/pages/reference/01769695D17BBDB82B4775302ABF47051124BA77.adoc

Whitespace-only changes.

Diff for: ‎docs/modules/ROOT/pages/reference/01D0C942507B3FC1E25DAC5A47A17BDB0B262011.adoc

+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[#01D0C942507B3FC1E25DAC5A47A17BDB0B262011]
2+
== ~TaskGroup
3+
4+
Destructor.
5+
6+
7+
8+
=== Synopsis
9+
10+
[source,cpp,subs=+macros]
11+
----
12+
void
13+
~TaskGroup();
14+
----
15+
16+
Declared in file <mrdox/Support/ThreadPool.hpp> at line 126
17+

Diff for: ‎docs/modules/ROOT/pages/reference/0212FF4D33747416A08BB3C9C99350A60E518BEA.adoc

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
[#0212FF4D33747416A08BB3C9C99350A60E518BEA]
2+
== SpecializationInfo
3+
4+
Specialization info for members of implicit instantiations
5+
6+
7+
8+
=== Synopsis
9+
10+
[source,cpp,subs=+macros]
11+
----
12+
struct SpecializationInfo
13+
: xref:96352BB8C8BB6E5DD4863C504645558746FCA007[IsInfo]<InfoKind::Specialization>;
14+
----
15+
16+
Declared in file <mrdox/Metadata/Specialization.hpp> at line 49
17+
18+
=== Member Functions
19+
[,cols=2]
20+
|===
21+
|Name |Description
22+
|xref:42D0C9466FCE699EF7902D09A25B3DB5F540F591[`SpecializationInfo`] |
23+
|===
24+

Diff for: ‎docs/modules/ROOT/pages/reference/021E182B90C424C0C087AF55710F8F0C6568C73B.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[#021E182B90C424C0C087AF55710F8F0C6568C73B]
2+
== ~Scope
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
void
11+
~Scope();
12+
----
13+
14+
Declared in file <mrdox/Support/JavaScript.hpp> at line 120
15+

Diff for: ‎docs/modules/ROOT/pages/reference/02355A5010E8C60B66C35ACCBAB1253A59468A71.adoc

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[#02355A5010E8C60B66C35ACCBAB1253A59468A71]
2+
== isRValueReference
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
static
11+
bool
12+
isRValueReference() noexcept;
13+
----
14+
15+
Declared in file <mrdox/Metadata/Type.hpp> at line 88
16+

Diff for: ‎docs/modules/ROOT/pages/reference/027263DA6967CC200AEBB758FB6A15C31E74D437.adoc

+23
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
[#027263DA6967CC200AEBB758FB6A15C31E74D437]
2+
== TemplateInfo
3+
4+
Information pertaining to templates and specializations thereof.
5+
6+
7+
8+
=== Synopsis
9+
10+
[source,cpp,subs=+macros]
11+
----
12+
struct TemplateInfo;
13+
----
14+
15+
Declared in file <mrdox/Metadata/Template.hpp> at line 272
16+
17+
=== Member Functions
18+
[,cols=2]
19+
|===
20+
|Name |Description
21+
|xref:6092E571D1DBDCDC0BFE191B80C5388855076E9F[`specializationKind`] |
22+
|===
23+

Diff for: ‎docs/modules/ROOT/pages/reference/029E0B105FCC8CBA4B91B972BACBAA8DAF40059C.adoc

Whitespace-only changes.

Diff for: ‎docs/modules/ROOT/pages/reference/02D80C200AC933F1BE65A4468D00FD860279B55B.adoc

Whitespace-only changes.

Diff for: ‎docs/modules/ROOT/pages/reference/02DC86D1855DA60EFD95AEDF4E84E259EB3D9831.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[#02DC86D1855DA60EFD95AEDF4E84E259EB3D9831]
2+
== Impl
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
class Impl;
11+
----
12+
13+
Declared in file <mrdox/Metadata/DomMetadata.hpp> at line 33
14+
15+

Diff for: ‎docs/modules/ROOT/pages/reference/03AAC09EB70B4885A0B815C73F95F8188576288E.adoc

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[#03AAC09EB70B4885A0B815C73F95F8188576288E]
2+
== operator==
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
bool
11+
operator==(
12+
const xref:F7DD0AA6B38F98959BF3A7A3952F023901CDD9FB[Param]&) noexcept;
13+
----
14+
15+
Declared in file <mrdox/Metadata/Javadoc.hpp> at line 427
16+

Diff for: ‎docs/modules/ROOT/pages/reference/045CFEEB7DA636BAEA8A15DFF5086CBC9C33B393.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[#045CFEEB7DA636BAEA8A15DFF5086CBC9C33B393]
2+
== Brief
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
void
11+
Brief() noexcept;
12+
----
13+
14+
Declared in file <mrdox/Metadata/Javadoc.hpp> at line 328
15+

Diff for: ‎docs/modules/ROOT/pages/reference/04C47F42A62B5EF9555620977A8246489BCD1695.adoc

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
[#04C47F42A62B5EF9555620977A8246489BCD1695]
2+
== append_to_output
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
template<
11+
class St>
12+
static
13+
void
14+
append_to_output(
15+
void* out,
16+
xref:A3D7BA4F269E88A5D6613D73944B49C2BC1D672B[string_view] sv);
17+
----
18+
19+
Declared in file <mrdox/Support/Handlebars.hpp> at line 123
20+

Diff for: ‎docs/modules/ROOT/pages/reference/04FA2C3B0827F9990484F5C40B4103411D07E91F.adoc

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
[#04FA2C3B0827F9990484F5C40B4103411D07E91F]
2+
== isTag
3+
4+
5+
6+
=== Synopsis
7+
8+
[source,cpp,subs=+macros]
9+
----
10+
bool
11+
isTag() noexcept;
12+
----
13+
14+
Declared in file <mrdox/Metadata/Type.hpp> at line 60
15+

Diff for: ‎docs/modules/ROOT/pages/reference/0502493EBD8CB475D6C9193345C4BD6D5C7937E4.adoc

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
[#0502493EBD8CB475D6C9193345C4BD6D5C7937E4]
2+
== iterator
3+
4+
Object::iterator
5+
6+
7+
8+
=== Synopsis
9+
10+
[source,cpp,subs=+macros]
11+
----
12+
using iterator = xref:D25AF7C3B942021830F47709DFDC0A6F8E861A39[Object]::xref:1D3AF6E4FC8B6379F937EF118861A1A32524F8C7[iterator];
13+
----
14+
15+
Declared in file <mrdox/Support/Dom.hpp> at line 731
16+

0 commit comments

Comments
 (0)