PageRenderTime 38ms CodeModel.GetById 22ms RepoModel.GetById 0ms app.codeStats 0ms

/tags/jsdoc_toolkit-1.3.3/examples/sample.conf

http://jsdoc-toolkit.googlecode.com/
Unknown | 32 lines | 24 code | 8 blank | 0 comment | 0 complexity | fc4a2066539447ad24de24f5a27bf08d MD5 | raw file
  1. /*
  2. This is an example of one way you could set up a configuration file to more
  3. conveniently define some commandline options. You might like to do this if
  4. you frequently reuse the same options. Note that you don't need to define
  5. every option in this file, you can combine a configuration file with
  6. additional options on the commandline if your wish.
  7. You would include this configuration file by running JsDoc Toolkit like so:
  8. java -jar app/js.jar app/run.js -c=sample.conf
  9. This would be equivalent to the following:
  10. java -jar app/js.jar app/run.js -a -D="generatedBy:Michael Mathews" -D="copyright:2007" -d=docs -t=templates/sweet app/
  11. See http://code.google.com/p/jsdoc-toolkit/wiki/CmdlineOptions for more.
  12. */
  13. {
  14. // source files to use
  15. _: ['app/'],
  16. // document all functions, even uncommented ones
  17. a: true,
  18. // some extra variables I want to include
  19. D: {generatedBy: "Michael Mathews", copyright: "2007"},
  20. // use this directory as the output directory
  21. d: "docs",
  22. // use this template
  23. t: "templates/sweet"
  24. }