jsdoc.conf.json 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445
  1. {
  2. "opts": {
  3. "encoding": "utf8", // same as -e utf8
  4. "destination": "./o2web/jsdoc/", // same as -d ./out/
  5. "recurse": true, // same as -r
  6. "template" : "./node_modules/ink-docstrap/template"
  7. //"template": "templates/default" // same as -t templates/default
  8. // "tutorials": "path/to/tutorials" // same as -u path/to/tutorials
  9. },
  10. "tags": {
  11. "allowUnknownTags": true
  12. },
  13. "source": {
  14. "include": ["./o2web/source/x_component_process_Xform"],
  15. "includePattern": ".+\\.js(doc|x)?$",
  16. "excludePattern": "(^|\\/|\\\\)_"
  17. },
  18. "plugins": [
  19. "plugins/markdown",
  20. "plugins/summarize"
  21. ],
  22. "templates": {
  23. "cleverLinks": false,
  24. "monospaceLinks": false,
  25. "dateFormat": "YYYY-MM-dd",
  26. "outputSourceFiles": true,
  27. "outputSourcePath": true,
  28. "systemName": "O2前台组件API",
  29. "footer": "",
  30. "copyright": "o2 group",
  31. "navType": "vertical",
  32. "theme": "readable", //readable lumen cosmo
  33. "linenums": true,
  34. "collapseSymbols": false,
  35. "inverseNav": true,
  36. "protocol": "html://",
  37. "methodHeadingReturns": false
  38. },
  39. "markdown": {
  40. "parser": "gfm",
  41. "hardwrap": true
  42. }
  43. }
  44. //执行命令: jsdoc -c ./o2web/jsdoc.conf.json