Uploaded image for project: 'Couchbase C client library libcouchbase'
  1. Couchbase C client library libcouchbase
  2. CCBC-87

error codes need additional documentation in types.h and a reference from couchbase.h

    Details

    • Type: Bug
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 2.0.0beta3
    • Component/s: docs
    • Security Level: Public
    • Labels:
      None

      Description

      Some error codes, like LIBCOUCHBASE_ETMPFAIL, are defined to be returned for certain functions, but other functions don't tell users what may be returned from the header file or other documentation. It would be good to add this to the headers, but needs to be documented in some way.

        Issue Links

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

          Activity

          Hide
          avsej Sergey Avseyev added a comment -

          Now codes are separated

          Show
          avsej Sergey Avseyev added a comment - Now codes are separated
          Hide
          ingenthr Matt Ingenthron added a comment -

          Karen: need your help updating this

          Show
          ingenthr Matt Ingenthron added a comment - Karen: need your help updating this
          Hide
          ingenthr Matt Ingenthron added a comment -

          Plan on this one is to add:
          1) a reference from libcouchbase/couchbase.h to the libcouchbase/types.h
          2) add additional text to types.h on what needs to be there

          Show
          ingenthr Matt Ingenthron added a comment - Plan on this one is to add: 1) a reference from libcouchbase/couchbase.h to the libcouchbase/types.h 2) add additional text to types.h on what needs to be there
          Show
          trond Trond Norbye added a comment - http://review.couchbase.org/#/c/21958/1

            People

            • Assignee:
              trond Trond Norbye
              Reporter:
              ingenthr Matt Ingenthron
            • Votes:
              0 Vote for this issue
              Watchers:
              0 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:

                Gerrit Reviews

                There are no open Gerrit changes