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 (a] users.sourceforge.net> 13 ;; 14 ;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them 15 16 [Parse Data] 17 ;; title of all the documentation 18 ;; legal values: any string 19 title = GeSHi 1.0.8 20 21 ;; parse files that start with a . like .bash_profile 22 ;; legal values: true, false 23 hidden = false 24 25 ;; show elements marked @access private in documentation by setting this to on 26 ;; legal values: on, off 27 parseprivate = off 28 29 ;; parse with javadoc-like description (first sentence is always the short description) 30 ;; legal values: on, off 31 javadocdesc = off 32 33 ;; add any custom @tags separated by commas here 34 ;; legal values: any legal tagname separated by commas. 35 customtags = note 36 37 ;; This is only used by the XML:DocBook/peardoc2 converter 38 defaultcategoryname = Documentation 39 40 ;; what is the main package? 41 ;; legal values: alphanumeric string plus - and _ 42 defaultpackagename = core 43 44 ;; output any parsing information? set to on for cron jobs 45 ;; legal values: on 46 ;quiet = on 47 48 ;; parse a PEAR-style repository. Do not turn this on if your project does 49 ;; not have a parent directory named "pear" 50 ;; legal values: on/off 51 ;pear = on 52 53 ;; where should the documentation be written? 54 ;; legal values: a legal path 55 target = api 56 57 ;; limit output to the specified packages, even if others are parsed 58 ;; legal values: package names separated by commas 59 ;packageoutput = package1,package2 60 61 ;; comma-separated list of files to parse 62 ;; legal values: paths separated by commas 63 filename = ../geshi.php 64 65 ;; comma-separated list of directories to parse 66 ;; legal values: directory paths separated by commas 67 ;directory = /path1,/path2,.,..,subdirectory 68 ;directory = /home/jeichorn/cvs/pear 69 ;directory = geshi 70 71 ;; template base directory (the equivalent directory of <installdir>/phpDocumentor) 72 ;templatebase = /path/to/my/templates 73 74 ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore 75 ;; legal values: any wildcard strings separated by commas 76 ;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/ 77 ignore = /*.svn/* 78 79 ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format 80 ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib, 81 ;; HTML:frames:earthli, 82 ;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de, 83 ;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli 84 ;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS 85 ;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default 86 output=HTML:frames:earthli 87 88 ;; turn this option on if you want highlighted source code for every file 89 ;; legal values: on/off 90 sourcecode = on 91
