config.lua 1.2 KB

12345678910111213141516171819202122232425262728293031323334
  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. module "luadoc.config"
  8. -------------------------------------------------------------------------------
  9. -- Default options
  10. -- @class table
  11. -- @name default_options
  12. -- @field output_dir default output directory for generated documentation, used
  13. -- by several doclets
  14. -- @field taglet parser used to analyze source code input
  15. -- @field doclet documentation generator
  16. -- @field template_dir directory with documentation templates, used by the html
  17. -- doclet
  18. -- @field verbose command line tool configuration to output processing
  19. -- information
  20. local default_options = {
  21. output_dir = "",
  22. taglet = "luadoc.taglet.standard",
  23. doclet = "luadoc.doclet.html",
  24. -- TODO: find a way to define doclet specific options
  25. template_dir = "luadoc/doclet/html/",
  26. nomodules = false,
  27. nofiles = false,
  28. verbose = true,
  29. }
  30. return default_options