Details
-
Improvement
-
Resolution: Fixed
-
Major
-
None
-
3.0.0
-
None
-
1
-
SDK13: Coll/Txn/Docs More Chip
Description
Add API ref docblocks for subj.
PHP SDK API described in the single file (PHP stub), which is used by phpDocumentor project to generate nice HTML documentation
https://github.com/couchbase/php-couchbase/blob/master/api/couchbase.php#L92
The task is to add php doc comments to the classes and methods.
To verify output the following steps might be used:
curl -L -o/tmp/phpdoc.phar curl https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0-rc/phpDocumentor.phar
|
|
php /tmp/phpdoc.phar -t /tmp/output -d api/
|
where api/ is a directory inside the PHP SDK source tree
After that, the docs will be available with the browser at file:///tmp/output/index.html