Couchbase Java Client

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).

Activity

Ascending order - Click to sort in descending order
Hide
Permalink
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
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
Michael Nitschinger made changes -
Field Original Value New Value
Assignee Michael Nitschinger [ daschl ] MC Brown [ mccouch ]
Michael Nitschinger made changes -
Fix Version/s 1.1.1 [ 10430 ]
Hide
Permalink
MC Brown 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
MC Brown 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
Permalink
MC Brown added a comment -
Fixed. The autodoc builds of the Couchbase client now include the spymemcached as a unified reference document.
Show
MC Brown added a comment - Fixed. The autodoc builds of the Couchbase client now include the spymemcached as a unified reference document.
MC Brown made changes -
Status Open [ 1 ] Resolved [ 5 ]
Resolution Fixed [ 1 ]

People

  • Assignee:
    MC Brown
    Reporter:
    Tim Smith
Vote (0)
Watch (0)

Dates

  • Created:
    Updated:
    Resolved: