Where are the API javadocs?

[GoogleCodeExporter]

What steps will reproduce the problem?
1. Look on the Aparapi homepage for a link to the JavaDoc.
2. Click on all the links that seem likely to lead to the the JavaDoc.
3. Start clicking around randomly while pulling hair out.

What is the expected output? What do you see instead?
The JavaDocs. Everything but the JavaDocs.

What version of the product are you using? On what operating system?

Please provide any additional information below.

Original issue reported on code.google.com by oliver.c...@gmail.com on 28 Nov 2012 at 3:18

[GoogleCodeExporter]

If you downloaded the binary distribution, then you should have a copy of the 
Java doc in a dir called 'API'

If you have the source checked out, then try the following from the trunk dir. 

ant dist

This will create the java doc in the dist_<platform> dir 

I do not know how to make this available via the google project site. 

Gary

Original comment by frost.g...@gmail.com on 28 Nov 2012 at 12:40

[GoogleCodeExporter]

A couple of things:

1) The non-public Aparapi code base is essentially completely undocumented. 
We're slowly working on changing that. Your participation is completely welcome.

2) The public Aparapi code base is somewhat documented. Again, we're slowly 
working on fixing it. Again, your participation is completely welcome.

3) Google Code requires some work-arounds specifically related to Subversion in 
order to make Javadoc appear correctly online. We're done these modifications 
in a working branch of Aparapi located at 
http://aparapi.googlecode.com/svn/branches/aparapi-issues-71-44/com.amd.aparapi/
doc/api/index.html

4) Currently the Aparapi Google Code Wiki is the best place for API 
documentation until we get the the Javadoc issues worked out like we did in the 
branch code above.

Original comment by ryan.lam...@gmail.com on 28 Nov 2012 at 8:17

[GoogleCodeExporter]

Thanks for speedy responses, Gary and Ryan. Bummer about Google Code and 
JavaDoc issues. I have Aparapi checked out via subversion in Eclipse so it's 
easy enough to navigate around the API, I was just surprised by the lack of 
JavaDocs on the Aparapi project pages.

Have you considered moving to GitHub? I host a couple of projects on there and 
love it (and host JavaDocs on there, too), but I haven't used Google Code so 
can't make a fair comparison (I do like git a lot more than subversion, though).

Original comment by oliver.c...@gmail.com on 28 Nov 2012 at 10:08

[GoogleCodeExporter]

Actually I want to thank Ryan. I had no idea we could even do this.  I need to 
look at Ryan's branch (I owe him a code review!) so I will look how he did this 
for the branch, and see if we can make it visible from googlecode site. 

The Git-hub suggestion has come up numerous times ;).  Most recently when I 
presented at Denver JUG.  One of the organizers worked for Git hub and offered 
to help.  I need to look into this seriously.  I see Git-hub is certainly well 
represented WRT newer projects.

Gary 

Original comment by frost.g...@gmail.com on 28 Nov 2012 at 10:29

[GoogleCodeExporter]

No problem Gary.

The solution is making sure to add the following properties to your Subversion 
commit:

1) On the top-level documentation folder add "svn:mime-type" key and 
"text/html" value recursively to all files

2) On all individual files that are CSS change "text/html" value to "text/css"

3) On all individual files which are not HTML or CSS remove the "svn:mime-type" 
key

This is most easily performed in Eclipse using the Subclipse plug-in.

As far as GitHub is concerned, Google Code does support Mercurial, which would 
seem to make a lot of sense to try first unless a wholesale move from Google 
Code is desired.

Original comment by ryan.lam...@gmail.com on 28 Nov 2012 at 11:00

[GoogleCodeExporter]

I would cast my vote for git too. Git can import history from svn so it makes 
the change easy. Github is a good idea to go along with that, but google code 
also supports git, doesn't it? Guava has git in google code if I am not 
mistaken. 

Original comment by alex.kar...@gmail.com on 28 Nov 2012 at 11:21

[GoogleCodeExporter]

I was also suggesting Mercurial because that I believe that Mercurial is the 
DVCS used by OpenJDK, which will have an impact on any Project Sumatra 
developers.

Original comment by ryan.lam...@gmail.com on 29 Nov 2012 at 8:12

[GoogleCodeExporter]

Yes Ryan, I was thinking about Mercurial yesterday (was hacking on the Project 
Lambda code base).  My reasons for choosing SVN was merely for convenience, I 
was more familiar with SVN at the time we were considering Open-Sourcing 
Aparapi.   

There is a case for Aparapi and Sumatra converging at some point.  Maybe, a 
switch to Mercurial will help.  At this time I don't see a need to rush to 
either of these. 

Original comment by frost.g...@gmail.com on 29 Nov 2012 at 1:40

[GoogleCodeExporter]

I'm personally a fan of SVN and have absolutely no issue with it, especially 
with the latest version of SVN server. It doesn't always make sense to use DVCS 
when everyone has read/write access to the source code.

Where DVCS does seem to make the most sense is when you have a public 
repository and everyone has to submit patches, which can become unwieldy and 
was essentially why things like Git became so popular with Linux kernel 
developers.

Original comment by ryan.lam...@gmail.com on 29 Nov 2012 at 5:33

[GoogleCodeExporter]

Interesting article from Google:

http://code.google.com/p/support/wiki/DVCSAnalysis

Original comment by pnnl.edg...@gmail.com on 4 Sep 2013 at 5:24