ecommun / owncloud_ynh

Blame view

sources/apps/files_external/3rdparty/irodsphp/prods/doc_config.ini 3.22 KB
edit raw normal view history
03e52840d   Kload   Init 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
  ;; phpDocumentor demonstration parse configuration file
  ;;
  ;; RUN THIS FILE FROM THE INSTALL DIRECTORY
  ;; CHANGE HERE:
  
  ;; where should the documentation be written?
  ;; legal values: a legal path
  ;target = /home/CelloG/output
  target = ./doc
  
  
  ;; DONT CHANGE BELOW HERE
  ;;
  ;; This file is designed to cut down on repetitive typing on the command-line or web interface
  ;; You can copy this file to create a number of configuration files that can be used with the
  ;; command-line switch -c, as in phpdoc -c default.ini or phpdoc -c myini.ini.  The web
  ;; interface will automatically generate a list of .ini files that can be used.
  ;;
  ;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini
  ;;
  ;; Copyright 2002, Greg Beaver <cellog@php.net>
  ;;
  ;; WARNING: do not change the 
  
  [Parse Data]
  ;; title of all the documentation
  ;; legal values: any string
  title = PRODS (iRODS PHP Client API) Documentation
  
  ;; parse files that start with a . like .bash_profile
  ;; legal values: true, false
  hidden = false
  
  ;; show elements marked @access private in documentation by setting this to on
  ;; legal values: on, off
  parseprivate = off
  
  ;; parse with javadoc-like description (first sentence is always the short description)
  ;; legal values: on, off
  javadocdesc = on
  
  ;target=/dev/null
  
  ;; add any custom @tags separated by commas here
  ;; legal values: any legal tagname separated by commas.
  ;customtags = mytag1,mytag2
  
  ;; what is the main package?
  ;; legal values: alphanumeric string plus - and _
  defaultpackagename = Prods
  
  ;; output any parsing information?  set to on for cron jobs
  ;; legal values: on
  ;quiet = on
  
  ;; limit output to the specified packages, even if others are parsed
  ;; legal values: package names separated by commas
  ;packageoutput = package1,package2
  
  ;; comma-separated list of files to parse
  ;; legal values: paths separated by commas
  ;filename = /path/to/file1,/path/to/file2,fileincurrentdirectory
  
  ;; comma-separated list of directories to parse
  ;; legal values: directory paths separated by commas
  ;directory = /path1,/path2,.,..,subdirectory
  ;directory = /home/jeichorn/cvs/pear
  ;directory = /you-MUST/change-me/to-fit/your-environment
  ;directory = .
  
  directory = ./src,./tutorials
  
  ;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
  ;; legal values: any wildcard strings separated by commas
  ;; remember, this pathing is RELATIVE to the top-most directory in your "directory" value
  ;ignore = path/to/ignore*,*list.php,myfile.php,subdirectory/
  ignore = templates_c/,*HTML/default/*,spec/,*.inc.php,packet/,set*.php,ProdsStreamer.class.php,RODSMessage.class.php,RODSConn.class.php,RODSKeyValPair.class.php,RODSConnManager.class.php  
  
  ;; comma-separated list of Converters to use in outputformat:Convertername:templatedirectory format
  ;; legal values: HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib
  ;;               HTML:frames:phpedit,HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de
  ;;               HTML:Smarty:default,HTML:Smarty:PHP,PDF:default:default,CHM:default:default,XML:DocBook:default
  output=HTML:Smarty:PHP
  
  ;; turn this option on if you want highlighted source code for every file
  ;; legal values: on/off
  sourcecode = on