Skip to content

Commit

Permalink
Enable API documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
kriss0r committed Jul 24, 2013
1 parent 117b38c commit 3d87ebc
Show file tree
Hide file tree
Showing 2 changed files with 90 additions and 6 deletions.
12 changes: 6 additions & 6 deletions build.xml
Expand Up @@ -100,12 +100,12 @@
</exec>
</target>

<target name="phpdoc" description="Generate API documentation using phpDocumentor">
<exec executable="phpdoc">
<arg value="--directory" />
<arg path="${basedir}/library/Erfurt" />
<arg value="--target" />
<arg path="${basedir}/build/api" />
<target name="phpdoc" description="Create API doc using DocCreator">
<exec dir="/opt/DocCreator/" executable="php">
<arg value="/opt/DocCreator/create.php5" />
<arg value="--config-file=${basedir}/build/doc.erfurt.xml" />
<arg value="--source-folder=${basedir}/application/" />
<arg value="--target-folder=${basedir}/build/api/" />
</exec>
</target>

Expand Down
84 changes: 84 additions & 0 deletions build/doc.erfurt.xml
@@ -0,0 +1,84 @@
<?xml version="1.0"?>
<config>

<!-- PROJECTS -->
<projects>
<project label="Erfurt" version="head" date="" revision="">
<path alt="must be absolute">[]</path>
<extensions>
<extension>php</extension>
</extensions>
<ignore>
<file alt="regular expression">/^(_|[a-z])/</file>
<folder alt="regular expression">#^Sparql#</folder>
<folder alt="regular expression">#tests#</folder>
<folder alt="regular expression">#antlr#</folder>
</ignore>
<category lowercase="" by="force">Erfurt</category>
<package lowercase="" by="default">Erfurt</package>
</project>
</projects>

<!-- READER SETTINGS -->
<reader>
<plugin>Statistics</plugin>
<plugin>Unicode</plugin>
<plugin>Defaults</plugin>
<plugin>Relations</plugin>
<plugin>Primitives</plugin>
<plugin>Search</plugin>
<plugin>Triggers</plugin>
</reader>

<!-- BUILDERS -->
<builders>
<builder format="HTML" theme="HTML-OW">
<path type="target" alt="must be absolute">[]</path>
<path type="documents" alt="must be absolute"></path>
<language>en</language>
<title>Erfurt</title>
<logo>
<source>ow-logo_med.png</source>
<link>http://ontowiki.net/Projects/Erfurt</link>
<title>Erfurt @ AKSW</title>
</logo>
<author></author>
<company>AKSW (aksw.org)</company>
<timezone>Europe/Berlin</timezone>
<options>
<option name="showSourceCode">1</option>
</options>
<plugins>
<plugin>Home</plugin>
<plugin>ClassList</plugin>
<plugin>Search</plugin>
<plugin>About</plugin>
<plugin>Installation</plugin>
<plugin>History</plugin>
<plugin>Changes</plugin>
<plugin>Deprecations</plugin>
<plugin>Todos</plugin>
<plugin>Bugs</plugin>
<plugin>ParseErrors</plugin>
<plugin>Statistics</plugin>
<plugin>UnusedVariables</plugin>
<plugin>MethodOrder</plugin>
<plugin>MethodAccess</plugin>
<plugin>DocHints</plugin>
<plugin>Triggers</plugin>
</plugins>
</builder>
</builders>

<!-- GENERAL SETTINGS -->
<creator>
<timeLimit>360</timeLimit>
<mail></mail>
<file type="serial" alt="relative to 'doc.path'">doc.serial</file>
<file type="archive" alt="relative to 'doc.path'">doc.serial.gz</file>
<file type="errors">logs/docCreatorErrors.log</file>
<skip parser="FALSE" creator="FALSE" info="FALSE" resources="FALSE"/>
<verbose general="TRUE" skip="TRUE" config="FALSE" info="TRUE"/>
</creator>

</config>

0 comments on commit 3d87ebc

Please sign in to comment.