Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Replicate Boost.URL sections #490

Merged
merged 5 commits into from
Nov 21, 2023
Merged

Replicate Boost.URL sections #490

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
4cedc28
refactor: invert source and synopsis
alandefreitas Nov 21, 2023
355282f
fix: tranche partial requires no whitespace
alandefreitas Nov 21, 2023
764915a
refactor: namespace members are sorted
alandefreitas Nov 21, 2023
e0b5b04
refactor: source partial refers to headers
alandefreitas Nov 21, 2023
ef1f092
refactor: replicate function and record sections
alandefreitas Nov 21, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/asciidoc/partials/enum.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/asciidoc/partials/enumerator.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/asciidoc/partials/field.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

== Synopsis

{{>source dcl=(primary_location symbol)}}

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{#if symbol.isMutable}}mutable
Expand All @@ -15,8 +17,6 @@
;
----

{{>source dcl=(primary_location symbol)}}

{{#if symbol.doc.description}}
== Description

Expand Down
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/asciidoc/partials/friend.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

== Synopsis

{{>source dcl=(primary_location symbol)}}

{{#if symbol.type~}}
[source,cpp,subs="verbatim,macros,-callouts"]
----
Expand All @@ -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

Expand Down
31 changes: 29 additions & 2 deletions share/mrdocs/addons/generator/asciidoc/partials/function.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,40 @@

== Synopsis

{{>function-decl symbol isFriend=false}}

{{>source dcl=(primary_location symbol)}}

{{>function-decl symbol isFriend=false}}

{{#if symbol.doc.description}}
== Description

{{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}}
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/asciidoc/partials/namespace.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}}
|===
Expand Down
10 changes: 6 additions & 4 deletions share/mrdocs/addons/generator/asciidoc/partials/record.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,14 @@

== 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"}}
{{> tranche tranche=private label=" Private"}}
{{> tranche tranche=protected label="Protected"}}
{{> tranche tranche=private label="Private"}}
{{/with}}

{{#if symbol.doc.description}}
Expand All @@ -21,3 +21,5 @@
{{symbol.doc.description}}

{{/if}}

{{! TODO: == See Also }}
3 changes: 2 additions & 1 deletion share/mrdocs/addons/generator/asciidoc/partials/source.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
Declared in file <{{dcl.file}}> on line {{dcl.line}}
// <{{dcl.file}}>: line {{dcl.line}}
Declared in header <{{dcl.file}}>
18 changes: 9 additions & 9 deletions share/mrdocs/addons/generator/asciidoc/partials/tranche.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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}}
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/asciidoc/partials/typedef.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

== Synopsis

{{>source dcl=(primary_location symbol)}}

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{#if symbol.isUsing~}}
Expand All @@ -17,8 +19,6 @@
;
----

{{>source dcl=(primary_location symbol)}}

{{#if symbol.doc.description}}
== Description

Expand Down
4 changes: 2 additions & 2 deletions share/mrdocs/addons/generator/asciidoc/partials/variable.adoc.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,8 @@

== Synopsis

{{>source dcl=(primary_location symbol)}}

[source,cpp,subs="verbatim,macros,-callouts"]
----
{{#if symbol.template}}{{>template-head symbol.template}}
Expand All @@ -25,8 +27,6 @@
;
----

{{>source dcl=(primary_location symbol)}}

{{#if symbol.doc.description}}
== Description

Expand Down