You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

phpdoc.ini 3.9KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102
  1. ;; phpDocumentor parse configuration file
  2. ;;
  3. ;; This file is designed to cut down on repetitive typing on the command-line or web interface
  4. ;; You can copy this file to create a number of configuration files that can be used with the
  5. ;; command-line switch -c, as in phpdoc -c default.ini or phpdoc -c myini.ini. The web
  6. ;; interface will automatically generate a list of .ini files that can be used.
  7. ;;
  8. ;; default.ini is used to generate the online manual at http://www.phpdoc.org/docs
  9. ;;
  10. ;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini
  11. ;;
  12. ;; Copyright 2002, Greg Beaver <cellog@users.sourceforge.net>
  13. ;;
  14. ;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them
  15. [Parse Data]
  16. ;; title of all the documentation
  17. ;; legal values: any string
  18. title = HTML Purifier API Documentation
  19. ;; parse files that start with a . like .bash_profile
  20. ;; legal values: true, false
  21. hidden = false
  22. ;; show elements marked @access private in documentation by setting this to on
  23. ;; legal values: on, off
  24. parseprivate = off
  25. ;; parse with javadoc-like description (first sentence is always the short description)
  26. ;; legal values: on, off
  27. javadocdesc = on
  28. ;; add any custom @tags separated by commas here
  29. ;; legal values: any legal tagname separated by commas.
  30. ;customtags = mytag1,mytag2
  31. ;; This is only used by the XML:DocBook/peardoc2 converter
  32. defaultcategoryname = Documentation
  33. ;; what is the main package?
  34. ;; legal values: alphanumeric string plus - and _
  35. defaultpackagename = HTMLPurifier
  36. ;; output any parsing information? set to on for cron jobs
  37. ;; legal values: on
  38. ;quiet = on
  39. ;; parse a PEAR-style repository. Do not turn this on if your project does
  40. ;; not have a parent directory named "pear"
  41. ;; legal values: on/off
  42. ;pear = on
  43. ;; where should the documentation be written?
  44. ;; legal values: a legal path
  45. target = docs/phpdoc
  46. ;; Which files should be parsed out as special documentation files, such as README,
  47. ;; INSTALL and CHANGELOG? This overrides the default files found in
  48. ;; phpDocumentor.ini (this file is not a user .ini file, but the global file)
  49. readmeinstallchangelog = README, INSTALL, NEWS, WYSIWYG, SLOW, LICENSE, CREDITS
  50. ;; limit output to the specified packages, even if others are parsed
  51. ;; legal values: package names separated by commas
  52. ;packageoutput = package1,package2
  53. ;; comma-separated list of files to parse
  54. ;; legal values: paths separated by commas
  55. ;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
  56. ;; comma-separated list of directories to parse
  57. ;; legal values: directory paths separated by commas
  58. ;directory = /path1,/path2,.,..,subdirectory
  59. ;directory = /home/jeichorn/cvs/pear
  60. directory = .
  61. ;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
  62. ;templatebase = /path/to/my/templates
  63. ;; directory to find any example files in through @example and {@example} tags
  64. ;examplesdir = /path/to/my/templates
  65. ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
  66. ;; legal values: any wildcard strings separated by commas
  67. ;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/
  68. ignore = *tests*,*benchmarks*,*docs*,*test-settings.php,*configdoc*,*maintenance*,*smoketests*,*standalone*,*.svn*,*conf*
  69. sourcecode = on
  70. ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
  71. ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
  72. ;; HTML:frames:earthli,
  73. ;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
  74. ;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
  75. ;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
  76. ;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
  77. output=HTML:frames:default
  78. ;; turn this option on if you want highlighted source code for every file
  79. ;; legal values: on/off
  80. sourcecode = on
  81. ; vim: et sw=4 sts=4