diff options
-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 | ||||
-rw-r--r-- | src/bin/eolian_mono/eolian/mono/documentation.hh | 6 |
4 files changed, 18 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; +} diff --git a/src/bin/eolian_mono/eolian/mono/documentation.hh b/src/bin/eolian_mono/eolian/mono/documentation.hh index a672d209b4..26e5645eb2 100644 --- a/src/bin/eolian_mono/eolian/mono/documentation.hh +++ b/src/bin/eolian_mono/eolian/mono/documentation.hh @@ -12,6 +12,7 @@ #include <Eina.h> static const std::string BETA_REF_SUFFIX = " (object still in beta stage)"; +static const std::string BETA_SUMMARY_REMARKS = "This is a \\<b\\>BETA\\</b\\> class. It can be modified or removed in the future. Do not use it for product development."; namespace eolian_mono { @@ -390,6 +391,11 @@ struct documentation_generator { if (!generate(sink, klass.documentation, context)) return false; + if (klass.is_beta) + { + if (!generate_tag(sink, "remarks", BETA_SUMMARY_REMARKS, context)) return false; + } + std::string klass_name = name_helpers::klass_full_concrete_or_interface_name(klass); return generate_tag_example(sink, klass_name, context); } |