Codebase list lua-ldoc / 4ab5f07
1.4.3 release patches steve donovan 9 years ago
3 changed file(s) with 71 addition(s) and 7 deletion(s). Raw diff Collapse all Expand all
1717 Otherwise, the output is very similar, which is no accident since the HTML templates are
1818 based directly on LuaDoc. You can ship your own customized templates and style sheets with
1919 your [own project](http://nilnor.github.com/textui/docs/) (also see Graham Hannington's
20 documentation for [Lua for z/OS](lua4z.com/doc/)). LDoc comes with three extra themes; 'pale'
20 documentation for [Lua for z/OS](http://lua4z.com/doc/)). LDoc comes with three extra themes; 'pale'
2121 for those who like whitespace, 'one' for one-column output, and 'fixed' for a fixed navigation
2222 bar down the left side.
2323
0 package = "ldoc"
1 version = "1.4.3-1"
2
3 source = {
4 dir = "ldoc",
5 url = "http://mysite.mweb.co.za/residents/sdonovan/ldoc-1.4.3.zip"
6 }
7
8 description = {
9 summary = "A Lua Documentation Tool",
10 detailed = [[
11 LDoc is a LuaDoc-compatible documentation generator which can also
12 process C extension source. Markdown may be optionally used to
13 render comments, as well as integrated readme documentation and
14 pretty-printed example files
15 ]],
16 homepage='http://stevedonovan.github.com/ldoc',
17 maintainer='steve.j.donovan@gmail.com',
18 license = "MIT/X11",
19 }
20
21 dependencies = {
22 "penlight","markdown"
23 }
24
25 build = {
26 type = "builtin",
27 modules = {
28 ["ldoc.tools"] = "ldoc/tools.lua",
29 ["ldoc.lang"] = "ldoc/lang.lua",
30 ["ldoc.parse"] = "ldoc/parse.lua",
31 ["ldoc.html"] = "ldoc/html.lua",
32 ["ldoc.lexer"] = "ldoc/lexer.lua",
33 ["ldoc.markup"] = "ldoc/markup.lua",
34 ["ldoc.prettify"] = "ldoc/prettify.lua",
35 ["ldoc.markdown"] = "ldoc/markdown.lua",
36 ["ldoc.doc"] = "ldoc/doc.lua",
37 ["ldoc.html.ldoc_ltp"] = "ldoc/html/ldoc_ltp.lua",
38 ["ldoc.html.ldoc_md_ltp"] = "ldoc/html/ldoc_md_ltp.lua",
39 ["ldoc.html.ldoc_css"] = "ldoc/html/ldoc_css.lua",
40 ["ldoc.html.ldoc_one_css"] = "ldoc/html/ldoc_one_css.lua",
41 ["ldoc.html.ldoc_pale_css"] = "ldoc/html/ldoc_pale_css.lua",
42 ["ldoc.html.ldoc_fixed_css"] = "ldoc/html/ldoc_fixed_css.lua",
43 ["ldoc.builtin.globals"] = "ldoc/builtin/globals.lua",
44 ["ldoc.builtin.coroutine"] = "ldoc/builtin/coroutine.lua",
45 ["ldoc.builtin.global"] = "ldoc/builtin/global.lua",
46 ["ldoc.builtin.debug"] = "ldoc/builtin/debug.lua",
47 ["ldoc.builtin.io"] = "ldoc/builtin/io.lua",
48 ["ldoc.builtin.lfs"] = "ldoc/builtin/lfs.lua",
49 ["ldoc.builtin.lpeg"] = "ldoc/builtin/lpeg.lua",
50 ["ldoc.builtin.math"] = "ldoc/builtin/math.lua",
51 ["ldoc.builtin.os"] = "ldoc/builtin/os.lua",
52 ["ldoc.builtin.package"] = "ldoc/builtin/package.lua",
53 ["ldoc.builtin.string"] = "ldoc/builtin/string.lua",
54 ["ldoc.builtin.table"] = "ldoc/builtin/table.lua",
55 },
56 copy_directories = {'doc','tests'},
57 install = {
58 bin = {
59 ldoc = "ldoc.lua"
60 }
61 }
62 }
63
66 --
77 -- C/C++ support for Lua extensions is provided.
88 --
9 -- Available from LuaRocks as 'ldoc' and as a [Zip file](http://stevedonovan.github.com/files/ldoc-1.4.2.zip)
9 -- Available from LuaRocks as 'ldoc' and as a [Zip file](http://stevedonovan.github.com/files/ldoc-1.4.3.zip)
1010 --
1111 -- [Github Page](https://github.com/stevedonovan/ldoc)
1212 --
463463
464464 if type(args.file) == 'table' then
465465 -- this can only be set from config file so we can assume config is already read
466 process_all_files(args.file)
467
466 process_all_files(args.file)
467
468468 elseif path.isdir(args.file) then
469469 -- use any configuration file we find, if not already specified
470470 if not config_dir then
479479 end
480480 end
481481 end
482
482
483483 process_all_files({args.file})
484
484
485485 elseif path.isfile(args.file) then
486486 -- a single file may be accompanied by a config.ld in the same dir
487487 if not config_dir then
527527 return item, F
528528 end
529529
530 local function prettify_source_files(files,class,linemap)
530 local function prettify_source_files(files,class,linemap)
531531 local prettify = require 'ldoc.prettify'
532532
533533 process_file_list (files, '*.*', function(f)