[PCBC-182] Update the documentation to show when a parameter is a copy or a reference Created: 17/Jan/13  Updated: 27/Sep/13  Resolved: 27/Sep/13

Status: Resolved
Project: Couchbase PHP client library
Component/s: docs
Affects Version/s: 1.1.2
Fix Version/s: 1.2.0
Security Level: Public

Type: Bug Priority: Major
Reporter: Tug Grall (Inactive) Assignee: Brett Lawson
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 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.



 Comments   
Comment by Trond Norbye [ 18/Jan/13 ]
As a workaround for now you should include couchbase-api.php in your project and have your IDE give you code completion ;)
Comment by Brett Lawson [ 26/Sep/13 ]
This information is now available through the API Reference which should be available shortly along with the updated documentation.
Generated at Wed Dec 17 13:59:12 CST 2014 using JIRA 5.2.4#845-sha1:c9f4cc41abe72fb236945343a1f485c2c844dac9.