Procedure for updating javadoc?

[Paul Bourke]

Hi Toby / All, 

I was wondering what's the preferred procedure for updating the javadoc?  Do you do this for all API changes?  I currently have a change to make the Group, Photo and Size classes Serializable (https://github.com/brk3/FlickrjApi4Android/commit/db75dad5c2bedc261aa974265c94b5675155db51)

Should I regenerate the javadoc before committing, and how do I do this?  I'm still a bit unfamiliar with maven...

Cheers,

-Paul

[Yang Yu]

Hi Paul:

Thanks for contacting me!

It is preferably that the javadoc always get regenerated whenever we make an interface level change. Actually I check in all the javadoc files so that it would become available on Google Code:  http://flickrj-android.googlecode.com/git/flickrj-android/javadoc/index.html 

I have an instruction for how to build the project:  http://code.google.com/p/flickrj-android/wiki/HowToUploadNewBuilds. You can just simply execute mvn clean javadoc:javadoc install -DskipTests -Prelease

Please do let me know if you have further questions.

Toby

--

[Paul Bourke]

Thanks for the help Toby :)

So when I run the mvn command below, it seems to re-generate the docs in ./flickrj-android/target/site/apidocs, but this directory is in the .gitignore and so is not under revision control.

Will the "ant -Denv.gcode.user="XXX" -Denv.gcode.pwd=YYY" step copy them to flickrj-android/javadoc for commit, or is there anything else required here?

[Yang Yu]

Hi Paul:

  Did you run the build command "mvn clean javadoc:javadoc install -DskipTests -Prelease" directly from the root folder? Then the generated javadoc will be in the folder flickrj-android/javadoc.

  The ant command is used for uploading the binary library to http://code.google.com/p/flickrj-android/downloads/list, so that it could become available for those folks that do not want to check out source code.

  If you still having trouble building the javadoc, then just let me to handle it. Thanks for the help anyway!

Toby

--

[Paul Bourke]

Thanks again Toby, got it sorted.  I think I left out the -Prelease before.

Paul

[Yang Yu]

that's cool! it is the so called maven profile. welcome to the world of maven.

;-)