build: add modified luadoc for use with LuCI sources
[project/luci.git] / contrib / luadoc / lua / luadoc / config.lua
1 -------------------------------------------------------------------------------
2 -- LuaDoc configuration file. This file contains the default options for 
3 -- luadoc operation. These options can be overriden by the command line tool
4 -- @see luadoc.print_help
5 -- @release $Id: config.lua,v 1.6 2007/04/18 14:28:39 tomas Exp $
6 -------------------------------------------------------------------------------
7
8 module "luadoc.config"
9
10 -------------------------------------------------------------------------------
11 -- Default options
12 -- @class table
13 -- @name default_options
14 -- @field output_dir default output directory for generated documentation, used
15 -- by several doclets
16 -- @field taglet parser used to analyze source code input
17 -- @field doclet documentation generator
18 -- @field template_dir directory with documentation templates, used by the html
19 -- doclet
20 -- @field verbose command line tool configuration to output processing 
21 -- information
22
23 local default_options = {
24         output_dir = "",
25         taglet = "luadoc.taglet.standard",
26         doclet = "luadoc.doclet.html",
27         -- TODO: find a way to define doclet specific options
28         template_dir = "luadoc/doclet/html/",
29         nomodules = false,
30         nofiles = false,
31         verbose = true,
32 }
33
34 return default_options