Merge from 3.0 branch till 1185.

6 files changed, 482 insertions, 0 deletions

diff --git a/buildscripts/PhpDocumentor/user/default.ini b/buildscripts/PhpDocumentor/user/default.ini
new file mode 100644
index 00000000..4915f607
--- /dev/null
+++ b/buildscripts/PhpDocumentor/user/default.ini
@@ -0,0 +1,98 @@
+;; phpDocumentor parse configuration file

+;;

+;; 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.

+;;

+;; default.ini is used to generate the online manual at http://www.phpdoc.org/docs

+;;

+;; ALL .ini files must be in the user subdirectory of phpDocumentor with an extension of .ini

+;;

+;; Copyright 2002, Greg Beaver <cellog@users.sourceforge.net>

+;;

+;; WARNING: do not change the name of any command-line parameters, phpDocumentor will ignore them

+

+[Parse Data]

+;; title of all the documentation

+;; legal values: any string

+title = phpDocumentor 1.3.0 Manual

+

+;; 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 = off

+

+;; add any custom @tags separated by commas here

+;; legal values: any legal tagname separated by commas.

+;customtags = mytag1,mytag2

+

+;; This is only used by the XML:DocBook/peardoc2 converter

+defaultcategoryname = Documentation

+

+;; what is the main package?

+;; legal values: alphanumeric string plus - and _

+defaultpackagename = phpDocumentor

+

+;; output any parsing information?  set to on for cron jobs

+;; legal values: on

+;quiet = on

+

+;; parse a PEAR-style repository.  Do not turn this on if your project does

+;; not have a parent directory named "pear"

+;; legal values: on/off

+;pear = on

+

+;; where should the documentation be written?

+;; legal values: a legal path

+target = /home/cellog/output

+

+;; 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, CHANGELOG, NEWS, 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 = /path1,/path2,.,..,subdirectory

+;directory = /home/jeichorn/cvs/pear

+directory = /home/cellog/phpdoc

+

+;; template base directory (the equivalent directory of <installdir>/phpDocumentor)

+;templatebase = /path/to/my/templates

+

+;; directory to find any example files in through @example and {@example} tags

+;examplesdir = /path/to/my/templates

+

