diff options
| author | Nils Adermann <naderman@naderman.de> | 2010-12-13 17:14:36 +0100 |
|---|---|---|
| committer | Nils Adermann <naderman@naderman.de> | 2010-12-13 17:14:36 +0100 |
| commit | 18f74a7e10b01f4f6f916e2baa814b27b31fc8a9 (patch) | |
| tree | c7068f8e9cb82587f97adb19a390cb69631b9b9f /build | |
| parent | adfa1656fb9d8b5bb601af1d7a6720884954d87a (diff) | |
| parent | 5d8ddc748000623b8e705b9434a4133cdd8fcc19 (diff) | |
| download | forums-18f74a7e10b01f4f6f916e2baa814b27b31fc8a9.tar forums-18f74a7e10b01f4f6f916e2baa814b27b31fc8a9.tar.gz forums-18f74a7e10b01f4f6f916e2baa814b27b31fc8a9.tar.bz2 forums-18f74a7e10b01f4f6f916e2baa814b27b31fc8a9.tar.xz forums-18f74a7e10b01f4f6f916e2baa814b27b31fc8a9.zip | |
Merge branch 'develop-olympus' into develop
* develop-olympus:
[ticket/9851] "Search new posts" should require login.
[task/phpdoc] Added a phpdoc task to the build process
[task/phpdoc] Added a configuration file for phpDocumentor.
[feature/acm-wincache] Adding caching module for WinCache's User Cache.
[ticket/9939] Fix JavaScript error in admin recaptcha template
[ticket/9575] Also change 'administrate' to 'administer' in templates
[ticket/8736] guest can have 255 chars long username
[ticket/9928] Do not link "login to your board" to the "send statistics" page.
[ticket/9575] Change 'administrate' to 'administer'
[ticket/9921] Adding sample configuration file for the lighttpd webserver.
[ticket/9932] Add the Bing bot when converting
[ticket/9930] Redirect failes with open_basedir enabled.
[ticket/9910] Make sure S_BBCODE_ALLOWED exists when viewing PMs
Diffstat (limited to 'build')
| -rw-r--r-- | build/build.xml | 8 | ||||
| -rw-r--r-- | build/phpdoc-phpbb.ini | 106 |
2 files changed, 113 insertions, 1 deletions
diff --git a/build/build.xml b/build/build.xml index bf77d82f6c..8d2afcb00c 100644 --- a/build/build.xml +++ b/build/build.xml @@ -12,7 +12,7 @@ <!-- These are the main targets which you will probably want to use --> <target name="package" depends="clean,prepare,create-package" /> - <target name="all" depends="clean,prepare,test,create-package" /> + <target name="all" depends="clean,prepare,test,docs,create-package" /> <target name="prepare"> <mkdir dir="build/logs" /> @@ -64,6 +64,12 @@ --> </target> + <target name="docs"> + <exec dir="build" + command="phpdoc -c phpdoc-phpbb.ini" + passthru="true" /> + </target> + <target name="old-version-diffs"> <foreach list="${oldversions}" param="version" target="old-version-diff" /> </target> diff --git a/build/phpdoc-phpbb.ini b/build/phpdoc-phpbb.ini new file mode 100644 index 0000000000..86d33549c0 --- /dev/null +++ b/build/phpdoc-phpbb.ini @@ -0,0 +1,106 @@ +;; 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 = phpBB3 Sourcecode 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 + +;; 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 = sourcecode + +;; what is the main package? +;; legal values: alphanumeric string plus - and _ +defaultpackagename = phpBB3 + +;; 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 = api + +;; 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.html, INSTALL.html, CHANGELOG.html, COPYING + +;; limit output to the specified packages, even if others are parsed +;; legal values: package names separated by commas +;packageoutput = phpBB3,ACP,SEARCH,DBAL,ACM,MCP,UCP,LOGIN,lang_english + +;; 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 = ../phpBB/ + +;; 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 = c:\wamp\www\examples + +;; 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/,*config.php*,*CVS/,test_chora.php,testupdate/,cache/,store/,*proSilver/,develop/,includes/utf/data/,includes/captcha/fonts/,install/update/,install/update.new/,files/,*phpinfo.php*,*update_script.php*,*upgrade.php*,*convert.php*,install/converter/,language/de/,script/,*swatch.php*,*test.php*,*test2.php*,*install.php*,*functions_diff.php*,*acp_update.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: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 +;output=HTML:frames:DOM/default,XML:DocBook/peardoc2:default,CHM:default:default,HTML:frames:DOM/earthli,HTML:frames:DOM/phpdoc.de,HTML:frames:DOM/phphtmllib,HTML:frames:phphtmllib +;HTML:frames:earthli +;output=XML:DocBook/peardoc2:default + +;output=HTML:frames:DOM/earthli +;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 +;output=HTML:Smarty:PHP +output=HTML:frames:earthli + +;; turn this option on if you want highlighted source code for every file +;; legal values: on/off +sourcecode = off |