diff options
author | Xavi Artigas <xavierartigas@yahoo.es> | 2019-10-09 16:18:14 +0200 |
---|---|---|
committer | Xavi Artigas <xavierartigas@yahoo.es> | 2019-10-09 16:18:30 +0200 |
commit | 9dcfe4bbbce4bef369d4ab7cd23f5c3a61d3a73d (patch) | |
tree | 2d7b3f94b78642bfa6b76d10aee36b9c4f6225ba /src/bin | |
parent | 86191b02c78348608652fcbd3c834060815107a3 (diff) | |
download | efl-9dcfe4bbbce4bef369d4ab7cd23f5c3a61d3a73d.tar.gz |
mono-docs: Merge Property and getter/setter docs
Summary:
Property docs, when present, should always be included in Property and Accessor
(setter and getter) docs.
Accessor docs, when present, should be included in their accessor method, and
also in the property method, as a side note.
This patch does just that.
Depends on D10285
Ref T8309
Test Plan: Generate docs and take a look at `Efl.Ui.Calendar`, for example, which has a bit of everything.
Reviewers: lauromoura
Reviewed By: lauromoura
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8309
Differential Revision: https://phab.enlightenment.org/D10298
Diffstat (limited to 'src/bin')
-rw-r--r-- | src/bin/eolian_mono/eolian/mono/documentation.hh | 45 |
1 files changed, 23 insertions, 22 deletions
diff --git a/src/bin/eolian_mono/eolian/mono/documentation.hh b/src/bin/eolian_mono/eolian/mono/documentation.hh index 0bdfbda64e..7bcdfc58d6 100644 --- a/src/bin/eolian_mono/eolian/mono/documentation.hh +++ b/src/bin/eolian_mono/eolian/mono/documentation.hh @@ -437,20 +437,24 @@ struct documentation_generator template<typename OutputIterator, typename Context> bool generate(OutputIterator sink, attributes::property_def const& prop, Context const& context) const { - std::string tail_text = ""; - + // Generate docs by merging Property, Accessor, Since and Beta pieces. + std::string text = prop.documentation.full_text; + if (!prop.documentation.since.empty()) + text += "\\<br/\\>\nSince EFL " + prop.documentation.since + "."; + if (prop.setter.is_engaged() && !prop.setter->documentation.full_text.empty()) + text += "\\<br/\\>\n\\<b\\>Note on writing:\\</b\\> " + prop.setter->documentation.full_text; + if (prop.getter.is_engaged() && !prop.getter->documentation.full_text.empty()) + text += "\\<br/\\>\n\\<b\\>Note on reading:\\</b\\> " + prop.getter->documentation.full_text; if (!prop.klass.is_beta) { if ((prop.setter.is_engaged() && prop.setter->is_beta) || (prop.getter.is_engaged() && prop.getter->is_beta)) - { - tail_text = BETA_PROPERTY_REMARK; - } + text += BETA_PROPERTY_REMARK; } - if (!generate(sink, prop.documentation, context, tail_text)) - return false; + if (!generate_tag_summary(sink, text, context)) + return false; - std::string text; + text = ""; if (prop.setter.is_engaged()) text = prop.setter->parameters[0].documentation.full_text; else if (prop.getter.is_engaged()) @@ -478,21 +482,18 @@ struct documentation_generator template<typename OutputIterator, typename Context> bool generate_property(OutputIterator sink, attributes::function_def const& func, Context const& context) const { - std::string tail_text = ""; - if (!func.klass.is_beta && func.is_beta) - { - tail_text = BETA_METHOD_REMARK; - } - - // First, try the get/set specific documentation - if (!func.documentation.summary.empty()) - { - if (!generate(sink, func.documentation, context, tail_text)) - return false; - } - else // fallback to common property documentation + if (!func.documentation.full_text.empty() || + !func.property_documentation.full_text.empty()) { - if (!generate(sink, func.property_documentation, context, tail_text)) + // Generate docs by merging Property, Accessor, Since and Beta pieces. + std::string text = func.property_documentation.full_text; + if (!func.property_documentation.since.empty()) + text += "\\<br/\\>\nSince EFL " + func.property_documentation.since + "."; + if (!func.documentation.full_text.empty()) + text += "\\<br/\\>\n\\<b\\>Note:\\</b\\> " + func.documentation.full_text; + if (!func.klass.is_beta && func.is_beta) + text += BETA_METHOD_REMARK; + if (!generate_tag_summary(sink, text, context)) return false; } |