can now use package field in config.ld. tests/luadoc contains a suitable setup for processing LuaDoc itself correctly
This commit is contained in:
parent
5387084565
commit
f2fc6f1604
5
ldoc.lua
5
ldoc.lua
|
@ -373,6 +373,8 @@ end
|
|||
-- * 'NAME' explicitly give the base module package name
|
||||
--
|
||||
|
||||
local function setup_package_base()
|
||||
if ldoc.package then args.package = ldoc.package end
|
||||
if args.package == '.' then
|
||||
args.package = source_dir
|
||||
elseif args.package == '..' then
|
||||
|
@ -387,6 +389,7 @@ elseif not args.package:find '[\//]' then
|
|||
quit("args.package is not the name of the source directory")
|
||||
end
|
||||
end
|
||||
end
|
||||
|
||||
local lua, cc = lang.lua, lang.cc
|
||||
|
||||
|
@ -417,6 +420,7 @@ if path.isdir(args.file) then
|
|||
if #config_files > 0 and not config_dir then
|
||||
config_dir = read_ldoc_config(config_files[1])
|
||||
end
|
||||
setup_package_base()
|
||||
|
||||
for f in files:iter() do
|
||||
local ext = path.extension(f)
|
||||
|
@ -441,6 +445,7 @@ elseif path.isfile(args.file) then
|
|||
read_ldoc_config(config)
|
||||
end
|
||||
end
|
||||
setup_package_base()
|
||||
local ext = path.extension(args.file)
|
||||
local ftype = file_types[ext]
|
||||
if not ftype then quit "unsupported extension" end
|
||||
|
|
|
@ -0,0 +1,4 @@
|
|||
project = 'LuaDoc'
|
||||
title = "LuaDoc with LDoc"
|
||||
package = 'luadoc'
|
||||
file = [[c:\users\steve\luadist\share\lua\lmod\luadoc]]
|
|
@ -1,5 +1,16 @@
|
|||
-- this module has a comment.
|
||||
-- But it's not a doc comment!
|
||||
--- this module has a comment.
|
||||
|
||||
local local_two
|
||||
|
||||
--- a local function
|
||||
local function local_one ()
|
||||
end
|
||||
|
||||
--- a local function, needing explicit tag.
|
||||
-- @local here
|
||||
function local_two ()
|
||||
|
||||
end
|
||||
|
||||
--- A problem function.
|
||||
-- @param p a parameter
|
||||
|
|
Loading…
Reference in New Issue