[JCBC-185] autodocs don't have links to spymemcached methods (i.e., most of the API) Created: 14/Dec/12  Updated: 07/Jan/13  Resolved: 07/Jan/13

Status: Resolved
Project: Couchbase Java Client
Component/s: Documentation
Affects Version/s: 1.1.0
Fix Version/s: 1.1.1
Security Level: Public

Type: Improvement Priority: Major
Reporter: Tim Smith (Inactive) Assignee: MC Brown (Inactive)
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified
Environment: http://www.couchbase.com/autodocs/couchbase-java-client-1.1.0/


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


 Comments   
Comment by Michael Nitschinger [ 17/Dec/12 ]
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
Comment by MC Brown (Inactive) [ 17/Dec/12 ]
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.
Comment by MC Brown (Inactive) [ 07/Jan/13 ]
Fixed. The autodoc builds of the Couchbase client now include the spymemcached as a unified reference document.
Generated at Thu Apr 24 17:24:07 CDT 2014 using JIRA 5.2.4#845-sha1:c9f4cc41abe72fb236945343a1f485c2c844dac9.