summaryrefslogtreecommitdiffhomepage
path: root/contrib/luadoc/lua/luadoc/config.lua
blob: 9e4b9de3c56532cc45cc5a0e447716033fa38cab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
-------------------------------------------------------------------------------
-- LuaDoc configuration file. This file contains the default options for 
-- luadoc operation. These options can be overriden by the command line tool
-- @see luadoc.print_help
-- @release $Id: config.lua,v 1.6 2007/04/18 14:28:39 tomas Exp $
-------------------------------------------------------------------------------

module "luadoc.config"

-------------------------------------------------------------------------------
-- Default options
-- @class table
-- @name default_options
-- @field output_dir default output directory for generated documentation, used
-- by several doclets
-- @field taglet parser used to analyze source code input
-- @field doclet documentation generator
-- @field template_dir directory with documentation templates, used by the html
-- doclet
-- @field verbose command line tool configuration to output processing 
-- information

local default_options = {
	output_dir = "",
	taglet = "luadoc.taglet.standard",
	doclet = "luadoc.doclet.html",
	-- TODO: find a way to define doclet specific options
	template_dir = "luadoc/doclet/html/",
	nomodules = false,
	nofiles = false,
	verbose = true,
}

return default_options