moving to documentation module
authortokul <tokul@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Tue, 12 Jul 2005 08:55:01 +0000 (08:55 +0000)
committertokul <tokul@7612ce4b-ef26-0410-bec9-ea0150e637f0>
Tue, 12 Jul 2005 08:55:01 +0000 (08:55 +0000)
git-svn-id: https://svn.code.sf.net/p/squirrelmail/code/trunk/squirrelmail@9761 7612ce4b-ef26-0410-bec9-ea0150e637f0

contrib/phpdoc/README [deleted file]
contrib/phpdoc/decode.ini [deleted file]
contrib/phpdoc/plugins.ini [deleted file]
contrib/phpdoc/smdoc.ini [deleted file]
contrib/phpdoc/squirrelmail.ini [deleted file]

diff --git a/contrib/phpdoc/README b/contrib/phpdoc/README
deleted file mode 100644 (file)
index 0697da0..0000000
+++ /dev/null
@@ -1,46 +0,0 @@
-This directory contains files, that can be used to create
-SquirrelMail documentation with phpdoc (http://www.phpdoc.org/) 
-tools.
-
-squirrelmail.ini - SquirrelMail CVS squirrelmail module
-                   HEAD branch
-decode.ini       - SquirrelMail CVS decode module HEAD branch
-smdoc.ini        - SquirrelMail CVS smdoc module HEAD branch
-plugins.ini      - SM-Plugins CVS plugins module HEAD branch
-
-.ini files can be used in phpdoc with -c option. Option
-was added to phpdoc on 2002-11-16.
-
-PHP configure options:
-----------------------
-configure --enable-cli --with-pear --disable-cgi \
-  --prefix=/home/user/bin/php \
-  --with-zlib
-
-php is installed in user's space in order to avoid
-modifications in stock php install. You need php 4.3.0
-or better in order to use tokenizer functions in phpdoc.
-
-Output of php 'pear list' command:
-----------------------------------
- Installed packages:
- ===================
- Package        Version  State
- Archive_Tar    1.1      stable
- Console_Getopt 1.2      stable
- DB             1.6.2    stable
- HTTP           1.2.2    stable
- Mail           1.1.3    stable
- Net_SMTP       1.2.6    stable
- Net_Socket     1.0.1    stable
- PEAR           1.3.2    stable
- PhpDocumentor  1.3.0RC3 beta
- XML_Beautifier 1.1      stable
- XML_Parser     1.0.1    stable
- XML_RPC        1.1.0    stable
- XML_Util       1.1.1    stable
-
-Specific changes:
------------------
-[_phpDocumentor_phpfile_exts] section in phpDocumentor.ini needs
-mod and tpl extensions.
diff --git a/contrib/phpdoc/decode.ini b/contrib/phpdoc/decode.ini
deleted file mode 100644 (file)
index fdbfb0c..0000000
+++ /dev/null
@@ -1,100 +0,0 @@
-;; 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 = Squirrelmail Decode package CVS 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
-
-;; add any custom @tags separated by commas here
-;; legal values: any legal tagname separated by commas.
-customtags = location,type
-
-;; This is only used by the XML:DocBook/peardoc2 converter
-defaultcategoryname = Documentation
-
-;; what is the main package?
-;; legal values: alphanumeric string plus - and _
-defaultpackagename = decode-extra
-
-;; 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 = /var/www/docs/sm-decode
-
-;; 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/user/cvs/sm-decode/HEAD/decode
-
-;; 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 = /home/user/cvs/sm-decode/HEAD/decode
-
-;; 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 = *.txt,index.php,doc/
-
-;; 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:default
-;; disabled generation of other formats
-;;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/contrib/phpdoc/plugins.ini b/contrib/phpdoc/plugins.ini
deleted file mode 100644 (file)
index fe44115..0000000
+++ /dev/null
@@ -1,99 +0,0 @@
-;; 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 = Squirrelmail Plugins CVS 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
-
-;; add any custom @tags separated by commas here
-;; legal values: any legal tagname separated by commas.
-customtags = location,type
-
-;; This is only used by the XML:DocBook/peardoc2 converter
-defaultcategoryname = Documentation
-
-;; what is the main package?
-;; legal values: alphanumeric string plus - and _
-defaultpackagename = sm-plugins
-
-;; 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 = /var/www/docs/sm-plugins
-
-;; 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/user/cvs/sm-plugins/plugins
-
-;; 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 = /home/user/cvs/sm-plugins/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 = *.txt,index.php,doc/
-
-;; 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:default
-;;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/contrib/phpdoc/smdoc.ini b/contrib/phpdoc/smdoc.ini
deleted file mode 100644 (file)
index 6605950..0000000
+++ /dev/null
@@ -1,99 +0,0 @@
-;; 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 = Squirrelmail Doc Site 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
-
-;; add any custom @tags separated by commas here
-;; legal values: any legal tagname separated by commas.
-customtags = location,type
-
-;; This is only used by the XML:DocBook/peardoc2 converter
-defaultcategoryname = Documentation
-
-;; what is the main package?
-;; legal values: alphanumeric string plus - and _
-defaultpackagename = smdoc
-
-;; 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 = /var/www/docs/smdoc
-
-;; 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/user/cvs/smdoc/HEAD/smdoc
-
-;; 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 = /home/user/cvs/smdoc/HEAD/smdoc
-
-;; 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 = *.txt,doc/
-
-;; 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:default
-;;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/contrib/phpdoc/squirrelmail.ini b/contrib/phpdoc/squirrelmail.ini
deleted file mode 100644 (file)
index 0400fd7..0000000
+++ /dev/null
@@ -1,99 +0,0 @@
-;; 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 = Squirrelmail Devel CVS 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
-
-;; add any custom @tags separated by commas here
-;; legal values: any legal tagname separated by commas.
-customtags = location,type
-
-;; This is only used by the XML:DocBook/peardoc2 converter
-defaultcategoryname = Documentation
-
-;; what is the main package?
-;; legal values: alphanumeric string plus - and _
-defaultpackagename = squirrelmail
-
-;; 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 = /var/www/docs/sm
-
-;; 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/user/cvs/squirrelmail/HEAD/squirrelmail
-
-;; 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 = /home/user/cvs/squirrelmail/HEAD/squirrelmail
-
-;; 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 = *.txt,index.php,doc/
-
-;; 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:default
-;;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