doc: Modify the template to allow merging sections.

It might not be the most pretty of change, but it works. With this
change, it is possible to have multiple "things" in the "same"
section having the "same" name.

This allows for C/C++ style functions with the same name but different
signatures. Lua doesn't handle this well, so it should usually be
avoided. However, constructors might be a valid exception. Most older
widget (and object) constructors have multiple random argument while
newer one use `args`. Deprecating the old ones for the sake of
standardization might be a bit too much for users upgrading from v3.5.

Given the only reason all of those deprecation would happen is because
"its pretty that way", then lets allow 2 constructors and avoid outrage.
This commit is contained in:
Emmanuel Lepage Vallee 2019-10-27 15:39:23 -04:00
parent 0297bfff9a
commit 4dbc83fa7d
5 changed files with 45 additions and 19 deletions

View File

@ -54,6 +54,7 @@ tparam_alias('screen_or_idx', 'screen|int')
-- The first stereotype are the constructors. -- The first stereotype are the constructors.
new_type("constructorfct", "Constructors", false, "Parameters") new_type("constructorfct", "Constructors", false, "Parameters")
new_type("constructorfct2", "ldoc_skip", false, "Parameters")
-- Hack to get the functions on top of the signals and properties -- Hack to get the functions on top of the signals and properties
new_type("function", "Functions", false, "Parameters") new_type("function", "Functions", false, "Parameters")
-- For "classes", use an explicit type for static functions. This allows -- For "classes", use an explicit type for static functions. This allows
@ -100,6 +101,7 @@ sort_modules=true
-- Add more project level (left side index) types. -- Add more project level (left side index) types.
new_type("coreclassmod", "Core_components" , true) new_type("coreclassmod", "Core_components" , true)
new_type("inputmodule" , "Input handling" , true)
new_type("widgetmod" , "Widgets" , true) new_type("widgetmod" , "Widgets" , true)
new_type("containermod", "Widget_containers", true) new_type("containermod", "Widget_containers", true)
new_type("layoutmod" , "Widget_layouts" , true) new_type("layoutmod" , "Widget_layouts" , true)
@ -266,6 +268,7 @@ local coreclassmap = {
local add_mod = { local add_mod = {
["function"] = true, ["function"] = true,
constructorfct = true, constructorfct = true,
constructorfct2 = true,
staticfct = true, staticfct = true,
deprecated = true, deprecated = true,
field = true, field = true,
@ -274,6 +277,7 @@ local add_mod = {
-- Add the arguments. -- Add the arguments.
local add_args = { local add_args = {
constructorfct = true, constructorfct = true,
constructorfct2 = true,
staticfct = true, staticfct = true,
} }
@ -289,6 +293,7 @@ local display_type = {
local show_return = { local show_return = {
["function"] = true, ["function"] = true,
constructorfct = true, constructorfct = true,
constructorfct2 = true,
staticfct = true, staticfct = true,
method = true, method = true,
deprecated = true, deprecated = true,

View File

@ -49,22 +49,28 @@
<h2>Contents</h2> <h2>Contents</h2>
<ul> <ul>
# for kind,items in module.kinds() do # for kind,items in module.kinds() do
# if not kind:match("^ldoc_skip") then
<li><a href="#$(no_spaces(kind))">$(kind)</a></li> <li><a href="#$(no_spaces(kind))">$(kind)</a></li>
# end # end
# end
</ul> </ul>
# end # end
# if ldoc.no_summary and module and not ldoc.one then -- bang out the functions on the side # if ldoc.no_summary and module and not ldoc.one then -- bang out the functions on the side
# for kind, items in module.kinds() do # for kind, items in module.kinds() do
<h2>$(kind)</h2> # if not kind:match("^ldoc_skip") then
<h2>$(kind)dasdasd</h2>
<ul class="nowrap"> <ul class="nowrap">
# end
# for item in items() do # for item in items() do
<li><a href="#$(item.name)">$(display_name(item))</a></li> <li><a href="#$(item.name)">$(display_name(item))</a></li>
# end # end
# if not kind:match("^ldoc_skip") then
</ul> </ul>
# end # end
# end # end
# end
# -------- contents of project ---------- # -------- contents of project ----------
# local this_mod = module and module.name # local this_mod = module and module.name
# for kind, mods, type in ldoc.kinds() do # for kind, mods, type in ldoc.kinds() do
@ -125,9 +131,15 @@
# if not ldoc.no_summary then # if not ldoc.no_summary then
# -- bang out the tables of item types for this module (e.g Functions, Tables, etc) # -- bang out the tables of item types for this module (e.g Functions, Tables, etc)
# local last_kind = ""
# for kind,items in module.kinds() do # for kind,items in module.kinds() do
# if not kind:match("^ldoc_skip") then
# if last_kind ~= "" then
</table>
# end
<h2><a href="#$(no_spaces(kind))">$(kind)</a></h2> <h2><a href="#$(no_spaces(kind))">$(kind)</a></h2>
<table class="function_list"> <table class="function_list">
# end
# for item in items() do # for item in items() do
# local dn = display_name(item) # local dn = display_name(item)
# if item.sanitize_type then item.sanitize_type(item, ldoc) end # if item.sanitize_type then item.sanitize_type(item, ldoc) end
@ -141,8 +153,9 @@
<td class="summary">$(M(item.summary,item))</td> <td class="summary">$(M(item.summary,item))</td>
</tr> </tr>
# end -- for items # end -- for items
</table> # last_kind = kind
#end -- for kinds #end -- for kinds
</table>
<br/> <br/>
<br/> <br/>
@ -152,11 +165,16 @@
# --- currently works for both Functions and Tables. The params field either contains # --- currently works for both Functions and Tables. The params field either contains
# --- function parameters or table fields. # --- function parameters or table fields.
# local show_return = not ldoc.no_return_or_parms # local show_return = not ldoc.no_return_or_parms
# local show_parms = show_return # local show_parms, last_kind = show_return, ""
# for kind, items in module.kinds() do # for kind, items in module.kinds() do
# local kitem = module.kinds:get_item(kind) # local kitem = module.kinds:get_item(kind)
# local has_description = kitem and ldoc.descript(kitem) ~= "" # local has_description = kitem and ldoc.descript(kitem) ~= ""
# if not kind:match("^ldoc_skip") then
# if last_kind ~= "" then
</dl>
# end
<h2 class="section-header $(has_description and 'has-description')"><a name="$(no_spaces(kind))"></a>$(kind)</h2> <h2 class="section-header $(has_description and 'has-description')"><a name="$(no_spaces(kind))"></a>$(kind)</h2>
# end
$(M(module.kinds:get_section_description(kind),nil)) $(M(module.kinds:get_section_description(kind),nil))
# if kitem then # if kitem then
# if has_description then # if has_description then
@ -169,7 +187,9 @@
<pre class="example">$(ldoc.prettify(kitem.usage[1]))</pre> <pre class="example">$(ldoc.prettify(kitem.usage[1]))</pre>
# end # end
# end # end
# if not kind:match("^ldoc_skip") then
<dl class="function"> <dl class="function">
# end
# for item in items() do # for item in items() do
<dt> <dt>
<a name = "$(item.name)"></a> <a name = "$(item.name)"></a>
@ -289,8 +309,9 @@
</dd> </dd>
# end -- for items # end -- for items
</dl> # last_kind = kind
# end -- for kinds # end -- for kinds
</dl>
# else -- if module; project-level contents # else -- if module; project-level contents

View File

@ -3,7 +3,7 @@
-- --
-- @author Julien Danjou &lt;julien@danjou.info&gt; -- @author Julien Danjou &lt;julien@danjou.info&gt;
-- @copyright 2009 Julien Danjou -- @copyright 2009 Julien Danjou
-- @classmod awful.button -- @inputmodule awful.button
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
-- Grab environment we need -- Grab environment we need

View File

@ -3,7 +3,7 @@
-- --
-- @author Julien Danjou &lt;julien@danjou.info&gt; -- @author Julien Danjou &lt;julien@danjou.info&gt;
-- @copyright 2009 Julien Danjou -- @copyright 2009 Julien Danjou
-- @classmod awful.key -- @inputmodule awful.key
--------------------------------------------------------------------------- ---------------------------------------------------------------------------
-- Grab environment we need -- Grab environment we need

View File

@ -57,7 +57,7 @@
* *
* @author Julien Danjou &lt;julien@danjou.info&gt; * @author Julien Danjou &lt;julien@danjou.info&gt;
* @copyright 2008-2009 Julien Danjou * @copyright 2008-2009 Julien Danjou
* @coreclassmod mouse * @inputmodule mouse
*/ */
#include "mouse.h" #include "mouse.h"