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

It seems that the online reference is broken

    XMLWordPrintable

Details

    • Bug
    • Resolution: Unresolved
    • Major
    • None
    • 3.2.2
    • docs
    • None
    • Any, tried accessing online reference for libcouchbase (Couchbase C client) on Linux (Chrome and Firefox) and on Mac (Safari).
    • 1

    Description

      I am looking at the latest official Couchbase C Client online reference:

      https://docs.couchbase.com/sdk-api/couchbase-c-client-3.2.2/

      Trying for instance to find the manual for lcb_cmdquery_locktime (just an example).

      First, the top level sections seem to be wrong, they are Examples, Reporting Issues, Thread Safety and Introduction. It does not make sense.

      If you click on "Modules" it opens up a section at the same level ("Collections Management"). This section contains "Public API". I do not think this is correct.

      Inside "Public API", same thing, it opens "Operation Metrics" at the top level.

      Then if you click on "Key/Value" same thing. 

      If you then click on "Read". it opens two random entries.

      Clicking on lcb_RESPGET leads to a long page where signatures are not clickable (no URL associated). One of them is the signature for lcb_cmdquery_locktime. There does not seem to be a way to obtain any information on that function. Somehow randomly the signature for lcb_cmdget_on_behalf_of is clickable and the documentation is somewhere below.

      I thought initially it was my browser on Linux. The behavior is the same on all platforms and browsers I tried.

      Would the automatic generation of the manual be broken? Or am I doing something wrong?

       

      Thanks!

       

       

      Attachments

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

        Activity

          People

            avsej Sergey Avseyev
            vincent.lextrait Vincent Lextrait
            Votes:
            0 Vote for this issue
            Watchers:
            3 Start watching this issue

            Dates

              Created:
              Updated:

              Gerrit Reviews

                There are no open Gerrit changes

                PagerDuty