diff options
Diffstat (limited to 'buildscripts/phing/classes/phing/tasks/ext/phpdoc/PHPDocumentorTask.php')
| -rw-r--r-- | buildscripts/phing/classes/phing/tasks/ext/phpdoc/PHPDocumentorTask.php | 157 |
1 files changed, 157 insertions, 0 deletions
diff --git a/buildscripts/phing/classes/phing/tasks/ext/phpdoc/PHPDocumentorTask.php b/buildscripts/phing/classes/phing/tasks/ext/phpdoc/PHPDocumentorTask.php new file mode 100644 index 00000000..2fefc4e5 --- /dev/null +++ b/buildscripts/phing/classes/phing/tasks/ext/phpdoc/PHPDocumentorTask.php @@ -0,0 +1,157 @@ +<?php + + /** + * $Id: PHPDocumentorTask.php 59 2006-04-28 14:49:47Z mrook $ + * + * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS + * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT + * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR + * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT + * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, + * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT + * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, + * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY + * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT + * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE + * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. + * + * This software consists of voluntary contributions made by many individuals + * and is licensed under the LGPL. For more information please see + * <http://phing.info>. + */ + + require_once 'phing/Task.php'; + + /** + * Task to run phpDocumentor. + * + * @author Michiel Rook <michiel@trendserver.nl> + * @version $Id: PHPDocumentorTask.php 59 2006-04-28 14:49:47Z mrook $ + * @package phing.tasks.ext.phpdoc + */ + class PHPDocumentorTask extends Task + { + /** + * The name of the executable for phpDocumentor + */ + const PHPDOC = 'phpdoc'; + + private $title = "Default Title"; + + private $destdir = "."; + + private $sourcepath = NULL; + + private $output = ""; + + private $linksource = false; + + private $parseprivate = false; + + /** + * Set the title for the generated documentation + */ + function setTitle($title) + { + $this->title = $title; + } + + /** + * Set the destination directory for the generated documentation + */ + function setDestdir($destdir) + { + $this->destdir = $destdir; + } + + /** + * Set the source path + */ + function setSourcepath(Path $sourcepath) + { + if ($this->sourcepath === NULL) + { + $this->sourcepath = $sourcepath; + } + else + { + $this->sourcepath->append($sourcepath); + } + } + + /** + * Set the output type + */ + function setOutput($output) + { + $this->output = $output; + } + + /** + * Should sources be linked in the generated documentation + */ + function setLinksource($linksource) + { + $this->linksource = $linksource; + } + + /** + * Should private members/classes be documented + */ + function setParseprivate($parseprivate) + { + $this->parseprivate = $parseprivate; + } + + /** + * Main entrypoint of the task + */ + function main() + { + $arguments = $this->constructArguments(); + + exec(self::PHPDOC . " " . $arguments, $output, $retval); + } + + /** + * Constructs an argument string for phpDocumentor + */ + private function constructArguments() + { + $arguments = "-q "; + + if ($this->title) + { + $arguments.= "-ti \"" . $this->title . "\" "; + } + + if ($this->destdir) + { + $arguments.= "-t " . $this->destdir . " "; + } + + if ($this->sourcepath !== NULL) + { + $arguments.= "-d " . $this->sourcepath->__toString() . " "; + } + + if ($this->output) + { + $arguments.= "-o " . $this->output . " "; + } + + if ($this->linksource) + { + $arguments.= "-s "; + } + + if ($this->parseprivate) + { + $arguments.= "-pp "; + } + + return $arguments; + } + }; + +?>
\ No newline at end of file |