cleanup doc config

.gitignore

@@ -1,3 +1,5 @@
 .buildpath
 .project
 .settings/
+doc/config/phpdoc.ini
+doc/html

doc/config/README

@@ -2,25 +2,31 @@
 Documentation
 =============
 
-The documentation of this project follows the semantics and paradigms of PHPDocumentor[1].
-Since the API documentation changes constantly and it is easy to build a rendered documentation
-is not part of the repository.
+The documentation of this project follows the semantics and paradigms of
+phpdoctor[1] and PHPDocumentor[1].
+Since the API documentation changes constantly and it is easy to build, a
+rendered documentation is not part of the repository.
+
+You can find a (hopefully up-to-date) version online at
+http://phpcr.github.com/doc/html/index.html
+
 
 How to use the configuration file to generate the documentation
 ===============================================================
 
-1. copy the phpdoc.example.ini to a new file (e.g. phpdoc.ini)
-2. replace the marked entries with your crendentials
+1. copy the phpdoctor.dist.ini to a new file (e.g. phpdoc.ini)
+2. replace the marked entries with your data
 3. save your configuration file
-4. use: 
-    $>phpdoc -c doc/config/phpdoc.ini
+4. use:
+    $>phpdoc doc/config/phpdoc.ini
    to render the documentation when your working directory is the phpcr root directory.
-   
+
 NOTE:
 Please do not commit your copy of the configuration file or the generated documenation.
 
 
 Links
 =====
 
-[1] http://phpdoc.org
+[1] http://peej.github.com/phpdoctor/
+[2] http://phpdoc.org

doc/config/phpdoctor.dist.ini

@@ -0,0 +1,140 @@
+; Configuration file for PHPDoctor
+
+; 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"
+
+; 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 = "/path/to/phpcr/src"
+
+; 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.
+
+;quiet = on
+;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 = "PHPCR"
+
+use_class_path_as_package = on
+
+ignore_package_tags = on
+
+; 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 = overview.html
+
+; 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 = "/path/to/doc/html"
+
+; Specifies the title to be placed in the HTML <title> tag.
+
+windowtitle = "PHPCR API"
+
+; Specifies the title to be placed near the top of the overview summary file.
+
+doctitle = "PHPCR API 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 = "PHPCR"
+
+; 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 = "PHPCR"
+
+; 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
+