Create JavaDoc for Core Libraries about processing-docs HOT 15 CLOSED

The PDE for 3.0 has a JavaDoc for contributed libraries in the Help menu. Maybe adapt for Core Libraries?

from processing-docs.

Maybe this is a job for github pages? I guess we lost this when we moved from Google Code?

from processing-docs.

I'm glad to take this one and set-up a gh-pages repo for hosting the javadocs. Where do I pull them from?

from processing-docs.

I was able to get this online and available here:

http://processing.github.io/processing-javadocs/core/

This is the repo where I am storing the files:

https://github.com/processing/processing-javadocs/

I could rename the repo to "javadocs" only which would simplify the URL, but I chose to stay with the processing-x style.

What do you guys think?

from processing-docs.

Thanks Dan!

Interesting. We currently have Processing Core in GitHub here:
https://github.com/processing/processing/tree/master/build/javadoc/core
It shows up online here: http://processing.org/reference/javadoc/core/

This post was originally for making Javadocs for the Serial, Network, PDF, etc.

Maybe this new way is better with gh-pages for all of it?

from processing-docs.

Ok, I see. I now have the javadocs for "core", "everything", and "libraries" all here:

http://processing.github.io/processing-javadocs/core/
http://processing.github.io/processing-javadocs/libraries/
http://processing.github.io/processing-javadocs/everything/

I could also add libraries to everything and just have only that one javadocs, not sure whether it makes sense to have these three.

@REAS I don't have an opinion as to whether they are better here or on processing.org, but if I can make things easier for someone else by maintaining this I'm glad to.

@benfry the "docs" build in build.xml was broken for "everything" and I had to add something for "libraries". I don't really know ant but with some fiddling I made the following changes and got things to build. Shall I update build.xml in the repo? The changes I made are as follows:

Removed:

      <!--<packageset dir="../app/generated">
        <include name="processing/**" />
      </packageset>-->

Added:

    <!-- do libraries -->
    <exec executable="find" dir="javadoc" errorproperty="ignored">
      <arg line="libraries -type f -exec rm -rf {} ';'" />
    </exec>

    <javadoc access="public" author="false" classpath="../app/lib/ant.jar:../app/lib/ant-launcher.jar:../app/lib/antlr.jar:../app/lib/apple.jar:../app/lib/jna.jar:../app/lib/org-netbeans-swing-outline.jar:../core/bin:../core/library/gluegen-rt.jar:../core/library/jogl-all.jar:../java/libraries/svg/bin:../java/libraries/pdf/bin:../java/libraries/pdf/library/itext.jar:../java/libraries/dxf/bin:../java/libraries/net/bin:../java/libraries/serial/bin:../java/mode/ecj.jar:${java.home}/lib/tools.jar" destdir="javadoc/libraries" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" source="1.7" splitindex="false" use="false" version="false" noqualifier="all">

      <arg value="-notimestamp" />

      <arg value="-quiet" />

      <link href="http://docs.oracle.com/javase/7/docs/api/" />

      <packageset dir="../java/libraries/dxf/src">
        <include name="antlr/**" />
        <include name="processing/**" />
      </packageset>
      <packageset dir="../java/libraries/net/src">
        <include name="antlr/**" />
        <include name="processing/**" />
      </packageset>
      <packageset dir="../java/libraries/pdf/src">
        <include name="antlr/**" />
        <include name="processing/**" />
      </packageset>
      <packageset dir="../java/libraries/serial/src">
        <include name="antlr/**" />
        <include name="processing/**" />
      </packageset>
      <packageset dir="../java/libraries/svg/src">
        <include name="antlr/**" />
        <include name="processing/**" />
      </packageset>
    </javadoc>

from processing-docs.

If that's working, that seems fine?

from processing-docs.

Ok, these changes have been made to build.xml with processing/processing@7b0affc. @REAS if this all seems good to you, you can close.

from processing-docs.

Amazing Dan! I will close this after I link to these pages from the reference.

from processing-docs.

Great! I'll just note here that (at the moment) this is a manual process of copying the javadocs over which I can do when there are new releases. If for some reason I miss it, anyone on github should feel free to remind me.

from processing-docs.

@shiffman With the changes to made to build.xml the system we have in place is working for the Libraries: http://processing.org/reference/javadoc/libraries/

So, @benfry the question is -- should we use the new GitHub pages solution or stick with what we have?

Something to note, we have the full Javadoc HTML in processing/processing. I think we're redirecting to the checked out repo on the server to get the URL you see above:
https://github.com/processing/processing/tree/master/build/javadoc

from processing-docs.

Yes, let's use the Github pages option and keep 'em separate. In the past, we were serving the repo directly from the web server so it worked properly (that's why we we're getting that the weird redirect).

from processing-docs.

OK. Thanks. I'll first add the new links to the GitHub pages into the Reference and build that, then I'll remove the files within the javadoc folder in build and will add the javadoc folder to .ignore

from processing-docs.

Sounds good. Don't add the javadoc to ignore otherwise I think it may never be deleted from anyone else's machine when they git pull. Removing the build/javadoc folder should be all that's needed.

from processing-docs.

Ok, thanks @benfry and @shiffman. This is finished.

from processing-docs.