Aire-One
/
awesome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc(ltp): Implement module `extra-header` section 

Co-authored-by: Lucas Schwiderski <lucas@lschwiderski.de>
Co-authored-by: Aire-One <Aire-One@users.noreply.github.com>
This commit is contained in:
Emmanuel Lepage Vallee 2021-03-29 00:40:16 -07:00 committed by Aire-One
parent 90c4c60d2a
commit 25f4cfcb05
2 changed files with 54 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/ldoc.css
View File

@ -509,6 +509,10 @@ pre .url { color: #272fc2; text-decoration: underline; }
list-style: none;
}
.inheritance .inheritance__level--root {
padding-left: 0;
}
.inheritance .inheritance__level__node::before {
content: "↳";
}
@ -518,3 +522,13 @@ pre .url { color: #272fc2; text-decoration: underline; }
content: " ";
white-space: pre;
}
.extra-header {
display: flex;
flex-direction: row;
flex-wrap: wrap;
}
.extra-header__section {
flex-grow: 1;
}

66
docs/ldoc.ltp
View File

@ -184,17 +184,24 @@
<h1>Module: <code>$(module.name)</code></h1>
<p>$(M(module.summary,module))</p>
<p>$(M(module.description,module))</p>
# if module.usage then
# local li,il = use_li(module.usage)
<h3>Usage:</h3>
<ul>
# for usage in iter(module.usage) do
$(li)<pre class="example">$(ldoc.escape(usage))</pre>$(il)
# end -- for
</ul>
# end -- if usage
<div class="extra-header">
# if module.tags.supermodule or module.tags.knownusage then
<div class="extra-header__section">
<h3>Class Hierarchy</h3>
<div class="inheritance">
# local function draw_hierary_recursifly(i)
<ul class="inheritance__level">
# if i == #hierarchy then
<li class="inheritance__level__node inheritance__level__node inheritance__level__node--root">
# else
<li class="inheritance__level__node inheritance__level__node">
# end
# local is_root_level = (i == #hierarchy)
<ul class="inheritance__level $(is_root_level and 'inheritance__level--root' or '')">
<li class="inheritance__level__node $(is_root_level and 'inheritance__level__node--root' or '')">
# local mod = hierarchy[i]
# local name = display_name(hierarchy[i])
# if mod == module then
@ -209,7 +216,7 @@
</li>
# end
</ul>
# end
# end -- module.tags.supermodule
# draw_hierary_recursifly(#hierarchy)
</div>
# end
@ -217,32 +224,37 @@
# if module.tags.include then
$(M(ldoc.include_file(module.tags.include)))
# end
# if module.see then
# local li,il = use_li(module.see)
<h3>See also:</h3>
<ul>
# for see in iter(module.see) do
$(li)<a href="$(ldoc.href(see))">$(see.label)</a>$(il)
# end -- for
</ul>
# end -- if see
# if module.usage then
# local li,il = use_li(module.usage)
<h3>Usage:</h3>
<ul>
# for usage in iter(module.usage) do
$(li)<pre class="example">$(ldoc.escape(usage))</pre>$(il)
# end -- for
</ul>
# end -- if usage
</div>
# if module.info then
<div class="extra-header__section">
<h3>Info:</h3>
<ul>
# for tag, value in module.info:iter() do
<li><strong>$(tag)</strong>: $(M(value,module))</li>
# end
</ul>
</div>
# end -- if module.info
# if module.see then
<div class="extra-header__section">
# local li,il = use_li(module.see)
<h3>See also:</h3>
# if #module.see > 1 then
<ul>
# else
<p>
# end
# for see in iter(module.see) do
$(li)<a href="$(ldoc.href(see))">$(see.label)</a>$(il)
# end -- for
# if #module.see > 1 then
</ul>
# else
</p>
# end
</div>
# end -- if see
</div>
# if not ldoc.no_summary then
@ -275,7 +287,7 @@
# end
<td colspan="$(inherited and 1 or 2)" class="summary">$(M(item.summary,item))</td>
# if inherited then
<td class="baseclass" $(nowrap)>
<td class="baseclass" nowrap>
Inherited from $(item.baseclass)
</td>
# end