Clarification/Agreement on Javadocs Build Workaround

At this point, Phil needs clarification: if his workaround is OK, and clarify spymemcached is ours + what version we need to use....

Please assign to him to apply the workaround after you get a change to clarify.

-----------

Sent via email by Dipti 4/31.

-----------------------

Background:

Hi Wayne,

It is on jenkins@ubu-1702.hq.couchbase.com. You can access it on with the QA key, QAkey.pem.

The ANT file is supposed to build javadocs and rdocs and the problem we are encountering is that we had included third parties libraries (spymemcached) and it the latest javadoc generation they were not included.

Thanks,

Karen

-------

Wayne assigne to Phil and Phil investigates for several hours

----------------

From Phil:

From: Philip Labee <Philip@couchbase.com>
Date: Friday, April 19, 2013 2:07 PM
To: Matt Ingenthron <matt@couchbase.com>, Michael Nitschinger <Michael.Nitschinger@couchbase.com>
Cc: Karen Zeller <karen.zeller@couchbase.com>, Wayne Siu <Wayne@couchbase.com>
Subject: building javadocs for couchbase-java-client

Karen and I are following the directions for building the javadocs but it looks like these instructions are incomplete. Specifically they say to create a clean clone of couchbase-java-client and to run "ant docs" there, but the problem is that it only generates docs for our code, and misses all the net.spy.memcached docs because the spy.memcached source files are not in the build tree.

I could easily clone the spy.memcached source files into ~jenkins and then symlink the src/main/java/net files into the sr/main/java directory of the client build dir, but there's no evidence that this is how it was done before. If you know how this was done in previous releases which do include the docs for spy.memcached, let me know and we'll update the instructions and generate a complete set of javadocs. If we don't discover a known solution we'll proceed with the cloning and the symlinking. If we don't want to include third-party docs in our doc-set then there's nothing more to do.

net.spy.memcached docs included: http://www.couchbase.com/autodocs/couchbase-java-client-1.1.4c/index.html

Not included: http://www.couchbase.com/autodocs/couchbase-java-client-1.1.5/index.html

--Phil