enlightenment/efl
enlightenment
/
efl
8
7
Fork 14
Code Issues 13 Pull Requests 3 Projects Releases Wiki Activity

csharp: Add a documentation_string generator 

Summary:
Escapes a single string, without leading `///`

Depends on D9481

Reviewers: segfaultxavi, felipealmeida

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D9482
This commit is contained in:
Lauro Moura 2019-08-01 21:12:12 +02:00 committed by Xavi Artigas
parent becef7aee4
commit ca813f41a6
2 changed files with 28 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/bin/eolian_mono/eolian/mono/documentation.hh
View File

@ -567,6 +567,26 @@ documentation_generator as_generator(documentation_terminal)
return documentation_generator(0);
}
/// Escape a single string, HTML-escaping and converting the syntax
struct documentation_string_generator
{
template<typename OutputIterator, typename Context>
bool generate(OutputIterator sink, std::string const& text, Context const& context) const
{
std::string escaped;
if (!as_generator(html_escaped_string).generate(std::back_inserter(escaped), text, context))
return false;
auto options = context_find_tag<options_context>(context);
auto state = context_find_tag<eolian_state_context>(context).state;
if (!as_generator(string).generate(sink, documentation_generator::syntax_conversion(escaped, state, options.want_beta), context))
return false;
return true;
}
} const documentation_string {};
} // namespace eolian_mono
@ -577,6 +597,11 @@ struct is_eager_generator<::eolian_mono::documentation_generator> : std::true_ty
template<>
struct is_generator<::eolian_mono::documentation_generator> : std::true_type {};
template<>
struct is_eager_generator<::eolian_mono::documentation_string_generator> : std::true_type {};
template<>
struct is_generator<::eolian_mono::documentation_string_generator> : std::true_type {};
template<>
struct is_generator<::eolian_mono::documentation_terminal> : std::true_type {};
@ -585,6 +610,8 @@ template<>
struct attributes_needed<struct ::eolian_mono::documentation_generator> : std::integral_constant<int, 1> {};
template<>
struct attributes_needed<struct ::eolian_mono::documentation_terminal> : std::integral_constant<int, 1> {};
template<>
struct attributes_needed<struct ::eolian_mono::documentation_string_generator> : std::integral_constant<int, 1> {};
}
} } }

2
src/bin/eolian_mono/eolian/mono/struct_fields.hh
View File

@ -42,7 +42,7 @@ struct field_argument_docs_generator
template<typename OutputIterator, typename Context>
bool generate(OutputIterator sink, attributes::struct_field_def const& field, Context const& context) const
{
if (!as_generator("/// <param name=\"" << string << "\">" << string << "</param>")
if (!as_generator("/// <param name=\"" << string << "\">" << documentation_string << "</param>")
.generate(sink, std::make_tuple(name_helpers::to_field_name(field.name), field.documentation.summary), context))
return false;
return true;