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

Allow brief project description to be specified on command line

This commit is contained in:
cjtallman 2015-06-12 08:49:06 -07:00
parent 2241932602
commit a6965e3e0b
2 changed files with 3 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/doc.md
View File

@ -1215,6 +1215,7 @@ _Same meaning as the corresponding parameters:_
of files and directories. of files and directories.
- `project` name of project, used as title in top left - `project` name of project, used as title in top left
- `title` page title, default 'Reference' - `title` page title, default 'Reference'
- `description` a short project description used under the project title
- `package ` explicit base package name; also used for resolving references in documents - `package ` explicit base package name; also used for resolving references in documents
- `all` show local functions, etc as well in the docs - `all` show local functions, etc as well in the docs
- `format` markup processor, can be 'plain' (default), 'markdown' or 'discount' - `format` markup processor, can be 'plain' (default), 'markdown' or 'discount'
@ -1232,7 +1233,6 @@ explicit **@submodule** tag
_These only appear in the configuration file:_ _These only appear in the configuration file:_
- `description` a short project description used under the project title
- `full_description` when you _really_ need a longer project description - `full_description` when you _really_ need a longer project description
- `examples` a directory or file: can be a table - `examples` a directory or file: can be a table
- `readme` or `topics` readme files (to be processed with Markdown) - `readme` or `topics` readme files (to be processed with Markdown)

2
ldoc.lua
View File

@ -61,6 +61,7 @@ ldoc, a documentation generator for Lua, vs 1.4.3
-M,--merge allow module merging -M,--merge allow module merging
-S,--simple no return or params, no summary -S,--simple no return or params, no summary
-O,--one one-column output layout -O,--one one-column output layout
--description (default none) project description
--dump debug output dump --dump debug output dump
--filter (default none) filter output as Lua data (e.g pl.pretty.dump) --filter (default none) filter output as Lua data (e.g pl.pretty.dump)
--tags (default none) show all references to given tags, comma-separated --tags (default none) show all references to given tags, comma-separated
@ -780,6 +781,7 @@ ldoc.log = print
ldoc.kinds = project ldoc.kinds = project
ldoc.modules = module_list ldoc.modules = module_list
ldoc.title = ldoc.title or args.title ldoc.title = ldoc.title or args.title
ldoc.description = ldoc.description or utils.choose(args.description ~= "none", args.description);
ldoc.project = ldoc.project or args.project ldoc.project = ldoc.project or args.project
ldoc.package = args.package:match '%a+' and args.package or nil ldoc.package = args.package:match '%a+' and args.package or nil
ldoc.updatetime = os.date("%Y-%m-%d %H:%M:%S") ldoc.updatetime = os.date("%Y-%m-%d %H:%M:%S")