Skip to content

Commit 397f779

Browse files
vinniefalcoalandefreitas
vinniefalco
authored and
alandefreitas
committed
adoc: tables for symbols have headers
1 parent 86ce271 commit 397f779

File tree

240 files changed

+2154
-2591
lines changed

Some content is hidden

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

240 files changed

+2154
-2591
lines changed

‎CMakeUserPresets.json.example‎

Lines changed: 62 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
"binaryDir": "${sourceDir}/build/${presetName}",
4747
"cacheVariables": {
4848
"CMAKE_CXX_COMPILER": "/usr/bin/g++",
49-
"CMAKE_C_COMPILER": "/usr/bin/gcc",
49+
"CMAKE_C_COMPILER": "/opt/homebrew/bin/gcc-15",
5050
"LLVM_ROOT": "${sourceDir}/build/third-party/llvm",
5151
"Clang_ROOT": "${sourceDir}/build/third-party/llvm",
5252
"CMAKE_EXPORT_COMPILE_COMMANDS": "ON",
@@ -129,12 +129,13 @@
129129
"Duktape_ROOT": "${sourceDir}/build/third-party/duktape/install/debug",
130130
"libxml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release",
131131
"LibXml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release",
132-
"MRDOCS_BUILD_TESTS": true,
132+
"LUA_ROOT": "${sourceDir}/build/third-party/lua/install/debug",
133+
"Lua_ROOT": "${sourceDir}/build/third-party/lua/install/debug",
134+
"lua_ROOT": "${sourceDir}/build/third-party/lua/install/debug",
133135
"MRDOCS_BUILD_DOCS": false,
134136
"MRDOCS_GENERATE_REFERENCE": false,
135137
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
136-
"CMAKE_MAKE_PROGRAM": "${sourceDir}/build/third-party/ninja/ninja",
137-
"CMAKE_CXX_FLAGS": "-D_LIBCPP_HARDENING_MODE=_LIBCPP_HARDENING_MODE_EXTENSIVE"
138+
"CMAKE_MAKE_PROGRAM": "${sourceDir}/build/third-party/ninja/ninja"
138139
},
139140
"condition": {
140141
"type": "equals",
@@ -160,7 +161,9 @@
160161
"Duktape_ROOT": "${sourceDir}/build/third-party/duktape/install/release",
161162
"libxml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release",
162163
"LibXml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release",
163-
"MRDOCS_BUILD_TESTS": true,
164+
"LUA_ROOT": "${sourceDir}/build/third-party/lua/install/release",
165+
"Lua_ROOT": "${sourceDir}/build/third-party/lua/install/release",
166+
"lua_ROOT": "${sourceDir}/build/third-party/lua/install/release",
164167
"MRDOCS_BUILD_DOCS": false,
165168
"MRDOCS_GENERATE_REFERENCE": false,
166169
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
@@ -191,7 +194,9 @@
191194
"Duktape_ROOT": "${sourceDir}/build/third-party/duktape/install/release",
192195
"libxml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release",
193196
"LibXml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release",
194-
"MRDOCS_BUILD_TESTS": true,
197+
"LUA_ROOT": "${sourceDir}/build/third-party/lua/install/release",
198+
"Lua_ROOT": "${sourceDir}/build/third-party/lua/install/release",
199+
"lua_ROOT": "${sourceDir}/build/third-party/lua/install/release",
195200
"MRDOCS_BUILD_DOCS": false,
196201
"MRDOCS_GENERATE_REFERENCE": false,
197202
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
@@ -225,8 +230,8 @@
225230
"MRDOCS_BUILD_DOCS": false,
226231
"MRDOCS_GENERATE_REFERENCE": false,
227232
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
228-
"CMAKE_C_COMPILER": "/usr/bin/gcc",
229-
"CMAKE_CXX_COMPILER": "/usr/bin/g++",
233+
"CMAKE_C_COMPILER": "/opt/homebrew/bin/gcc-15",
234+
"CMAKE_CXX_COMPILER": "/opt/homebrew/bin/g++-15",
230235
"CMAKE_MAKE_PROGRAM": "${sourceDir}/build/third-party/ninja/ninja"
231236
},
232237
"warnings": {
@@ -257,8 +262,8 @@
257262
"MRDOCS_BUILD_DOCS": false,
258263
"MRDOCS_GENERATE_REFERENCE": false,
259264
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
260-
"CMAKE_C_COMPILER": "/usr/bin/gcc",
261-
"CMAKE_CXX_COMPILER": "/usr/bin/g++",
265+
"CMAKE_C_COMPILER": "/opt/homebrew/bin/gcc-15",
266+
"CMAKE_CXX_COMPILER": "/opt/homebrew/bin/g++-15",
262267
"CMAKE_MAKE_PROGRAM": "${sourceDir}/build/third-party/ninja/ninja",
263268
"CMAKE_C_FLAGS": "-fsanitize=address -fno-sanitize-recover=address -fno-omit-frame-pointer",
264269
"CMAKE_CXX_FLAGS": "-fsanitize=address -fno-sanitize-recover=address -fno-omit-frame-pointer"
@@ -291,8 +296,8 @@
291296
"MRDOCS_BUILD_DOCS": false,
292297
"MRDOCS_GENERATE_REFERENCE": false,
293298
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
294-
"CMAKE_C_COMPILER": "/usr/bin/gcc",
295-
"CMAKE_CXX_COMPILER": "/usr/bin/g++",
299+
"CMAKE_C_COMPILER": "/opt/homebrew/bin/gcc-15",
300+
"CMAKE_CXX_COMPILER": "/opt/homebrew/bin/g++-15",
296301
"CMAKE_MAKE_PROGRAM": "${sourceDir}/build/third-party/ninja/ninja",
297302
"CMAKE_C_FLAGS": "-fsanitize=undefined -fno-sanitize-recover=undefined -fno-omit-frame-pointer",
298303
"CMAKE_CXX_FLAGS": "-fsanitize=undefined -fno-sanitize-recover=undefined -fno-omit-frame-pointer"
@@ -321,7 +326,9 @@
321326
"Duktape_ROOT": "${sourceDir}/build/third-party/duktape/install/debug-clang",
322327
"libxml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release-clang",
323328
"LibXml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release-clang",
324-
"MRDOCS_BUILD_TESTS": true,
329+
"LUA_ROOT": "${sourceDir}/build/third-party/lua/install/debug-clang",
330+
"Lua_ROOT": "${sourceDir}/build/third-party/lua/install/debug-clang",
331+
"lua_ROOT": "${sourceDir}/build/third-party/lua/install/debug-clang",
325332
"MRDOCS_BUILD_DOCS": false,
326333
"MRDOCS_GENERATE_REFERENCE": false,
327334
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
@@ -337,7 +344,7 @@
337344
"CMAKE_EXE_LINKER_FLAGS": "-L/opt/homebrew/opt/llvm/lib/c++ -L/opt/homebrew/opt/llvm/lib/unwind -lunwind",
338345
"CMAKE_SHARED_LINKER_FLAGS": "-L/opt/homebrew/opt/llvm/lib/c++ -L/opt/homebrew/opt/llvm/lib/unwind -lunwind",
339346
"CMAKE_MODULE_LINKER_FLAGS": "-L/opt/homebrew/opt/llvm/lib/c++ -L/opt/homebrew/opt/llvm/lib/unwind -lunwind",
340-
"CMAKE_CXX_FLAGS": "-stdlib=libc++ -I/opt/homebrew/opt/llvm/include/c++/v1"
347+
"CMAKE_CXX_FLAGS": "-stdlib=libc++ -I/opt/homebrew/opt/llvm/include/c++/v1 -D_LIBCPP_HARDENING_MODE=_LIBCPP_HARDENING_MODE_EXTENSIVE"
341348
},
342349
"warnings": {
343350
"unusedCli": false
@@ -364,6 +371,9 @@
364371
"Duktape_ROOT": "${sourceDir}/build/third-party/duktape/install/debug-clang-asan",
365372
"libxml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release-clang",
366373
"LibXml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release-clang",
374+
"LUA_ROOT": "${sourceDir}/build/third-party/lua/install/debug-clang-asan",
375+
"Lua_ROOT": "${sourceDir}/build/third-party/lua/install/debug-clang-asan",
376+
"lua_ROOT": "${sourceDir}/build/third-party/lua/install/debug-clang-asan",
367377
"MRDOCS_BUILD_TESTS": true,
368378
"MRDOCS_BUILD_DOCS": false,
369379
"MRDOCS_GENERATE_REFERENCE": false,
@@ -381,7 +391,7 @@
381391
"CMAKE_SHARED_LINKER_FLAGS": "-L/opt/homebrew/opt/llvm/lib/c++ -L/opt/homebrew/opt/llvm/lib/unwind -lunwind -fsanitize=address",
382392
"CMAKE_MODULE_LINKER_FLAGS": "-L/opt/homebrew/opt/llvm/lib/c++ -L/opt/homebrew/opt/llvm/lib/unwind -lunwind -fsanitize=address",
383393
"CMAKE_C_FLAGS": "-fsanitize=address -fno-sanitize-recover=address -fno-omit-frame-pointer",
384-
"CMAKE_CXX_FLAGS": "-fsanitize=address -fno-sanitize-recover=address -fno-omit-frame-pointer -stdlib=libc++ -I/opt/homebrew/opt/llvm/include/c++/v1"
394+
"CMAKE_CXX_FLAGS": "-fsanitize=address -fno-sanitize-recover=address -fno-omit-frame-pointer -stdlib=libc++ -I/opt/homebrew/opt/llvm/include/c++/v1 -D_LIBCPP_HARDENING_MODE=_LIBCPP_HARDENING_MODE_EXTENSIVE"
385395
},
386396
"warnings": {
387397
"unusedCli": false
@@ -407,7 +417,9 @@
407417
"Duktape_ROOT": "${sourceDir}/build/third-party/duktape/install/release-clang",
408418
"libxml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release-clang",
409419
"LibXml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release-clang",
410-
"MRDOCS_BUILD_TESTS": true,
420+
"LUA_ROOT": "${sourceDir}/build/third-party/lua/install/release-clang",
421+
"Lua_ROOT": "${sourceDir}/build/third-party/lua/install/release-clang",
422+
"lua_ROOT": "${sourceDir}/build/third-party/lua/install/release-clang",
411423
"MRDOCS_BUILD_DOCS": false,
412424
"MRDOCS_GENERATE_REFERENCE": false,
413425
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
@@ -433,6 +445,40 @@
433445
"lhs": "${hostSystemName}",
434446
"rhs": "Darwin"
435447
}
448+
},
449+
{
450+
"name": "release-macos-gcc-15",
451+
"generator": "Ninja",
452+
"displayName": "Release (macOS: gcc-15)",
453+
"description": "Preset for building MrDocs in Release mode with the gcc-15 compiler in macOS.",
454+
"inherits": "release",
455+
"binaryDir": "${sourceDir}/build/${presetName}",
456+
"cacheVariables": {
457+
"CMAKE_BUILD_TYPE": "Release",
458+
"LLVM_ROOT": "${sourceDir}/build/third-party/llvm-project/install/release-gcc-15",
459+
"Clang_ROOT": "${sourceDir}/build/third-party/llvm-project/install/release-gcc-15",
460+
"duktape_ROOT": "${sourceDir}/build/third-party/duktape/install/release-gcc-15",
461+
"Duktape_ROOT": "${sourceDir}/build/third-party/duktape/install/release-gcc-15",
462+
"libxml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release-gcc-15",
463+
"LibXml2_ROOT": "${sourceDir}/build/third-party/libxml2/install/release-gcc-15",
464+
"LUA_ROOT": "${sourceDir}/build/third-party/lua/install/release-gcc-15",
465+
"Lua_ROOT": "${sourceDir}/build/third-party/lua/install/release-gcc-15",
466+
"lua_ROOT": "${sourceDir}/build/third-party/lua/install/release-gcc-15",
467+
"MRDOCS_BUILD_DOCS": false,
468+
"MRDOCS_GENERATE_REFERENCE": false,
469+
"MRDOCS_GENERATE_ANTORA_REFERENCE": false,
470+
"CMAKE_C_COMPILER": "/opt/homebrew/bin/gcc-15",
471+
"CMAKE_CXX_COMPILER": "/opt/homebrew/bin/g++-15",
472+
"CMAKE_MAKE_PROGRAM": "${sourceDir}/build/third-party/ninja/ninja"
473+
},
474+
"warnings": {
475+
"unusedCli": false
476+
},
477+
"condition": {
478+
"type": "equals",
479+
"lhs": "${hostSystemName}",
480+
"rhs": "Darwin"
481+
}
436482
}
437483
]
438484
}

