documentation configuration file

Post modules, themes or any other code you want to share with the community.

Moderator: Developers

richarddodd
Posts: 66
Joined: Fri Jun 21, 2013 2:55 pm

documentation configuration file

Postby richarddodd » Fri Jun 06, 2014 4:19 pm

Hi

Here's a config file for for phpDocumentor2 (best php doc gen I've seen). It excludes the vendor 3rd party libs.

Rich

file:phpdoc.xml

Code: Select all

<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
   <parser>
      <target>doc/cache</target>
   </parser>
   <transformer>
      <target>doc</target>
   </transformer>
   <files>
      <directory>www</directory>
      <ignore>www/vendor/*</ignore>
      <ignore>www/go/vendor/*</ignore>
      <ignore>www/modules/chat/xmpp-prebind-php/lib/*</ignore>
      <ignore>www/modules/site/widget</ignore>
   </files>
</phpdoc>
richarddodd
Posts: 66
Joined: Fri Jun 21, 2013 2:55 pm

Re: documentation configuration file

Postby richarddodd » Fri Jun 06, 2014 4:20 pm

you might need to create `doc` and `doc/cache` folders

Return to “Contributed development”

Who is online

Users browsing this forum: No registered users and 1 guest