Skip to content

Commit

Permalink
Added documentation and example for ApiGen task
Browse files Browse the repository at this point in the history
  • Loading branch information
@kukulich @mrook
kukulich authored and mrook committed Feb 2, 2012
1 parent ed43305 commit efacac3
Showing 1 changed file with 239 additions and 0 deletions.
239 changes: 239 additions & 0 deletions docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html
View file
Expand Up @@ -23,6 +23,245 @@ <h1>
<p> This reference lists the tasks alphabetically by the name of the classes that implement
the tasks. So if you are searching for the reference to the <code>&lt;phplint&gt;</code>
tag, for example, you will want to look at the reference of PhpLintTask. </p>

<h2>
<a name="ApiGenTask"></a>ApiGenTask
</h2>
<p>
This task runs <a href="http://apigen.org/" target="_blank">ApiGen</a>,
a tool for creating professional API documentation from PHP source code,
similar to discontinued phpDocumentor/phpDoc.
</p>
<h3>Attributes</h3>
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
<th>Default</th>
<th>Required</th>
</tr>
</thead>
<tbody>
<tr>
<td>executable</td>
<td>String</td>
<td>ApiGen executable name.</td>
<td>apigen</td>
<td>No</td>
</tr>
<tr>
<td>config</td>
<td>String</td>
<td>Config file name.</td>
<td>n/a</td>
<td rowspan="2">Source and destination are required - either set explicitly
or using a config file. Attribute values set explicitly have precedence
over values from a config file.</td>
</tr>
<tr>
<td>source</td>
<td>String</td>
<td>List of source files or directories.</td>
<td>n/a</td>
</tr>
<tr>
<td>destination</td>
<td>String</td>
<td>Destination directory.</td>
<td>n/a</td>
</tr>
<tr>
<td>exclude</td>
<td>String</td>
<td>List of masks (case sensitive) to exclude files or directories from processing.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>skipdocpath</td>
<td>String</td>
<td>List of masks (case sensitive) to exclude elements from documentation generating.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>skipdocprefix</td>
<td>String</td>
<td>Name prefix (case sensitive) to exclude elements from documentation generating.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>charset</td>
<td>String</td>
<td>Character set of source files.</td>
<td>UTF-8</td>
<td>No</td>
</tr>
<tr>
<td>main</td>
<td>String</td>
<td>Main project name prefix.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>title</td>
<td>String</td>
<td>Title of generated documentation.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>baseurl</td>
<td>String</td>
<td>Documentation base URL.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>googlecseid</td>
<td>String</td>
<td>Google Custom Search ID.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>googlecselabel</td>
<td>String</td>
<td>Google Custom Search label.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>googleanalytics</td>
<td>String</td>
<td>Google Analytics tracking code.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>templateconfig</td>
<td>String</td>
<td>Template config file name.</td>
<td>n/a</td>
<td>If not set the default template is used.</td>
</tr>
<tr>
<td>allowedhtml</td>
<td>String</td>
<td>List of HTML tags allowed in the documentation.</td>
<td>b,i,a,ul,ol,li,p,br,var,samp,kbd,tt</td>
<td>No</td>
</tr>
<tr>
<td>accesslevels</td>
<td>String</td>
<td>Element access levels. Documentation only for methods and properties
with the given access level will be generated.</td>
<td>public,protected</td>
<td>No</td>
</tr>
<tr>
<td>internal</td>
<td>Boolean</td>
<td>Whether to generate documentation for elements marked as internal
and internal documentation parts or not.</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td>php</td>
<td>Boolean</td>
<td>Whether to generate documentation for PHP internal classes or not.</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>tree</td>
<td>Boolean</td>
<td>Whether to generate tree view of classes, interfaces, traits
and exceptions or not.</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>deprecated</td>
<td>Boolean</td>
<td>Whether to generate documentation for deprecated elements or not.</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td>todo</td>
<td>Boolean</td>
<td>Whether to generate documentation of tasks or not.</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td>sourcecode</td>
<td>Boolean</td>
<td>Whether to generate highlighted source code files or not.</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>download</td>
<td>Boolean</td>
<td>Whether to generate a link to download documentation as a ZIP archive or not.</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td>report</td>
<td>String</td>
<td>File name for checkstyle report of poorly documented elements.</td>
<td>n/a</td>
<td>No</td>
</tr>
<tr>
<td>wipeout</td>
<td>Boolean</td>
<td>Whether to wipe out the destination directory first or not.</td>
<td>Yes</td>
<td>No</td>
</tr>
<tr>
<td>quiet</td>
<td>Boolean</td>
<td>Whether to enable scaning and generating messages or not.</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td>updatecheck</td>
<td>Boolean</td>
<td>Whether to check for ApiGen updates or not.</td>
<td>No</td>
<td>No</td>
</tr>
<tr>
<td>debug</td>
<td>Boolean</td>
<td>Whether to enable the debug mode or not.</td>
<td>No</td>
<td>No</td>
</tr>
</tbody>
</table>
<h3>Examples</h3>
<pre>
&lt;apigen
&nbsp;&nbsp;source=&quot;classes&quot;
&nbsp;&nbsp;destination=&quot;api&quot;
&nbsp;&nbsp;exclude=&quot;*/tests/*&quot;
&nbsp;&nbsp;title=&quot;My Project API Documentation&quot;
&nbsp;&nbsp;deprecated=&quot;true&quot;
&nbsp;&nbsp;todo="true"/&gt;
</pre>
<h2>
<a name="CoverageMergerTask"></a>CoverageMergerTask </h2>
<p>The CoverageMergerTask merges code coverage information from external sources with an
Expand Down

0 comments on commit efacac3

Please sign in to comment.