Remove phpdoc config in favor of apigen.

This commit is contained in:
Ben Ramsey
2014-09-02 14:52:50 -05:00
parent fa84298c14
commit 41dcfcd8e2
3 changed files with 18 additions and 19 deletions
+3 -3
View File
@@ -32,9 +32,9 @@ Much inspiration for this library came from the [Java][javauuid] and
## API Documentation
The [latest class API documentation][apidocs] is available online. This project
uses [phpDocumentor](http://phpdoc.org/) to generate this documentation. To
generate the documentation on your own, run `phpdoc` from the root of the project.
This will generate documentation in the `docs/` folder.
uses [ApiGen](http://apigen.org/) to generate this documentation. To
generate the documentation on your own, run `apigen` from the root of the project.
This will generate documentation in the `build/apidocs/` folder.
## Requirements
+15
View File
@@ -0,0 +1,15 @@
# apigen configuration
# This uses the NEON file format: http://ne-on.org/
source:
- src
destination: build/apidocs
title: Rhumsaa\Uuid
main: Rhumsaa
deprecated: Yes
todo: Yes
sourceCode: Yes
report: build/apigen-checkstyle.xml
wipeout: Yes
quiet: No
progressbar: Yes
colors: Yes
-16
View File
@@ -1,16 +0,0 @@
<?xml version="1.0" encoding="UTF-8" ?>
<phpdoc>
<title>Rhumsaa\Uuid</title>
<parser>
<target>build/phpdoc</target>
</parser>
<transformer>
<target>docs</target>
</transformer>
<transformations>
<template name="responsive" />
</transformations>
<files>
<directory>./src</directory>
</files>
</phpdoc>