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

Issue #110; use '-u' or 'unqualified' explicitly to strip package names on sidebar (thanks to abadc0de)

This commit is contained in:
Steve Donovan 2013-11-27 09:50:38 +02:00
parent 46515b2411
commit 63e3618c05
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
ldoc.lua
View File

@ -52,6 +52,7 @@ ldoc, a documentation generator for Lua, vs 1.4.0
-b,--package (default .) top-level package basename (needed for module(...))
-x,--ext (default html) output file extension
-c,--config (default config.ld) configuration name
-u,--unqualified don't show package name in sidebar links
-i,--ignore ignore any 'no doc comment or no module' warnings
-X,--not_luadoc break LuaDoc compatibility. Descriptions may continue after tags.
-D,--define (default none) set a flag to be used in config.ld
@ -199,6 +200,7 @@ local ldoc_contents = {
'boilerplate','merge', 'wrap', 'not_luadoc', 'template_escape','merge_error_groups',
'no_return_or_parms','no_summary','full_description','backtick_references', 'custom_see_handler',
'no_space_before_args','parse_extra','no_lua_ref','sort_modules','use_markdown_titles',
'unqualified',
}
ldoc_contents = tablex.makeset(ldoc_contents)

2
ldoc/html.lua
View File

@ -97,7 +97,7 @@ function html.generate_output(ldoc, args, project)
function ldoc.module_name (mod)
local name = mod.name
if mod.type == 'module' then -- leave out package (also for 'classmod'??)
if args.unqualified and mod.type == 'module' then -- leave out package (also for 'classmod'??)
name = name:gsub('^.-%.','')
elseif mod.type == 'topic' then
if mod.display_name then