diff --git a/tools/scripting_docs_gen/main.cpp b/tools/scripting_docs_gen/main.cpp index 8b20c3efc7d..de1bef13294 100644 --- a/tools/scripting_docs_gen/main.cpp +++ b/tools/scripting_docs_gen/main.cpp @@ -122,8 +122,8 @@ int main(int argc, char** argv) std::string target_data = Writer::write_file_notice(page_template_filename) + page_template; // Entries - replace(target_data, "${SRG_CLASSSUMMARY}", cl.summary, "None."); - replace(target_data, "${SRG_CLASSINSTANCES}", cl.instances, "None."); + replace(target_data, "${SRG_CLASSSUMMARY}", Writer::format_description(std::move(cl.summary)), "None."); + replace(target_data, "${SRG_CLASSINSTANCES}", Writer::format_description(std::move(cl.instances)), "None."); replace(target_data, "${SRG_CLASSINHERITANCE}", Writer::write_inheritance_list(classes, cl.base_classes, cl.derived_classes), "None."); replace(target_data, "${SRG_CLASSCONSTANTS}", Writer::write_constants_table(cl.constants), "None."); replace(target_data, "${SRG_CLASSVARIABLES}", Writer::write_variables_table(cl.variables), "None."); diff --git a/tools/scripting_docs_gen/writer.cpp b/tools/scripting_docs_gen/writer.cpp index 8b8a2ce4f15..f87fbc7eb5e 100644 --- a/tools/scripting_docs_gen/writer.cpp +++ b/tools/scripting_docs_gen/writer.cpp @@ -22,7 +22,7 @@ namespace Writer { -static std::string format_description(std::string desc) +std::string format_description(std::string desc) { replace(desc, "\"\"", "`"); replace(desc, "NOTE:", "

**NOTE:**"); @@ -30,6 +30,7 @@ static std::string format_description(std::string desc) return desc; } + std::string write_file_notice(const std::string& template_file) { std::stringstream notice; diff --git a/tools/scripting_docs_gen/writer.hpp b/tools/scripting_docs_gen/writer.hpp index a1e69fa4096..e4d7888b44a 100644 --- a/tools/scripting_docs_gen/writer.hpp +++ b/tools/scripting_docs_gen/writer.hpp @@ -24,6 +24,8 @@ namespace Writer { + std::string format_description(std::string desc); + std::string write_file_notice(const std::string& template_file); std::string write_inheritance_list(const std::vector& classes,