diff options
author | Xavi Artigas <xavierartigas@yahoo.es> | 2019-07-23 16:38:04 +0200 |
---|---|---|
committer | Xavi Artigas <xavierartigas@yahoo.es> | 2019-07-23 21:53:01 +0200 |
commit | 5585420e858bbb17ae3b7cc599b4a0f2eb178075 (patch) | |
tree | f91520fc738e36a13919709d777bb9e267f8e529 /doc | |
parent | 3eb7b3793b0afcc79143a74a4052cb6179334f08 (diff) | |
download | efl-5585420e858bbb17ae3b7cc599b4a0f2eb178075.tar.gz |
mono-docs: Indicate when a class is BETA
Summary:
The mono generator adds a <remarks> section to all BETA classes with an explanatory text.
These tags are understood by DocFX and Monodevelop.
On top of this, this commit modifies the DocFX template to give the Remarks section a more
prominent place in the page.
Test Plan: Render docs, Beta classes should have a big blue box with a remark about the class being Beta and dangerous.
Reviewers: lauromoura, vitor.sousa
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Differential Revision: https://phab.enlightenment.org/D9381
Diffstat (limited to 'doc')
-rw-r--r-- | doc/docfx/default_efl/partials/class.header.tmpl.partial | 10 | ||||
-rw-r--r-- | doc/docfx/default_efl/partials/class.tmpl.partial | 4 | ||||
-rw-r--r-- | doc/docfx/default_efl/styles/docfx.css | 6 |
3 files changed, 12 insertions, 8 deletions
diff --git a/doc/docfx/default_efl/partials/class.header.tmpl.partial b/doc/docfx/default_efl/partials/class.header.tmpl.partial index f6bff1af39..18c6dc7341 100644 --- a/doc/docfx/default_efl/partials/class.header.tmpl.partial +++ b/doc/docfx/default_efl/partials/class.header.tmpl.partial @@ -3,6 +3,12 @@ <h1 id="{{id}}" data-uid="{{uid}}" class="text-break">{{>partials/title}}</h1>
<div class="markdown level0 summary">{{{summary}}}</div>
<div class="markdown level0 conceptual">{{{conceptual}}}</div>
+{{#remarks}}
+<div class="remarks">
+<h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
+{{{remarks}}}
+</div>
+{{/remarks}}
{{#inClass}}
<div class="inheritance">
<h5>{{__global.inheritance}}</h5>
@@ -82,10 +88,6 @@ </tbody>
</table>
{{/syntax.typeParameters.0}}
-{{#remarks}}
-<h5 id="{{id}}_remarks"><strong>{{__global.remarks}}</strong></h5>
-<div class="markdown level0 remarks">{{{remarks}}}</div>
-{{/remarks}}
{{#example.0}}
<h5 id="{{id}}_examples"><strong>{{__global.examples}}</strong></h5>
{{/example.0}}
diff --git a/doc/docfx/default_efl/partials/class.tmpl.partial b/doc/docfx/default_efl/partials/class.tmpl.partial index ae9de66364..75bfce0e9b 100644 --- a/doc/docfx/default_efl/partials/class.tmpl.partial +++ b/doc/docfx/default_efl/partials/class.tmpl.partial @@ -143,10 +143,6 @@ <h5 class="overrides">{{__global.overrides}}</h5>
<div><xref uid="{{uid}}" altProperty="fullName" displayProperty="nameWithType"/></div>
{{/overridden}}
-{{#remarks}}
-<h5 id="{{id}}_remarks">{{__global.remarks}}</h5>
-<div class="markdown level1 remarks">{{{remarks}}}</div>
-{{/remarks}}
{{#example.0}}
<h5 id="{{id}}_examples">{{__global.examples}}</h5>
{{/example.0}}
diff --git a/doc/docfx/default_efl/styles/docfx.css b/doc/docfx/default_efl/styles/docfx.css index f94c4b0377..81beac718e 100644 --- a/doc/docfx/default_efl/styles/docfx.css +++ b/doc/docfx/default_efl/styles/docfx.css @@ -995,3 +995,9 @@ div.embeddedvideo iframe { .mainContainer[dir='rtl'] main ul[role="tablist"] { margin: 0; } + +.remarks { + background-color: #c0c0ff; + border-radius: 6px; + padding: 6px; +} |