Ticket #210: phing-phpdocext-rework-docs.diff

File phing-phpdocext-rework-docs.diff, 5.3 KB (added by Markus Fischer <markus@…>, 4 years ago)

Reworked PhpDocumentorExternalTask documentation

  • docs/phing_guide/book/toc/FrameToC.html

     
    133133<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PearPackage2Task" target="Content">PearPackage2Task</a></li> 
    134134<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpCodeSnifferTask" target="Content">PhpCodeSnifferTask</a></li> 
    135135<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpDocumentorTask" target="Content">PhpDocumentorTask</a></li> 
     136<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpDocumentorExternalTask" target="Content">PhpDocumentorExternalTask</a></li> 
    136137<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpLintTask" target="Content">PhpLintTask</a></li> 
    137138<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PHPUnitTask" target="Content">PHPUnitTask</a></li> 
    138139<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PHPUnitReport" target="Content">PHPUnitReport</a></li> 
    … …  
    219220 
    220221</body> 
    221222</html> 
    222 <!-- $Id --> 
    223  No newline at end of file 
     223<!-- $Id --> 

  • docs/phing_guide/book/toc/ToC.html

     
    118118<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PearPackage2Task">PearPackage2Task</a></li> 
    119119<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpCodeSnifferTask">PhpCodeSnifferTask</a></li> 
    120120<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpDocumentorTask">PhpDocumentorTask</a></li> 
     121<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpDocumentorExternalTask">PhpDocumentorExternalTask</a></li> 
    121122<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PhpLintTask">PhpLintTask</a></li> 
    122123<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PHPUnitTask">PHPUnitTask</a></li> 
    123124<li><a href="../chapters/appendixes/AppendixC-OptionalTasks.html#PHPUnitReport">PHPUnitReport</a></li> 
    … …  
    205206 
    206207</body> 
    207208</html> 
    208 <!-- $Id --> 
    209  No newline at end of file 
     209<!-- $Id --> 

  • docs/phing_guide/book/chapters/appendixes/AppendixC-OptionalTasks.html

     
    11351135      <td>No</td> 
    11361136    </tr> 
    11371137 
     1138        <tr> 
     1139      <td>templatebase</td> 
     1140      <td>String</td> 
     1141      <td>Set base dirctory of all templates for this parse.</td> 
     1142      <td>n/a</td> 
     1143      <td>No</td> 
     1144    </tr> 
     1145 
     1146        <tr> 
     1147      <td>undocumentedelements</td> 
     1148      <td>Boolean</td> 
     1149      <td>Control whether or not warnings will be shown for undocumented 
     1150          elements. Useful for identifying classes and methods that haven't yet 
     1151          been documented.</td> 
     1152      <td>false</td> 
     1153      <td>No</td> 
     1154    </tr> 
     1155 
     1156        <tr> 
     1157      <td>customtags</td> 
     1158      <td>Boolean</td> 
     1159      <td>Custom tags, will be recognized and put in tags[] instead of 
     1160          unknowntags[].</td> 
     1161      <td>false</td> 
     1162      <td>No</td> 
     1163    </tr> 
     1164 
    11381165  </tbody> 
    11391166</table> 
    11401167 
    … …  
    11611188&lt;/phpdoc&gt; 
    11621189</pre> 
    11631190 
     1191<h2><a name="PhpDocumentorExternalTask"></a>PhpDocumentorExternalTask</h2> 
     1192<p>This is the same as the <a href="#PhpDocumentorTask">PhpDocumentorTask</a> 
     1193but uses the command line application. Use this as a fallback in case you're 
     1194running into troubles when using the phpDocumentor-library with the 
     1195PhpDocumentorTask directly, e.g. when you're using Smarty and have Smarty in 
     1196your library path too.</p> 
     1197<p>This task supports everything the PhpDocumentorTask supports, differences are 
     1198documented below.</p> 
     1199<h3>Additional attributes</h3> 
     1200<table> 
     1201  <thead> 
     1202    <tr> 
     1203      <th>Name</th> 
     1204      <th>Type</th> 
     1205      <th>Description</th> 
     1206      <th>Default</th> 
     1207      <th>Required</th> 
     1208    </tr> 
     1209  </thead> 
     1210  <tbody> 
     1211    <tr> 
     1212      <td>programpath</td> 
     1213      <td>String</td> 
     1214      <td>Path to the phpdoc executable (relative or absolute).</td> 
     1215      <td>n/a</td> 
     1216      <td>No</td> 
     1217    </tr> 
     1218 
     1219    <tr> 
     1220      <td>sourcepath</td> 
     1221      <td>String</td> 
     1222      <td>A directory to scan for parsable files. Supports multiple directories 
     1223          separated with a comma.</td> 
     1224      <td>n/a</td> 
     1225      <td>Yes, if no <tt>&lt;fileset&gt;</tt> is given</td> 
     1226    </tr> 
     1227 
     1228  </tbody> 
     1229</table> 
     1230 
     1231<h3>Unsupported attributes</h3> 
     1232<table> 
     1233  <thead> 
     1234    <tr> 
     1235      <th>Name</th> 
     1236      <th>Description</th> 
     1237    </tr> 
     1238  </thead> 
     1239  <tbody> 
     1240 
     1241    <tr> 
     1242      <td>configdir</td> 
     1243      <td>Currently not supported. The attribute will be ignored and a 
     1244          warning messag will be generated. The build continues (to ease when 
     1245          changing an existing phpdoc task) however this may have unexpected 
     1246          side effects.</td> 
     1247    </tr> 
     1248 
     1249  </tbody> 
     1250</table> 
     1251 
    11641252<h2><a name="PhpLintTask"></a>PhpLintTask</h2> 
    11651253<p>The <em>PhpLintTask</em> checks syntax (lint) on one or more PHP source code files.</p> 
    11661254