summaryrefslogtreecommitdiff
path: root/src/bin
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-07-23 16:38:04 +0200
committerXavi Artigas <xavierartigas@yahoo.es>2019-07-23 21:53:01 +0200
commit5585420e858bbb17ae3b7cc599b4a0f2eb178075 (patch)
treef91520fc738e36a13919709d777bb9e267f8e529 /src/bin
parent3eb7b3793b0afcc79143a74a4052cb6179334f08 (diff)
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 'src/bin')
-rw-r--r--src/bin/eolian_mono/eolian/mono/documentation.hh6
1 files changed, 6 insertions, 0 deletions
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 @@
12#include <Eina.h> 12#include <Eina.h>
13 13
14static const std::string BETA_REF_SUFFIX = " (object still in beta stage)"; 14static const std::string BETA_REF_SUFFIX = " (object still in beta stage)";
15static 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.";
15 16
16namespace eolian_mono { 17namespace eolian_mono {
17 18
@@ -390,6 +391,11 @@ struct documentation_generator
390 { 391 {
391 if (!generate(sink, klass.documentation, context)) return false; 392 if (!generate(sink, klass.documentation, context)) return false;
392 393
394 if (klass.is_beta)
395 {
396 if (!generate_tag(sink, "remarks", BETA_SUMMARY_REMARKS, context)) return false;
397 }
398
393 std::string klass_name = name_helpers::klass_full_concrete_or_interface_name(klass); 399 std::string klass_name = name_helpers::klass_full_concrete_or_interface_name(klass);
394 return generate_tag_example(sink, klass_name, context); 400 return generate_tag_example(sink, klass_name, context);
395 } 401 }