YuCheng Hu
8378d06738
+YUCHENG HU+ git-svn-id: https://svn.code.sf.net/p/hawebs/svn@429 a2543c7e-f6e9-4f8a-8bff-1ffc34733512
65 lines
2.5 KiB
INI
65 lines
2.5 KiB
INI
[Parse Data]
|
|
;; title of all the documentation
|
|
;; legal values: any string
|
|
title = Piwik 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 = on
|
|
|
|
;; parse with javadoc-like description (first sentence is always the short description)
|
|
;; legal values: on, off
|
|
javadocdesc = off
|
|
|
|
;; This is only used by the XML:DocBook/peardoc2 converter
|
|
defaultcategoryname = Documentation
|
|
|
|
;; what is the main package?
|
|
;; legal values: alphanumeric string plus - and _
|
|
defaultpackagename = Piwik
|
|
|
|
;; where should the documentation be written?
|
|
;; legal values: a legal path
|
|
;target = /home/cellog/output
|
|
target = documentation
|
|
|
|
;; Which files should be parsed out as special documentation files, such as README,
|
|
;; INSTALL and CHANGELOG? This overrides the default files found in
|
|
;; phpDocumentor.ini (this file is not a user .ini file, but the global file)
|
|
readmeinstallchangelog = README, INSTALL, FAQ, LICENSE
|
|
|
|
;; 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 = core,plugins
|
|
|
|
;; comma-separated list of files, directories or wildcards ? and * (any wildcard) to ignore
|
|
;; legal values: any wildcard strings separated by commas
|
|
;ignore = /path/to/ignore*,*list.php,myfile.php,subdirectory/
|
|
ignore = pear-*,Documentation/,*.test.php,Lexer.inc,*.tpl,*.js,*.css,*.png,*.gif,*.ico,Updates/
|
|
|
|
;; 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:earthli,
|
|
;; HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,
|
|
;; HTML:frames:DOM/phphtmllib,HTML:frames:DOM/earthli
|
|
;; HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS
|
|
;; PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default
|
|
output=HTML:frames:earthli
|
|
;output=HTML:Smarty:HandS
|
|
|
|
;; turn this option on if you want highlighted source code for every file
|
|
;; legal values: on/off
|
|
sourcecode = off
|