Skip to content

Instantly share code, notes, and snippets.

@simonhughes
Created May 10, 2018 11:15
Show Gist options
  • Save simonhughes/d1e9218ef409da8110886ce4e4ccd577 to your computer and use it in GitHub Desktop.
Save simonhughes/d1e9218ef409da8110886ce4e4ccd577 to your computer and use it in GitHub Desktop.
An example phpdocs config for a Laravel project type.
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
<target>output</target>
<encoding>utf8</encoding>
<parser>
<target>docs</target>
<markers>
<item>TODO</item>
<item>FIXME</item>
</markers>
<extensions>
<extension>php</extension>
<extension>php3</extension>
<extension>phtml</extension>
</extensions>
</parser>
<transformer>
<target>docs</target>
</transformer>
<files>
<directory>./app</directory>
<directory>./config</directory>
<directory>./database</directory>
<directory>./routes</directory>
<directory>./templates</directory>
</files>
</phpdoc>
@simonhughes
Copy link
Author

simonhughes commented Jun 8, 2018

  1. Download: http://www.phpdoc.org/phpDocumentor.phar
  2. Move to location in your $PATH
  3. Rename mv phpDocumentor.phar phpdoc
  4. Test phpdoc fires
  5. cd into project
  6. Copy above config into project. Run phpdoc
  7. Open docs/index.html in your browser

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment