| 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 | ;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini |
|---|
| 9 | ;; |
|---|
| 10 | ;; Copyright 2002, Greg Beaver <cellog@users.sourceforge.net> |
|---|
| 11 | ;; |
|---|
| 12 | ;; WARNING: do not change the |
|---|
| 13 | |
|---|
| 14 | [Parse Data] |
|---|
| 15 | ;; title of all the documentation |
|---|
| 16 | ;; legal values: any string |
|---|
| 17 | title = Simple SMS Component for Joomla |
|---|
| 18 | |
|---|
| 19 | ;; parse files that start with a . like .bash_profile |
|---|
| 20 | ;; legal values: true, false |
|---|
| 21 | hidden = false |
|---|
| 22 | |
|---|
| 23 | ;; show elements marked @access private in documentation by setting this to on |
|---|
| 24 | ;; legal values: on, off |
|---|
| 25 | parseprivate = off |
|---|
| 26 | |
|---|
| 27 | ;; parse with javadoc-like description (first sentence is always the short description) |
|---|
| 28 | ;; legal values: on, off |
|---|
| 29 | javadocdesc = off |
|---|
| 30 | |
|---|
| 31 | ;; add any custom @tags separated by commas here |
|---|
| 32 | ;; legal values: any legal tagname separated by commas. |
|---|
| 33 | ;customtags = mytag1,mytag2 |
|---|
| 34 | |
|---|
| 35 | ;; what is the main package? |
|---|
| 36 | ;; legal values: alphanumeric string plus - and _ |
|---|
| 37 | defaultpackagename = com_mysms_unknown_package |
|---|
| 38 | |
|---|
| 39 | ;; output any parsing information? set to on for cron jobs |
|---|
| 40 | ;; legal values: on |
|---|
| 41 | ;quiet = on |
|---|
| 42 | |
|---|
| 43 | ;; where should the documentation be written? |
|---|
| 44 | ;; legal values: a legal path |
|---|
| 45 | target = "C:/Projekte/OpenSource/Joomla/1.0/components/com_mysms/svn/doc/api/" |
|---|
| 46 | |
|---|
| 47 | ;; limit output to the specified packages, even if others are parsed |
|---|
| 48 | ;; legal values: package names separated by commas |
|---|
| 49 | ;packageoutput = package1,package2 |
|---|
| 50 | |
|---|
| 51 | ;; comma-separated list of files to parse |
|---|
| 52 | ;; legal values: paths separated by commas |
|---|
| 53 | ;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory |
|---|
| 54 | |
|---|
| 55 | ;; comma-separated list of directories to parse |
|---|
| 56 | ;; legal values: directory paths separated by commas |
|---|
| 57 | ;directory = /path1,/path2,.,..,subdirectory |
|---|
| 58 | ;directory = /home/jeichorn/cvs/pear |
|---|
| 59 | ;directory = /you-MUST/change-me/to-fit/your-environment |
|---|
| 60 | directory = "c:/Projekte/OpenSource/Joomla/1.0/components/com_mysms/svn/components/com_mysms/,c:/Projekte/OpenSource/Joomla/1.0/components/com_mysms/svn/administrator/components/com_mysms/,c:/Projekte/OpenSource/Joomla/1.0/components/com_mysms/svn/administrator/components/com_mysms/provider/" |
|---|
| 61 | |
|---|
| 62 | ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore |
|---|
| 63 | ;; legal values: any wildcard strings separated by commas |
|---|
| 64 | ;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/ |
|---|
| 65 | ignore = "c:/Projekte/OpenSource/Joomla/1.0/components/com_mysms/svn/administrator/components/com_mysms/lang/" |
|---|
| 66 | |
|---|
| 67 | ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format |
|---|
| 68 | ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib |
|---|
| 69 | ;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,HTML:Smarty:default |
|---|
| 70 | ;; HTML:Smarty:PHP,HTML:Smarty:HandS,PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default |
|---|
| 71 | output=HTML:frames:phpedit |
|---|