File: bash/phpdoc.xml

Recommend this page to a friend!
  Classes of Stefan Kientzler  >  PHPDoc 2 Github Wiki  >  bash/phpdoc.xml  >  Download  
File: bash/phpdoc.xml
Role: Auxiliary data
Content type: text/plain
Description: Auxiliary data
Class: PHPDoc 2 Github Wiki
Generate documentation for packages in GitHub
Author: By
Last change:
Date: 3 months ago
Size: 1,958 bytes
 

Contents

Class file image Download
<?xml version="1.0" encoding="UTF-8" ?>
<phpdocumentor
        configVersion="3"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns="https://www.phpdoc.org"
        xsi:noNamespaceSchemaLocation="https://docs.phpdoc.org/latest/phpdoc.xsd">
        
    <!-- title of your wiki/package -->
    <title>[Title of package]</title>
    <paths>
        <!-- root of the wiki repository -->
        <output>./[Projectname].wiki</output>
        <cache>./cache</cache>
    </paths>
    <version number="latest">
        <api>
            <!-- all source files to scan -->
            <source dsn="[Base path to the project]">
				<path>[First File or directory to scan]</path>
				<path>[Second File or directory to scan]</path>
				<path>[...]</path>
				<path>[N-th File or directory to scan]</path>
            </source>
            
            <!-- 
                Setup the visibility level you want your documentation for 
                 - multiple levels can be specified
            -->
            <visibility>public</visibility>
            <!-- <visibility>api</visibility> -->
            <!-- <visibility>protected</visibility> -->
            <!-- <visibility>private</visibility> -->
            <!-- <visibility>internal</visibility> -->
            <!-- <visibility>hidden</visibility> -->
            
            <!-- 
                Setup the tags that shoud be ignored while scaning source code
                - multiple tags can be specified
            -->
            <ignore-tags>
                <ignore-tag>author</ignore-tag>
                <ignore-tag>version</ignore-tag>
                <ignore-tag>copyright</ignore-tag>
                <ignore-tag>codeCoverageIgnore</ignore-tag>
            </ignore-tags>
        </api>
    </version>
    <!-- the path to the template from the phpdoc2githubwiki repository -->
    <template name="[path-to-phpdoc2githubwiki-repository]/template"/>
</phpdocumentor>
For more information send a message to info at phpclasses dot org.