+; Default configuration file for PHPDoctor

+

+; This config file will cause PHPDoctor to generate API documentation of

+; itself.

+

+

+; PHPDoctor settings

+; -----------------------------------------------------------------------------

+

+; Names of files to parse. This can be a single filename, or a comma separated

+; list of filenames. Wildcards are allowed.

+

+files = "*.php"

+

+; Names of files or directories to ignore. This can be a single filename, or a

+; comma separated list of filenames. Wildcards are NOT allowed.

+

+;ignore = "CVS, .svn, .git, _compiled"

+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*,acm_xcache.php

+

+; The directory to look for files in, if not used the PHPDoctor will look in

+; the current directory (the directory it is run from).

+

+source_path = "../phpBB/"

+

+; If you do not want PHPDoctor to look in each sub directory for files

+; uncomment this line.

+

+;subdirs = off

+

+; Set how loud PHPDoctor is as it runs. Quiet mode suppresses all output other

+; than warnings and errors. Verbose mode outputs additional messages during

+; execution.

+

+verbose = on

+

+; Select the doclet to use for generating output.

+

+doclet = standard

+;doclet = debug

+

+; The directory to find the doclet in. Doclets control the HTML output of

+; phpDoctor and can be modified to suit your needs. They are expected to be

+; in a directory named after themselves at the location given.

+

+;doclet_path = ./doclets

+

+; Select the formatter to use for generating output.

+

+;formatter = htmlStandardFormatter

+

+; The directory to find the formatter in. Formatters convert textual markup

+; for use by the doclet.

+

+;formatter_path = ./formatters

+

+; The directory to find taglets in. Taglets allow you to make PHPDoctor handle

+; new tags and to alter the behavour of existing tags and their output.

+

+;taglet_path = ./taglets

+

+; If the code you are parsing does not use package tags or not all elements

+; have package tags, use this setting to place unbound elements into a

+; particular package.

+

+default_package = "phpBB"

+

+use_class_path_as_package = off

+

+ignore_package_tags = off

+

+; Specifies the name of a HTML file containing text for the overview

+; documentation to be placed on the overview page. The path is relative to

+; "source_path" unless an absolute path is given.

+

+overview = ../README.md

+

+; Package comments will be looked for in a file named package.html in the same

+; directory as the first source file parsed in that package or in the directory

+; given below. If package comments are placed in the directory given below then

+; they should be named "<packageName>.html".

+

+package_comment_dir = ./

+

+; Parse out global variables and/or global constants?

+

+;globals = off

+;constants = off

+

+; Generate documentation for all class members

+

+;private = on

+

+; Generate documentation for public and protected class members

+

+;protected = on

+

+; Generate documentation for only public class members

+

+;public = on

+

+; Use the PEAR compatible handling of the docblock first sentence

+

+;pear_compat = on

+

+; Standard doclet settings

+; -----------------------------------------------------------------------------

+

+; The directory to place generated documentation in. If the given path is

+; relative to it will be relative to "source_path".

+

+d = "../build/api/"

+

+; Specifies the title to be placed in the HTML <title> tag.

+

+windowtitle = "phpBB3"

+

+; Specifies the title to be placed near the top of the overview summary file.

+

+doctitle = "phpBB3 Sourcecode Documentation"

+

+; Specifies the header text to be placed at the top of each output file. The

+; header will be placed to the right of the upper navigation bar.

+

+header = "phpBB3"

+

+; Specifies the footer text to be placed at the bottom of each output file. The

+; footer will be placed to the right of the lower navigation bar.

+

+footer = "phpBB3"

+

+; Specifies the text to be placed at the bottom of each output file. The text

+; will be placed at the bottom of the page, below the lower navigation bar.

+

+;bottom = "This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a>"

+

+; Create a class tree?

+

+;tree = off

+

+; Use GeSHi to include formatted source files in the documentation. PHPDoctor will look in the current doclet directory for a /geshi subdirectory. Unpack the GeSHi archive from http://qbnz.com/highlighter to get this directory - it will contain a php script and a subdirectory with formatting files.

+

+include_source = off