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

Update the documentation to show when a parameter is a copy or a reference

    XMLWordPrintable

Details

    • Bug
    • Resolution: Fixed
    • Major
    • 1.2.0
    • 1.1.2
    • docs
    • Security Level: Public
    • None

    Description

      When I look at the PHP core documentation I see when a parameter is a reference or not. (so we should review all our function documentation)

      For example if you look at:
      http://www.php.net/sort

      Not only I know the type but also when it is a reference it is mentionned as &$array

      I think we should do the same in our documentation, when I see our API with cas, for example:
      http://www.couchbase.com/docs/couchbase-sdk-php-1.1/api-reference-retrieve-get.html#table-couchbase-sdk_php_get

      it is not clear to me.

      Attachments

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

        Activity

          People

            brett19 Brett Lawson
            tgrall Tug Grall (Inactive)
            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