4 Replies Latest reply on Feb 24, 2005 9:40 AM by James Adams

    JBoss API documentation (JavaDoc)

    James Adams Novice

      I have searched for JBoss API documentation but have had no luck. I'm trying to find JavaDocs such as those available for the J2SE and J2EE APIs. Can someone tell me whether or not such documentation exists, and if so then what is the URI to use for downloading it and/or to accessing it online ?

      Thanks in advance.


      --James

        • 1. Re: JBoss API documentation (JavaDoc)
          Deepkaran Singh Newbie

          For generating javadocs
          1) one has to get the jboss source from sourceforge site.

          http://sourceforge.net/project/showfiles.php?group_id=22866&package_id=16942&release_id=254646

          for example I got jboss-4.0.0-src.tar.gz

          2) unzip and untar it

          3) ./build.sh docs

          On windows you may use winzip to extract the zip and execute
          build docs

          ----

          • 2. Re: JBoss API documentation (JavaDoc)
            James Adams Novice

            I have unzipped and untarred the source distribution.

            I went into the build directory and ran the build command as suggested:

            $ cd jboss-4.0.1-src/build
            $ ./build.sh docs


            Here is the output and error message:

            Searching for build.xml ...
            Buildfile: c:\Home\Software\JBoss\jboss-4.0.1-src\build\build.xml
            
            _buildmagic:init:
            Trying to override old definition of task property
            
            _buildmagic:init:local-properties:
            
            _buildmagic:init:buildlog:
            
            configure:
             [echo] groups: default
             [echo] modules: common,jmx,system,naming,aop,j2ee,transaction,server,deployment,security,messaging,connector,jaxrpc,jboss.net,webservice,remoting,cluster,varia,iiop,management,cache,tomcat,console,compatibility,aspects,media,hibernate
            
            init:
            
            docs-javadocs:
            
            _buildmagic:init:
            
            init:
            
            docs-javadocs-check:
            
            docs-javadocs_1_4:
             [mkdir] Created dir: C:\Home\Software\JBoss\jboss-4.0.1-src\build\${build.api}
             [mkdir] Created dir: C:\Home\Software\JBoss\jboss-4.0.1-src\build\${build.docs}
            
            BUILD FAILED
            C:\Home\Software\JBoss\jboss-4.0.1-src\tools\etc\buildmagic\buildmagic.ent:706:
             C:\Home\Software\JBoss\jboss-4.0.1-src\build\${source.java} not found.
            



            I am running this on a Windows XP machine using Cygwin bash shell. Any suggestions as to where I have gone wrong or what I might do to fix this ?

            Thanks in advance.


            --James

            • 3. Re: JBoss API documentation (JavaDoc)
              Jimmy Wilson Apprentice

              I experienced a very similar build failed message when trying to use the docs target with JBoss 3.2.4/3.2.6. See forum post/thread http://www.jboss.org/index.html?module=bb&op=viewtopic&p=3862405. Unfortunately, the suggested workaround resulted in other build failures.

              Since using this same, advertised, target in the 4.x branch seems to fail with a similar issue, I wonder if this issue deserves bug report in JIRA.

              • 4. Re: JBoss API documentation (JavaDoc)
                James Adams Novice

                Why can't someone at JBoss just create the JavaDocs and package them for download, as is the case for the Java API documentation ?

                --James