Uploaded image for project: 'Couchbase Java Client'
  1. Couchbase Java Client
  2. JCBC-185

autodocs don't have links to spymemcached methods (i.e., most of the API)

    Details

      Description

      It's great to have the generated docs for the Java client available on the website. However, it is confusing for a lot of people because most of the API methods aren't documented there, they are inherited from spymemcached and the docs don't link to spymemcached classes.

      If it is technically possible, it would be great to have live links in the autodocs for all the methods, including spymemcached ones.

      If not, it would be good to have a disambiguation page or some kind of explanation that, to get a complete view of the api docs, one must read both the spymemcached and couchbase docs. And a link to http://www.couchbase.com/autodocs/java/spymemcached/2.8.3/index.html (or whatever the latest link is).

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

        Activity

        Hide
        daschl Michael Nitschinger added a comment -

        MC,

        is it possible to do this? I also think this would greatly benefit the clarity of the docs, but can you merge two codebases (spy and couchbase-client) into one autodoc, or can we at least provide both that link each-other?

        Thanks,
        Michael

        Show
        daschl Michael Nitschinger added a comment - MC, is it possible to do this? I also think this would greatly benefit the clarity of the docs, but can you merge two codebases (spy and couchbase-client) into one autodoc, or can we at least provide both that link each-other? Thanks, Michael
        Hide
        mccouch MC Brown (Inactive) added a comment -

        It is possible, but requires some changes to the way to I currently build the Javadoc content. I'll get this fixed.

        Longer term, the intention is for the content to be incorporated into the API reference material in the main documentation as a unified reference.

        Show
        mccouch MC Brown (Inactive) added a comment - It is possible, but requires some changes to the way to I currently build the Javadoc content. I'll get this fixed. Longer term, the intention is for the content to be incorporated into the API reference material in the main documentation as a unified reference.
        Hide
        mccouch MC Brown (Inactive) added a comment -

        Fixed. The autodoc builds of the Couchbase client now include the spymemcached as a unified reference document.

        Show
        mccouch MC Brown (Inactive) added a comment - Fixed. The autodoc builds of the Couchbase client now include the spymemcached as a unified reference document.

          People

          • Assignee:
            mccouch MC Brown (Inactive)
            Reporter:
            TimSmith Tim Smith (Inactive)
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Gerrit Reviews

              There are no open Gerrit changes