Uploaded image for project: 'Couchbase PHP client library'
  1. Couchbase PHP client library
  2. PCBC-671

API Ref Bootstrap basics

    XMLWordPrintable

Details

    • Improvement
    • Resolution: Fixed
    • Major
    • None
    • 3.0.0
    • docs
    • 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

      Attachments

        No reviews matched the request. Check your Options in the drop-down menu of this sections header.

        Activity

          People

            charles.dixon Charles Dixon
            ingenthr Matt Ingenthron
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty