phpdoc.ini 3.3 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788
  1. ;; phpDocumentor parse configuration file
  2. [Parse Data]
  3. ;; title of all the documentation
  4. ;; legal values: any string
  5. title = GitPHP Documentation
  6. ;; parse files that start with a . like .bash_profile
  7. ;; legal values: true, false
  8. hidden = false
  9. ;; show elements marked @access private in documentation by setting this to on
  10. ;; legal values: on, off
  11. parseprivate = on
  12. ;; parse with javadoc-like description (first sentence is always the short description)
  13. ;; legal values: on, off
  14. javadocdesc = off
  15. ;; add any custom @tags separated by commas here
  16. ;; legal values: any legal tagname separated by commas.
  17. ;customtags = mytag1,mytag2
  18. ;; This is only used by the XML:DocBook/peardoc2 converter
  19. defaultcategoryname = Documentation
  20. ;; what is the main package?
  21. ;; legal values: alphanumeric string plus - and _
  22. defaultpackagename = GitPHP
  23. ;; output any parsing information? set to on for cron jobs
  24. ;; legal values: on
  25. ;quiet = on
  26. ;; parse a PEAR-style repository. Do not turn this on if your project does
  27. ;; not have a parent directory named "pear"
  28. ;; legal values: on/off
  29. ;pear = on
  30. ;; where should the documentation be written?
  31. ;; legal values: a legal path
  32. ;target = /home/cellog/output
  33. target = doc/code
  34. ;; Which files should be parsed out as special documentation files, such as README,
  35. ;; INSTALL and CHANGELOG? This overrides the default files found in
  36. ;; phpDocumentor.ini (this file is not a user .ini file, but the global file)
  37. readmeinstallchangelog = AUTHORS, COPYING, README, TRANSLATING
  38. ;; limit output to the specified packages, even if others are parsed
  39. ;; legal values: package names separated by commas
  40. ;packageoutput = package1,package2
  41. ;; comma-separated list of files to parse
  42. ;; legal values: paths separated by commas
  43. filename = index.php
  44. ;; comma-separated list of directories to parse
  45. ;; legal values: directory paths separated by commas
  46. ;directory = /path1,/path2,.,..,subdirectory
  47. ;directory = /home/jeichorn/cvs/pear
  48. ;directory = /home/cellog/workspace/phpdoc
  49. directory = config,include,doc
  50. ;; template base directory (the equivalent directory of <installdir>/phpDocumentor)
  51. ;templatebase = /path/to/my/templates
  52. ;; directory to find any example files in through @example and {@example} tags
  53. ;examplesdir = /path/to/my/templates
  54. ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
  55. ;; legal values: any wildcard strings separated by commas
  56. ;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value
  57. ;ignore = path/to/ignore*,*list.php,myfile.php,subdirectory/
  58. ignore = pear-*,templates/,Documentation/,test*.php,Lexer.inc,gitphp.conf.php,projects.conf.php,block.t.php
  59. ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
  60. ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,
  61. ;; HTML:frames:earthli,
  62. ;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
  63. ;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
  64. ;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
  65. ;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
  66. output=HTML:frames:DOM/earthli
  67. ;; turn this option on if you want highlighted source code for every file
  68. ;; legal values: on/off
  69. sourcecode = off