sample.conf 898 B

12345678910111213141516171819202122232425262728293031
  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 jsrun.jar app/run.js -c=conf/sample.conf
  9. */
  10. {
  11. // source files to use
  12. _: ['app/test/jsdoc_test.js'],
  13. // document all functions, even uncommented ones
  14. a: true,
  15. // including those marked @private
  16. p: true,
  17. // some extra variables I want to include
  18. D: {generatedBy: "Michael Mathews", copyright: "2008"},
  19. // use this directory as the output directory
  20. d: "docs",
  21. // use this template
  22. t: "templates/jsdoc"
  23. }