Changeset efacac3
- Timestamp:
- 02/02/12 13:42:00 (4 months ago)
- Branches:
- master
- Children:
- 0a3c897
- Parents:
- ed43305
- git-author:
- Jaroslav Hanslik <kukulich@…> (01/29/12 23:20:49)
- git-committer:
- Michiel Rook <mrook@…> (02/02/12 13:42:00)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html
rfe47992 refacac3 24 24 the tasks. So if you are searching for the reference to the <code><phplint></code> 25 25 tag, for example, you will want to look at the reference of PhpLintTask. </p> 26 27 <h2> 28 <a name="ApiGenTask"></a>ApiGenTask 29 </h2> 30 <p> 31 This task runs <a href="http://apigen.org/" target="_blank">ApiGen</a>, 32 a tool for creating professional API documentation from PHP source code, 33 similar to discontinued phpDocumentor/phpDoc. 34 </p> 35 <h3>Attributes</h3> 36 <table> 37 <thead> 38 <tr> 39 <th>Name</th> 40 <th>Type</th> 41 <th>Description</th> 42 <th>Default</th> 43 <th>Required</th> 44 </tr> 45 </thead> 46 <tbody> 47 <tr> 48 <td>executable</td> 49 <td>String</td> 50 <td>ApiGen executable name.</td> 51 <td>apigen</td> 52 <td>No</td> 53 </tr> 54 <tr> 55 <td>config</td> 56 <td>String</td> 57 <td>Config file name.</td> 58 <td>n/a</td> 59 <td rowspan="2">Source and destination are required - either set explicitly 60 or using a config file. Attribute values set explicitly have precedence 61 over values from a config file.</td> 62 </tr> 63 <tr> 64 <td>source</td> 65 <td>String</td> 66 <td>List of source files or directories.</td> 67 <td>n/a</td> 68 </tr> 69 <tr> 70 <td>destination</td> 71 <td>String</td> 72 <td>Destination directory.</td> 73 <td>n/a</td> 74 </tr> 75 <tr> 76 <td>exclude</td> 77 <td>String</td> 78 <td>List of masks (case sensitive) to exclude files or directories from processing.</td> 79 <td>n/a</td> 80 <td>No</td> 81 </tr> 82 <tr> 83 <td>skipdocpath</td> 84 <td>String</td> 85 <td>List of masks (case sensitive) to exclude elements from documentation generating.</td> 86 <td>n/a</td> 87 <td>No</td> 88 </tr> 89 <tr> 90 <td>skipdocprefix</td> 91 <td>String</td> 92 <td>Name prefix (case sensitive) to exclude elements from documentation generating.</td> 93 <td>n/a</td> 94 <td>No</td> 95 </tr> 96 <tr> 97 <td>charset</td> 98 <td>String</td> 99 <td>Character set of source files.</td> 100 <td>UTF-8</td> 101 <td>No</td> 102 </tr> 103 <tr> 104 <td>main</td> 105 <td>String</td> 106 <td>Main project name prefix.</td> 107 <td>n/a</td> 108 <td>No</td> 109 </tr> 110 <tr> 111 <td>title</td> 112 <td>String</td> 113 <td>Title of generated documentation.</td> 114 <td>n/a</td> 115 <td>No</td> 116 </tr> 117 <tr> 118 <td>baseurl</td> 119 <td>String</td> 120 <td>Documentation base URL.</td> 121 <td>n/a</td> 122 <td>No</td> 123 </tr> 124 <tr> 125 <td>googlecseid</td> 126 <td>String</td> 127 <td>Google Custom Search ID.</td> 128 <td>n/a</td> 129 <td>No</td> 130 </tr> 131 <tr> 132 <td>googlecselabel</td> 133 <td>String</td> 134 <td>Google Custom Search label.</td> 135 <td>n/a</td> 136 <td>No</td> 137 </tr> 138 <tr> 139 <td>googleanalytics</td> 140 <td>String</td> 141 <td>Google Analytics tracking code.</td> 142 <td>n/a</td> 143 <td>No</td> 144 </tr> 145 <tr> 146 <td>templateconfig</td> 147 <td>String</td> 148 <td>Template config file name.</td> 149 <td>n/a</td> 150 <td>If not set the default template is used.</td> 151 </tr> 152 <tr> 153 <td>allowedhtml</td> 154 <td>String</td> 155 <td>List of HTML tags allowed in the documentation.</td> 156 <td>b,i,a,ul,ol,li,p,br,var,samp,kbd,tt</td> 157 <td>No</td> 158 </tr> 159 <tr> 160 <td>accesslevels</td> 161 <td>String</td> 162 <td>Element access levels. Documentation only for methods and properties 163 with the given access level will be generated.</td> 164 <td>public,protected</td> 165 <td>No</td> 166 </tr> 167 <tr> 168 <td>internal</td> 169 <td>Boolean</td> 170 <td>Whether to generate documentation for elements marked as internal 171 and internal documentation parts or not.</td> 172 <td>No</td> 173 <td>No</td> 174 </tr> 175 <tr> 176 <td>php</td> 177 <td>Boolean</td> 178 <td>Whether to generate documentation for PHP internal classes or not.</td> 179 <td>Yes</td> 180 <td>No</td> 181 </tr> 182 <tr> 183 <td>tree</td> 184 <td>Boolean</td> 185 <td>Whether to generate tree view of classes, interfaces, traits 186 and exceptions or not.</td> 187 <td>Yes</td> 188 <td>No</td> 189 </tr> 190 <tr> 191 <td>deprecated</td> 192 <td>Boolean</td> 193 <td>Whether to generate documentation for deprecated elements or not.</td> 194 <td>No</td> 195 <td>No</td> 196 </tr> 197 <tr> 198 <td>todo</td> 199 <td>Boolean</td> 200 <td>Whether to generate documentation of tasks or not.</td> 201 <td>No</td> 202 <td>No</td> 203 </tr> 204 <tr> 205 <td>sourcecode</td> 206 <td>Boolean</td> 207 <td>Whether to generate highlighted source code files or not.</td> 208 <td>Yes</td> 209 <td>No</td> 210 </tr> 211 <tr> 212 <td>download</td> 213 <td>Boolean</td> 214 <td>Whether to generate a link to download documentation as a ZIP archive or not.</td> 215 <td>No</td> 216 <td>No</td> 217 </tr> 218 <tr> 219 <td>report</td> 220 <td>String</td> 221 <td>File name for checkstyle report of poorly documented elements.</td> 222 <td>n/a</td> 223 <td>No</td> 224 </tr> 225 <tr> 226 <td>wipeout</td> 227 <td>Boolean</td> 228 <td>Whether to wipe out the destination directory first or not.</td> 229 <td>Yes</td> 230 <td>No</td> 231 </tr> 232 <tr> 233 <td>quiet</td> 234 <td>Boolean</td> 235 <td>Whether to enable scaning and generating messages or not.</td> 236 <td>No</td> 237 <td>No</td> 238 </tr> 239 <tr> 240 <td>updatecheck</td> 241 <td>Boolean</td> 242 <td>Whether to check for ApiGen updates or not.</td> 243 <td>No</td> 244 <td>No</td> 245 </tr> 246 <tr> 247 <td>debug</td> 248 <td>Boolean</td> 249 <td>Whether to enable the debug mode or not.</td> 250 <td>No</td> 251 <td>No</td> 252 </tr> 253 </tbody> 254 </table> 255 <h3>Examples</h3> 256 <pre> 257 <apigen 258 source="classes" 259 destination="api" 260 exclude="*/tests/*" 261 title="My Project API Documentation" 262 deprecated="true" 263 todo="true"/> 264 </pre> 26 265 <h2> 27 266 <a name="CoverageMergerTask"></a>CoverageMergerTask </h2>
Note: See TracChangeset
for help on using the changeset viewer.
