8 Replies Latest reply on Mar 1, 2006 8:42 AM by Tom Baeyens

    javadocs

    Administrator Administrator Novice

      hi, where to find the mc javadocs or how to create them ?

      i tried running the ant docs in the kernel module, but that gives a problem.

      i'm using a 1.5.0_06 JDK and ant 1.6.5.

      regards, tom.

        • 1. Re: javadocs
          Tom Baeyens Master

          some other questions...

          Is this correct ? After parsing the jboss-beans.xml, the XML information in collected in a KernelConfig object.

          In case that is correct, is there an example that shows how to build such a KernelConfig programmatically ?

          After that, i can use the Configurator.instantiate(...) to create objects that are described in the kernel config, right ?

          or am i completely missing the design ?

          regards, tom.

          • 2. Re: javadocs
            Adrian Brock Master

             

            "admin" wrote:
            hi, where to find the mc javadocs or how to create them ?

            i tried running the ant docs in the kernel module, but that gives a problem.


            Can you be less specific?


            • 3. Re: javadocs
              Adrian Brock Master

               

              "tom.baeyens@jboss.com" wrote:
              some other questions...

              Is this correct ? After parsing the jboss-beans.xml, the XML information in collected in a KernelConfig object.


              No. See the getting guide or the testsuite.
              The XML creates KernelDeployments or BeanMetaData objects via JBossXB.

              This example shows the preferred mechanism for using other people's schemas.
              http://wiki.jboss.org/wiki/Wiki.jsp?page=SchemaBindingInitializer
              in your own.


              • 4. Re: javadocs
                Adrian Brock Master

                The javadocs are built nighlty onto the main Microcontainer project page
                and they are included in the standalone release.

                • 5. Re: javadocs
                  Tom Baeyens Master

                  if you don't have that problem it will probably be something on my system.

                  anyways, here's the problem

                  docs-javadocs_1_4:
                   [mkdir] Created dir: C:\ws\jboss\jboss-head\kernel\output\api
                   [javadoc] Generating Javadoc
                   [javadoc] Javadoc execution
                   [javadoc] Loading source files for package org.jboss.beans.metadata.plugins...
                   [javadoc] Loading source files for package org.jboss.beans.metadata.plugins.factory...
                   [javadoc] Loading source files for package org.jboss.beans.metadata.spi...
                   [javadoc] Loading source files for package org.jboss.kernel...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.bootstrap...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.bootstrap.basic...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.bootstrap.standalone...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.config...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.config.property...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.config.xml...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.dependency...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.deployment...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.deployment.xml...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.event...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.registry...
                   [javadoc] Loading source files for package org.jboss.kernel.plugins.registry.basic...
                   [javadoc] Loading source files for package org.jboss.kernel.spi...
                   [javadoc] Loading source files for package org.jboss.kernel.spi.bootstrap...
                   [javadoc] Loading source files for package org.jboss.kernel.spi.config...
                   [javadoc] Loading source files for package org.jboss.kernel.spi.dependency...
                   [javadoc] Loading source files for package org.jboss.kernel.spi.deployment...
                   [javadoc] Loading source files for package org.jboss.kernel.spi.event...
                   [javadoc] Loading source files for package org.jboss.kernel.spi.registry...
                   [javadoc] Loading source files for package org.jboss.test.kernel.junit...
                   [javadoc] Constructing Javadoc information...
                   [javadoc] Standard Doclet version 1.5.0_06
                   [javadoc] Building tree for all the packages and classes...
                   [javadoc] C:\ws\jboss\jboss-head\kernel\src\main\org\jboss\beans\metadata\plugins\AbstractInstallMetaData.java:117: warning - @param argument "state" is not a parameter name.
                   [javadoc] Building index for all the packages and classes...
                   [javadoc] java.util.MissingResourceException: Can't find resource for bundle com.sun.tools.doclets.formats.html.resources.standard, key doclet.malformed_html_link_tag
                   [javadoc] at java.util.ResourceBundle.getObject(Unknown Source)
                   [javadoc] at java.util.ResourceBundle.getString(Unknown Source)
                   [javadoc] at com.sun.tools.doclets.internal.toolkit.util.MessageRetriever.getText(MessageRetriever.java:114)
                   [javadoc] at com.sun.tools.doclets.internal.toolkit.util.MessageRetriever.getText(MessageRetriever.java:92)
                   [javadoc] at com.sun.tools.doclets.internal.toolkit.util.MessageRetriever.getText(MessageRetriever.java:81)
                   [javadoc] at com.sun.tools.doclets.internal.toolkit.util.MessageRetriever.warning(MessageRetriever.java:290)
                   [javadoc] at com.sun.tools.doclets.formats.html.HtmlDocletWriter.redirectRelativeLinks(HtmlDocletWriter.java:1526)
                   [javadoc] at com.sun.tools.doclets.formats.html.HtmlDocletWriter.commentTagsToString(HtmlDocletWriter.java:1438)
                   [javadoc] at com.sun.tools.doclets.formats.html.HtmlDocletWriter.printCommentTags(HtmlDocletWriter.java:1397)
                   [javadoc] at com.sun.tools.doclets.formats.html.HtmlDocletWriter.printSummaryComment(HtmlDocletWriter.java:1370)
                   [javadoc] at com.sun.tools.doclets.formats.html.HtmlDocletWriter.printSummaryComment(HtmlDocletWriter.java:1366)
                   [javadoc] at com.sun.tools.doclets.formats.html.AbstractIndexWriter.printComment(AbstractIndexWriter.java:192)
                   [javadoc] at com.sun.tools.doclets.formats.html.AbstractIndexWriter.printDescription(AbstractIndexWriter.java:164)
                   [javadoc] at com.sun.tools.doclets.formats.html.AbstractIndexWriter.generateContents(AbstractIndexWriter.java:89)
                   [javadoc] at com.sun.tools.doclets.formats.html.SingleIndexWriter.generateIndexFile(SingleIndexWriter.java:76)
                   [javadoc] at com.sun.tools.doclets.formats.html.SingleIndexWriter.generate(SingleIndexWriter.java:52)
                   [javadoc] at com.sun.tools.doclets.formats.html.HtmlDoclet.generateOtherFiles(HtmlDoclet.java:103)
                   [javadoc] at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:122)
                   [javadoc] at com.sun.tools.doclets.internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
                   [javadoc] at com.sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:42)
                   [javadoc] at com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
                   [javadoc] at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
                   [javadoc] Generating C:\ws\jboss\jboss-head\kernel\output\api\index-all.html...
                   [javadoc] 1 warning
                   [javadoc] at sun.reflect.NativeMethodAccessorImpl.invoke(Unknown Source)
                   [javadoc] at sun.reflect.DelegatingMethodAccessorImpl.invoke(Unknown Source)
                   [javadoc] at java.lang.reflect.Method.invoke(Unknown Source)
                   [javadoc] at com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
                   [javadoc] at com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
                   [javadoc] at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
                   [javadoc] at com.sun.tools.javadoc.Start.begin(Start.java:128)
                   [javadoc] at com.sun.tools.javadoc.Main.execute(Main.java:41)
                   [javadoc] at com.sun.tools.javadoc.Main.main(Main.java:31)
                  



                  • 6. Re: javadocs
                    Kabir Khan Master

                    I occasionally get problems too when compiling javadocs using jdk 5. Try using jdk 1.4

                    • 7. Re: javadocs
                      Adrian Brock Master

                       

                      java.util.MissingResourceException: Can't find resource for bundle com.sun.tools.doclets
                      .formats.html.resources.standard, key doclet.malformed_html_link_tag


                      This looks like some issue with the JDK?
                      I don't see any reference to com.sun.tools in the build scripts.

                      The underlying issue looks like it is trying to warn about a broken link tag in the javadoc.

                      I don't use link tags so you might want to grep for classes with
                      Hazelwood in the author tag to try to pin it down (and remove it?) :-)

                      • 8. Re: javadocs
                        Tom Baeyens Master

                        the javadocs get generated with 1.4.2

                        thanks !

                        regards, tom.