mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-01-07 04:00:37 -06:00
Code Issues Packages Projects Releases Wiki Activity

Updating HTML generation for general documentation

Browse Source
This commit is contained in:
Alexander Bock
2016-09-16 12:24:47 +02:00
parent 17a65e3816
commit 24e5146a8e
2 changed files with 46 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
.gitignore vendored
View File

@@ -37,6 +37,7 @@ shaders/ABuffer/constants.hglsl
LuaScripting.txt
Properties.txt
log.html
Documentation.html
data/scene/rosetta/67P/obj/67P_rotated_5_130.obj
data/spice/NewHorizonsKernels/
data/scene/newhorizons/pluto/pluto/textures/

61
src/documentation/documentationengine.cpp
View File

@@ -106,37 +106,44 @@ std::string generateJsonDocumentation(const Documentation& d) {
std::string generateHtmlDocumentation(const Documentation& d) {
std::stringstream html;
html << "<table cellpadding=3 cellspacing=0 border=1>\n"
<< "\t<caption>" << d.name << "</caption>\n\n"
<< "\t<thead>\n"
<< "\t\t<tr>\n"
<< "\t\t\t<th>Key</th>\n"
<< "\t\t\t<th>Optional</th>\n"
<< "\t\t\t<th>Type</th>\n"
<< "\t\t\t<th>Restrictions</th>\n"
<< "\t\t\t<th>Documentation</th>\n"
<< "\t\t</tr>\n"
<< "\t</thead>\n"
<< "\t<tbody>\n";
html << "\t<tr>\n"
<< "\t\t<td colspan=6>" << d.name << "</td>\n";
for (const auto& p : d.entries) {
html << "\t<tr>\n"
<< "\t\t<td></td>\n"
<< "\t\t<td>" << p.key << "</td>\n"
<< "\t\t<td>" << (p.optional ? "true" : "false") << "</td>\n"
<< "\t\t<td>" << p.verifier->type() << "</td>\n";
TableVerifier* tv = dynamic_cast<TableVerifier*>(p.verifier.get());
if (tv) {
// We have a TableVerifier, so we need to recurse
html << "\t\t<td>" << generateHtmlDocumentation(tv->doc) << "</td>\n";
html << "<td><table cellpadding=3 cellspacing=0 border=1>\n"
<< "\t<thead>\n"
<< "\t\t<tr>\n"
<< "\t\t\t<th></th>\n"
<< "\t\t\t<th>Key</th>\n"
<< "\t\t\t<th>Optional</th>\n"
<< "\t\t\t<th>Type</th>\n"
<< "\t\t\t<th>Restrictions</th>\n"
<< "\t\t\t<th>Documentation</th>\n"
<< "\t\t</tr>\n"
<< "\t</thead>\n"
<< "\t<tbody>\n"
<< generateHtmlDocumentation(tv->doc)
<< "\t</tbody>\n"
<< "</table>\n"
<< "</td>\n";
}
else {
html << "\t\t<td>" << p.verifier->documentation() << "</td>\n";
}
html << "\t\t<td>" << p.documentation << "</td>\n"
<< "\t</tr>\n";
}
html << "\t</tbody>\n"
<< "</table>\n";
return html.str();
}
@@ -177,10 +184,32 @@ void DocumentationEngine::writeDocumentation(const std::string& f, const std::st
<< "\t</head>\n"
<< "<body>\n";
html << "<table cellpadding=3 cellspacing=0 border=1>\n"
<< "\t<caption>Documentation</caption>\n\n"
<< "\t<thead>\n"
<< "\t\t<tr>\n"
<< "\t\t\t<th rowspan=2>Name</th>\n"
<< "\t\t</tr>\n"
<< "\t\t<tr>\n"
<< "\t\t\t<th>Key</th>\n"
<< "\t\t\t<th>Optional</th>\n"
<< "\t\t\t<th>Type</th>\n"
<< "\t\t\t<th>Restrictions</th>\n"
<< "\t\t\t<th>Documentation</th>\n"
<< "\t\t</tr>\n"
<< "\t</thead>\n"
<< "\t<tbody>\n";
for (const Documentation& d : _documentations) {
html << generateHtmlDocumentation(d);
html << "\t<tr><td style=\"line-height: 50px;\" colspan=6></br></td></tr>\n";
}
html << "\t</tbody>\n"
<< "</table>\n";
html << "</body>\n";
html << "</html>\n";