‎share/mrdocs/addons/generator/adoc/partials/markup/table.adoc.hbs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
[{{#if cols}}cols={{cols}}{{/if}}]
1+
[{{#if cols}}cols={{#if (eq cols 2)}}"1,4"{{else}}{{cols}}{{/if}}{{/if}}]
22
|===
33
{{> @partial-block }}
44
|===

‎share/mrdocs/addons/generator/adoc/partials/symbol.adoc.hbs‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -31,10 +31,10 @@
3131
{{! Base classes }}
3232
{{#if (any_of_by symbol.bases "isPublic")}}
3333
{{#> markup/dynamic-level-h }}Base Classes{{/markup/dynamic-level-h~}}
34-
[cols=2]
34+
[cols="1,4"]
3535
|===
36-
| Name
37-
| Description
36+
|Name|Description
37+
3838
{{#each (filter_by symbol.bases "isPublic")}}
3939
| {{#>markup/code}}{{> type/declarator type }}{{/markup/code}}
4040
| {{> doc/block/inline-brief type.name.symbol.doc.brief }}
@@ -45,10 +45,10 @@
4545
{{! Protected Base classes }}
4646
{{#if (any_of_by symbol.bases "isProtected")}}
4747
{{#> markup/dynamic-level-h }}Protected Base Classes{{/markup/dynamic-level-h~}}
48-
[cols=2]
48+
[cols="1,4"]
4949
|===
50-
| Name
51-
| Description
50+
|Name|Description
51+
5252
{{#each (filter_by symbol.bases "isProtected")}}
5353
| {{#>markup/code}}{{> type/declarator type }}{{/markup/code}}
5454
| {{> doc/block/inline-brief type.name.symbol.doc.brief }}
@@ -74,10 +74,10 @@
7474
{{! Friends }}
7575
{{#if symbol.friends}}
7676
{{#> markup/dynamic-level-h }}Friends{{/markup/dynamic-level-h~}}
77-
[cols=2]
77+
[cols="1,4"]
7878
|===
79-
| Name
80-
| Description
79+
|Name|Description
80+
8181
{{#each symbol.friends }}
8282
{{#if symbol}}
8383
| {{#>markup/code}}{{> symbol/qualified-name symbol }}{{/markup/code}}
@@ -98,7 +98,7 @@
9898
{{! Related symbols }}
9999
{{#if symbol.doc.related}}
100100
{{#> markup/dynamic-level-h }}Non-Member Functions{{/markup/dynamic-level-h~}}
101-
[cols=2]
101+
[cols="1,4"]
102102
|===
103103
| Name
104104
| Description
@@ -112,10 +112,10 @@
112112
{{! Derived classes }}
113113
{{#if symbol.derived}}
114114
{{#> markup/dynamic-level-h }}Derived Classes{{/markup/dynamic-level-h~}}
115-
[cols=2]
115+
[cols="1,4"]
116116
|===
117-
| Name
118-
| Description
117+
|Name|Description
118+
119119
{{#each symbol.derived}}
120120
| {{#if url~}}
121121
{{#>markup/a href=url}}{{#>markup/code}}{{> type/name-info-text . }}{{/markup/code}}{{/markup/a}}
@@ -140,10 +140,10 @@
140140
{{#if symbol.shadows}}
141141
{{#> markup/dynamic-level-h }}Introduced Symbols{{/markup/dynamic-level-h~}}
142142
{{#if (any_of_by symbol.shadows "doc")}}
143-
[cols=2]
143+
[cols="1,4"]
144144
|===
145-
| Name
146-
| Description
145+
|Name|Description
146+
147147
{{#each symbol.shadows}}
148148
| {{> symbol/qualified-name . }}
149149
| {{> doc/block/inline-brief doc.brief }}
@@ -162,7 +162,7 @@
162162
{{! Exceptions }}
163163
{{#if symbol.doc.exceptions}}
164164
{{#> markup/dynamic-level-h }}Exceptions{{/markup/dynamic-level-h~}}
165-
[cols=2]
165+
[cols="1,4"]
166166
|===
167167
| Name
168168
| Thrown on
@@ -190,10 +190,10 @@
190190
{{! Template Parameters }}
191191
{{#if symbol.doc.tparams}}
192192
{{#> markup/dynamic-level-h }}Template Parameters{{/markup/dynamic-level-h~}}
193-
[cols=2]
193+
[cols="1,4"]
194194
|===
195-
| Name
196-
| Description
195+
|Name|Description
196+
197197
{{#each symbol.doc.tparams}}
198198
| *{{name}}*
199199
| {{>doc/block .}}
@@ -204,10 +204,10 @@
204204
{{! Parameters }}
205205
{{#if symbol.doc.params}}
206206
{{#> markup/dynamic-level-h }}Parameters{{/markup/dynamic-level-h~}}
207-
[cols=2]
207+
[cols="1,4"]
208208
|===
209-
| Name
210-
| Description
209+
|Name|Description
210+
211211
{{#each symbol.doc.params}}
212212
| *{{name}}*{{#if direction}} [{{direction}}]{{/if}}
213213
| {{>doc/block .}}

‎share/mrdocs/addons/generator/common/partials/symbol/detail/members-table-impl.hbs‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,7 @@
11
{{#>markup/table cols=(select includeBrief 2 1)}}
22
{{#>markup/thead}}
33
{{#>markup/tr~}}
4-
{{#>markup/th}}Name{{/markup/th}}
5-
{{#if includeBrief}}
6-
{{#>markup/th}}Description{{/markup/th}}
7-
{{/if}}
4+
{{#>markup/th}}Name{{/markup/th}}{{#if includeBrief}}{{#>markup/th}}Description{{/markup/th}}{{/if}}
85
{{/markup/tr}}
96
{{/markup/thead}}
107
{{#>markup/tbody}}

‎test-files/golden-tests/config/auto-brief/auto-brief.adoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@
66

77
=== Functions
88

9-
[cols=2]
9+
[cols="1,4"]
1010
|===
11-
| Name
12-
| Description
11+
| Name| Description
1312
| link:#copyBriefFromCopyBrief[`copyBriefFromCopyBrief`]
1413
| This is the explicit brief.
1514
| link:#copyBriefFromExplicitBrief[`copyBriefFromExplicitBrief`]

‎test-files/golden-tests/config/auto-brief/auto-brief.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ <h2>Functions</h2>
1313
<table style="table-layout: fixed; width: 100%;">
1414
<thead>
1515
<tr>
16-
<th>Name</th>
17-
<th>Description</th>
16+
<th>Name</th><th>Description</th>
1817
</tr>
1918
</thead>
2019
<tbody>

‎test-files/golden-tests/config/auto-brief/no-auto-brief.adoc‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,9 @@
66

77
=== Functions
88

9-
[cols=2]
9+
[cols="1,4"]
1010
|===
11-
| Name
12-
| Description
11+
| Name| Description
1312
| link:#copyBriefFromCopyBrief[`copyBriefFromCopyBrief`]
1413
| This is the explicit brief&period;
1514
| link:#copyBriefFromExplicitBrief[`copyBriefFromExplicitBrief`]

‎test-files/golden-tests/config/auto-brief/no-auto-brief.html‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ <h2>Functions</h2>
1313
<table style="table-layout: fixed; width: 100%;">
1414
<thead>
1515
<tr>
16-
<th>Name</th>
17-
<th>Description</th>
16+
<th>Name</th><th>Description</th>
1817
</tr>
1918
</thead>
2019
<tbody>

0 commit comments

Comments
 (0)