From 4cedc2841b95bf306b58c69688ea7f471f15645d Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Tue, 21 Nov 2023 16:52:19 -0300 Subject: [PATCH 1/5] refactor: invert source and synopsis --- share/mrdocs/addons/generator/asciidoc/partials/enum.adoc.hbs | 4 ++-- .../addons/generator/asciidoc/partials/enumerator.adoc.hbs | 4 ++-- .../mrdocs/addons/generator/asciidoc/partials/field.adoc.hbs | 4 ++-- .../mrdocs/addons/generator/asciidoc/partials/friend.adoc.hbs | 4 ++-- .../addons/generator/asciidoc/partials/function.adoc.hbs | 4 ++-- .../mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs | 4 ++-- .../addons/generator/asciidoc/partials/typedef.adoc.hbs | 4 ++-- .../addons/generator/asciidoc/partials/variable.adoc.hbs | 4 ++-- 8 files changed, 16 insertions(+), 16 deletions(-) diff --git a/share/mrdocs/addons/generator/asciidoc/partials/enum.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/enum.adoc.hbs index e1744dc1c..af05626c2 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/enum.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/enum.adoc.hbs @@ -5,13 +5,13 @@ == Synopsis +{{>source dcl=(primary_location symbol)}} + [source,cpp,subs="verbatim,macros,-callouts"] ---- enum {{symbol.name}}; ---- -{{>source dcl=(primary_location symbol)}} - {{#if symbol.members}} == Members [,cols=2] diff --git a/share/mrdocs/addons/generator/asciidoc/partials/enumerator.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/enumerator.adoc.hbs index e6777eb3a..31989febc 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/enumerator.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/enumerator.adoc.hbs @@ -5,13 +5,13 @@ == Synopsis +{{>source dcl=(primary_location symbol)}} + [source,cpp,subs="verbatim,macros,-callouts"] ---- {{symbol.name}}{{#if symbol.initializer}} = {{symbol.initializer}}{{~/if}} ---- -{{>source dcl=(primary_location symbol)}} - {{#if symbol.doc.description}} == Description diff --git a/share/mrdocs/addons/generator/asciidoc/partials/field.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/field.adoc.hbs index fa22558d5..5556e0d13 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/field.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/field.adoc.hbs @@ -5,6 +5,8 @@ == Synopsis +{{>source dcl=(primary_location symbol)}} + [source,cpp,subs="verbatim,macros,-callouts"] ---- {{#if symbol.isMutable}}mutable @@ -15,8 +17,6 @@ ; ---- -{{>source dcl=(primary_location symbol)}} - {{#if symbol.doc.description}} == Description diff --git a/share/mrdocs/addons/generator/asciidoc/partials/friend.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/friend.adoc.hbs index 0b3bc5c85..9d3ba01c8 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/friend.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/friend.adoc.hbs @@ -5,6 +5,8 @@ == Synopsis +{{>source dcl=(primary_location symbol)}} + {{#if symbol.type~}} [source,cpp,subs="verbatim,macros,-callouts"] ---- @@ -16,8 +18,6 @@ friend {{>declarator symbol.type}}; {{>function-decl symbol.symbol isFriend=true~}} {{/if}} -{{>source dcl=(primary_location symbol)}} - {{#if symbol.doc.description}} == Description diff --git a/share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs index 23a854375..1098bdac7 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs @@ -5,10 +5,10 @@ == Synopsis -{{>function-decl symbol isFriend=false}} - {{>source dcl=(primary_location symbol)}} +{{>function-decl symbol isFriend=false}} + {{#if symbol.doc.description}} == Description diff --git a/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs index ea0d74828..4d77c4c83 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs @@ -5,10 +5,10 @@ == Synopsis -{{>record-decl symbol isFriend=false}} - {{>source dcl=(primary_location symbol)}} +{{>record-decl symbol isFriend=false}} + {{#with symbol.interface}} {{> tranche tranche=public label=""}} {{> tranche tranche=protected label=" Protected"}} diff --git a/share/mrdocs/addons/generator/asciidoc/partials/typedef.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/typedef.adoc.hbs index 47e6293ce..0de62c8c5 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/typedef.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/typedef.adoc.hbs @@ -5,6 +5,8 @@ == Synopsis +{{>source dcl=(primary_location symbol)}} + [source,cpp,subs="verbatim,macros,-callouts"] ---- {{#if symbol.isUsing~}} @@ -17,8 +19,6 @@ ; ---- -{{>source dcl=(primary_location symbol)}} - {{#if symbol.doc.description}} == Description diff --git a/share/mrdocs/addons/generator/asciidoc/partials/variable.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/variable.adoc.hbs index 571421fc4..ddb688165 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/variable.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/variable.adoc.hbs @@ -5,6 +5,8 @@ == Synopsis +{{>source dcl=(primary_location symbol)}} + [source,cpp,subs="verbatim,macros,-callouts"] ---- {{#if symbol.template}}{{>template-head symbol.template}} @@ -25,8 +27,6 @@ ; ---- -{{>source dcl=(primary_location symbol)}} - {{#if symbol.doc.description}} == Description From 355282fda6da51d0715eb79b2ce96f94d8f290d6 Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Tue, 21 Nov 2023 16:52:50 -0300 Subject: [PATCH 2/5] fix: tranche partial requires no whitespace --- .../asciidoc/partials/record.adoc.hbs | 4 ++-- .../asciidoc/partials/tranche.adoc.hbs | 18 +++++++++--------- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs index 4d77c4c83..6a2d06f44 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs @@ -11,8 +11,8 @@ {{#with symbol.interface}} {{> tranche tranche=public label=""}} -{{> tranche tranche=protected label=" Protected"}} -{{> tranche tranche=private label=" Private"}} +{{> tranche tranche=protected label="Protected"}} +{{> tranche tranche=private label="Private"}} {{/with}} {{#if symbol.doc.description}} diff --git a/share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs index 0491894c3..f96a40008 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs @@ -1,36 +1,36 @@ {{#if tranche.records}} -=={{label}} Types +== {{label}} Types {{>info-list tranche.records}} {{/if}} {{#if tranche.types}} {{#if label}} -=={{label}} Types +== {{label}} Types {{else}} -== Types +== Types {{/if}} {{>info-list tranche.types}} {{/if}} {{#if tranche.functions}} -=={{label}} Member Functions +== {{label}} Member Functions {{>info-list tranche.functions}} {{/if}} {{#if tranche.enums}} -=={{label}} Enums +== {{label}} Enums {{>info-list tranche.enums}} {{/if}} {{#if tranche.fields}} -=={{label}} Data Members +== {{label}} Data Members {{>info-list tranche.fields}} {{/if}} {{#if tranche.staticfunctions}} -=={{label}} Static Member Functions +== {{label}} Static Member Functions {{>info-list tranche.staticfunctions}} {{/if}} {{#if tranche.staticdata}} -=={{label}} Static Data Members +== {{label}} Static Data Members {{>info-list tranche.staticdata}} {{/if}} {{#if tranche.friends}} -=={{label}} Friends +== {{label}} Friends {{>info-list tranche.friends}} {{/if}} From 764915ac1293b6c0ab71b20bf504b799213d53a5 Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Tue, 21 Nov 2023 16:53:12 -0300 Subject: [PATCH 3/5] refactor: namespace members are sorted --- .../addons/generator/asciidoc/partials/namespace.adoc.hbs | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/share/mrdocs/addons/generator/asciidoc/partials/namespace.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/namespace.adoc.hbs index 1dd6b384f..a27d26f0f 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/namespace.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/namespace.adoc.hbs @@ -2,12 +2,12 @@ = {{#if symbol.name}}Namespace {{symbol.name}}{{else if symbol.parent}}Unnamed namespace{{else}}Global namespace{{/if}} {{#each (group_by symbol.members "kind")}} -== {{#if (eq @key "record")}}Classes{{else}}{{capitalize @key}}s{{/if}} +== {{#if (eq @key "record")}}Types{{else if (eq @key "variable")}}Constants{{else}}{{capitalize @key}}s{{/if}} [,cols=2] |=== |Name |Description -{{#each .}} +{{#each (sort_by . "name")}} |xref:{{ref}}[`pass:v[{{name}}]`] |{{doc.brief}} {{/each}} |=== From e0b5b04a6fb62b6a4a144a761e2a7afbcda0179f Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Tue, 21 Nov 2023 16:53:38 -0300 Subject: [PATCH 4/5] refactor: source partial refers to headers --- .../mrdocs/addons/generator/asciidoc/partials/source.adoc.hbs | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/share/mrdocs/addons/generator/asciidoc/partials/source.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/source.adoc.hbs index e6281837f..a59ba6003 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/source.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/source.adoc.hbs @@ -1 +1,2 @@ -Declared in file <{{dcl.file}}> on line {{dcl.line}} +// <{{dcl.file}}>: line {{dcl.line}} +Declared in header <{{dcl.file}}> From ef1f09298284308c6dbbb516133c923bd4ce60ce Mon Sep 17 00:00:00 2001 From: alandefreitas Date: Tue, 21 Nov 2023 16:53:59 -0300 Subject: [PATCH 5/5] refactor: replicate function and record sections --- .../asciidoc/partials/function.adoc.hbs | 27 +++++++++++++++++++ .../asciidoc/partials/record.adoc.hbs | 2 ++ 2 files changed, 29 insertions(+) diff --git a/share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs index 1098bdac7..a08b333b5 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs @@ -14,4 +14,31 @@ {{symbol.doc.description}} +{{! TODO: == Exceptions }} + +{{#if symbol.return}} +== Return Value + +* `{{symbol.return.name}}` {{! TODO: symbol.doc.return }} + +{{/if}} + +{{#if symbol.params}} +== Parameters + +|=== +| Name | Type {{! TODO: | Description }} + +{{#each symbol.params}} +| *{{name}}* +| `{{type.name}}` +{{! TODO: symbol.doc.params.[name] }} + +{{/each}} +|=== + +{{/if}} + +{{! TODO: == See Also }} + {{/if}} diff --git a/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs b/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs index 6a2d06f44..5098f428f 100644 --- a/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs +++ b/share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs @@ -21,3 +21,5 @@ {{symbol.doc.description}} {{/if}} + +{{! TODO: == See Also }}