* luci/contrib: added support for constants documentation in luadoc
[project/luci.git] / contrib / luadoc / lua / luadoc / doclet / debug.lua
1 -----------------------------------------------------------------
2 -- LuaDoc debugging facilities.
3 -- @release $Id: debug.lua,v 1.3 2007/04/18 14:28:39 tomas Exp $
4 -----------------------------------------------------------------
5
6 module "luadoc.doclet.debug"
7
8 function printline()
9 print(string.rep('-', 79))
10 end
11
12 -----------------------------------------------------------------
13 -- Print debug information about document
14 -- @param doc Table with the structured documentation.
15
16 function start (doc)
17 print("Files:")
18 for _, filepath in ipairs(doc.files) do
19 print('\t', filepath)
20 end
21 printline()
22
23 print("Modules:")
24 for _, modulename in ipairs(doc.modules) do
25 print('\t', modulename)
26 end
27 printline()
28
29 for i, v in pairs(doc.files) do
30 print('\t', i, v)
31 end
32 printline()
33 for i, v in pairs(doc.files[doc.files[1]]) do
34 print(i, v)
35 end
36
37 printline()
38 for i, v in pairs(doc.files[doc.files[1]].doc[1]) do
39 print(i, v)
40 end
41 printline()
42 print("Params")
43 for i, v in pairs(doc.files[doc.files[1]].doc[1].param) do
44 print(i, v)
45 end
46 end