5 Replies Latest reply on Mar 30, 2004 11:25 PM by kenny1

    advice on building api docs

    mikea-xoba

      hi folks,

      i apologize in advance if this is not the right forum, but it was the only forum concerned with 'builds' per se ---

      i can build and run a jboss-3.2 snapshot server fine, by executing 'build.sh', which in turn calls ant. but this target doesn't seem to build any javadoc documentation.

      so when i do 'build.sh docs' which i think is supposed to build the api docs, i get an error caused by the ant variable 'source.java' not being defined. i'm very familiar with ant, but not so much with this 'buildmagic' thing, nor with calling ant via a shell script. plus, the jboss build system is so huge, i feel a bit lost.

      anything i'm doing wrong? or what's the intended way to build the javadocs? any general advice on the build infrastructure would be appreciated too.

      thanks,
      mike

        • 1. Re: advice on building api docs
          mikea-xoba

          i can get a bit further when running 'build.sh all' (which includes docs in its dependencies), but it stops after a few minutes (apparently building jmx docs) with an error in buildmagic.ent line 662 saying 'reference javadoc.classpath not found'. i see 'javadoc.classpath' is defined in the '_default:task-init' task, so i'm a bit confused as to why the build is not picking that up if the dependencies are set correctly --- especially with such a central target as 'all'.

          it does seem to generate the JBoss/Common javadocs fine, but that's all.

          mike

          • 2. Re: advice on building api docs

            It works fine for me.

            The docs build was broken in earlier versions of 3.2.x which version are you using?

            Regards,
            Adrian

            • 3. Re: advice on building api docs
              mikea-xoba

              right now i'm using the latest anonymous cvs tagged 'Branch_3_2', and i did a 'cvs update -d' this morning...

              on a related note, does jboss group maintain an online javadoc api? i could also use that if the doc build continues to prove troublesome for me. e.g., like sun's http://java.sun.com/j2se/1.4.2/docs/api/

              mike

              • 4. Re: advice on building api docs

                No. Many developers don't even write javadocs.

                Regards,
                Adrian

                • 5. Re: advice on building api docs
                  kenny1

                   

                  "adrian@jboss.org" wrote:
                  No. Many developers don't even write javadocs.

                  Regards,
                  Adrian


                  This is sad. I was learning jboss and its jmx implementation. As a newbie, I find having adequate documentation and javadoc(if its language is java) is just as important as having quality developers on a project. This is especially true for open source projects.
                  Since jboss is a huge project, I hope someone could point me to a right direction, I will be willing to get started on the doc thing and thus benefit other people.