+;; 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 = templates_c/,*HTML/default/*,spec/

+

+;; 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,HTML:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,HTML:frames:DOM/earthli,HTML:frames:DOM/phphtmllib,HTML:frames:phpedit,HTML:Smarty:default,HTML:Smarty:PHP,HTML:Smarty:HandS,CHM:default:default,PDF:default:default

+

+;; turn this option on if you want highlighted source code for every file

+;; legal values: on/off

+sourcecode = on
\ No newline at end of file
diff --git a/buildscripts/PhpDocumentor/user/demo.ini b/buildscripts/PhpDocumentor/user/demo.ini
new file mode 100644
index 00000000..edf0a353
--- /dev/null
+++ b/buildscripts/PhpDocumentor/user/demo.ini
@@ -0,0 +1,78 @@
+;; 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

+

+;; 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@users.sourceforge.net>

+;;

+;; WARNING: do not change the 

+

+[Parse Data]

+;; title of all the documentation

+;; legal values: any string

+title = Generated 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 = off

+

+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 = phpDocumentor

+

+;; 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

+filename = test.php

+

+;; comma-separated list of directories to parse

+;; legal values: directory paths separated by commas

+;directory = /path1,/path2,.,..,subdirectory

+;directory = /home/jeichorn/cvs/pear

+;directory = .

+

+;; 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 = templates_c/,*HTML/default/*,spec/

+

+;; 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:frames:default,HTML:frames:l0l33t,HTML:frames:phpdoc.de,HTML:frames:phphtmllib,HTML:frames:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,HTML:frames:phpedit,HTML:Smarty:default,HTML:Smarty:HandS,HTML:Smarty:PHP,PDF:default:default,XML:DocBook/peardoc2:default,CHM:default:default
\ No newline at end of file
diff --git a/buildscripts/PhpDocumentor/user/error.ini b/buildscripts/PhpDocumentor/user/error.ini
new file mode 100644
index 00000000..cb8d4ca5
--- /dev/null
+++ b/buildscripts/PhpDocumentor/user/error.ini
@@ -0,0 +1,82 @@
+;; phpDocumentor parse configuration file

+;;

+;; 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@users.sourceforge.net>

+;;

+;; WARNING: do not change the name of any command-line parameters, phpDocumentor will halt

+

+[Parse Data]

+;; title of all the documentation

+;; legal values: any string

+title = SlateLib Manual

+

+;; 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

+

+;; add any custom @tags separated by commas here

+;; legal values: any legal tagname separated by commas.

+;customtags = mytag1,mytag2

+

+;; This is only used by the XML:DocBook/peardoc2 converter

+defaultcategoryname = Documentation

+

+;; what is the main package?

+;; legal values: alphanumeric string plus - and _

+defaultpackagename = junk

+

+;; output any parsing information?  set to on for cron jobs

+;; legal values: on

+;quiet = on

+

+;; parse a PEAR-style repository.  Do not turn this on if your project does

+;; not have a parent directory named "pear"

+;; legal values: on/off

+;pear = on

+

+;; where should the documentation be written?

+;; legal values: a legal path

+target = /tmp/docs

+

+;; 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 = /home/jeichorn/cvs/slatelib

+

+;; 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 = 

+

+;; 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: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/peardoc2:default

+output=HTML:Smarty:default,HTML:Smarty:PHP

+

+;; turn this option on if you want highlighted source code for every file

+;; legal values: on/off

+sourcecode = on

diff --git a/buildscripts/PhpDocumentor/user/pear-makedocs.ini b/buildscripts/PhpDocumentor/user/pear-makedocs.ini
new file mode 100644
index 00000000..750cf48f
--- /dev/null
+++ b/buildscripts/PhpDocumentor/user/pear-makedocs.ini
@@ -0,0 +1,71 @@
+;; phpDocumentor parse configuration file

+;;

+;; 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@users.sourceforge.net>

+;;

+;; WARNING: do not change the 

+

+[Parse Data]

+;; title of all the documentation

+;; legal values: any string

+title = phpDocumentor Manual

+

+;; 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 = off

+

+;; 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 = phpDocumentor

+

+;; output any parsing information?  set to on for cron jobs

+;; legal values: on

+;quiet = on

+

+;; where should the documentation be written?

+;; legal values: a legal path

+target = @DOC-DIR@/PhpDocumentor/Documentation/new

+

+;; 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

+filename = @DOC-DIR@/PhpDocumentor/README,@DOC-DIR@/PhpDocumentor/ChangeLog,@DOC-DIR@/PhpDocumentor/Release-@VER@,@DOC-DIR@/PhpDocumentor/FAQ

+;; comma-separated list of directories to parse

+;; legal values: directory paths separated by commas

+;directory = /path1,/path2,.,..,subdirectory

+;directory = /home/jeichorn/cvs/pear

+directory = @PEAR-DIR@/PhpDocumentor,@DOC-DIR@/PhpDocumentor/tutorials

+

+releaseinstallchangelog = Release-@VER@,ChangeLog,README,FAQ

+

+;; 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/

+

+;; 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:DOM/default,HTML:frames:DOM/l0l33t,HTML:frames:DOM/phpdoc.de,HTML:Smarty:default

+;;               HTML:Smarty:PHP,HTML:Smarty:HandS,PDF:default:default,CHM:default:default,XML:DocBook/peardoc2:default

+output=HTML:Smarty:HandS
\ No newline at end of file
diff --git a/buildscripts/PhpDocumentor/user/prado.ini b/buildscripts/PhpDocumentor/user/prado.ini
new file mode 100644
index 00000000..f009f873
--- /dev/null
+++ b/buildscripts/PhpDocumentor/user/prado.ini
@@ -0,0 +1,79 @@
+;; 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 = d:/wwwroot/prado3-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@users.sourceforge.net>

+;;

+;; WARNING: do not change the

+

+[Parse Data]

+;; title of all the documentation

+;; legal values: any string

+title = PRADO 3.0.1 API Manual

+

+;; 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 = off

+

+target=d:/wwwroot/prado3-doc/manual

+

+;; 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 = default

+

+;; 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

+;filename =

+

+;; comma-separated list of directories to parse

+;; legal values: directory paths separated by commas

+directory = D:/wwwroot/prado3-doc/prado-3.0.1/framework

+;directory = /home/jeichorn/cvs/pear

+;directory = .

+

+;; 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 = templates_c/,*HTML/default/*,spec/,*pradolite.php,*3rdParty/*,*Javascripts/*

+

+;; 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:frames:default,CHM:default:default

+output=HTML:Smarty:PradoSoft
\ No newline at end of file
diff --git a/buildscripts/PhpDocumentor/user/testdocbook.ini b/buildscripts/PhpDocumentor/user/testdocbook.ini
new file mode 100644
index 00000000..8de48fc0
--- /dev/null
+++ b/buildscripts/PhpDocumentor/user/testdocbook.ini
@@ -0,0 +1,74 @@
+;; phpDocumentor parse configuration file

+;;

+;; 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@users.sourceforge.net>

+;;

+;; WARNING: do not change the 

+

+[Parse Data]

+;; title of all the documentation

+;; legal values: any string

+title = Generated 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

+

+pear=on

+

+;; parse with javadoc-like description (first sentence is always the short description)

+;; legal values: on, off

+javadocdesc = off

+

+;; 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 = PEAR_PackageFileManager

+

+defaultcategoryname = pear

+

+;; output any parsing information?  set to on for cron jobs

+;; legal values: on

+;quiet = on

+

+;; where should the documentation be written?

+;; legal values: a legal path

+target = /home/cellog/peardoc/en/package

+

+;; 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/cellog/pear/PEAR_PackageFileManager

+;directory = /home/CelloG/phpdoc

+

+;; 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 = examples/

+

+;; 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: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=XML:DocBook/peardoc2:default