1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
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;
}
};
?>
|
