dev@glassfish.java.net

Re: can't generated Javadoc on Mac OS X, JDK 1.5

From: Lloyd Chambers <Lloyd.Chambers_at_Sun.COM>
Date: Thu, 07 Aug 2008 12:30:03 -0700

Thanks Jason!!!

..............................................
Lloyd Chambers
lloyd.chambers_at_sun.com
GlassFish team, admin




On Aug 7, 2008, at 12:26 PM, Jason Lee wrote:

> Alrighty. I have a fix, which I have committed. Basically, there
> were javadoc comments that had this: Map<attribute name, count>. The
> processor thought that was an achor tag and tried to do to it whatever
> it is that it does, and failed, becuase it's not valid. It tried to
> look up the error message in a bundle, but the key wasn't found, so
> the process bombed. I changed that part of the comment to be
> Map&lt;attribute name, count&gt;, which not only let the javadocs
> build, but will also make it display correctly in the browser. Here's
> the full diff:
>
> svn diff src/main/java/com/sun/appserv/management/ext/coverage/
> CoverageInfo.java
> Index: src/main/java/com/sun/appserv/management/ext/coverage/
> CoverageInfo.java
> ===================================================================
> --- src/main/java/com/sun/appserv/management/ext/coverage/
> CoverageInfo.java (revision
> 21662)
> +++ src/main/java/com/sun/appserv/management/ext/coverage/
> CoverageInfo.java (working
> copy)
> @@ -96,24 +96,24 @@
> public Set<String> getOperationsNotInvoked();
>
> /**
> - Get a Map<attribute name, count> of Attribute read failures
> + Get a Map&lt;attribute name, count&gt; of Attribute read
> failures
> for legal attributes.
> */
> public Map<String,Integer> getAttributeGetFailures();
>
> /**
> - Get a Map<attribute name, count> of Attribute write failures
> + Get a Map&lt;attribute name, count&gt; of Attribute write
> failures
> for legal attributes.
> */
> public Map<String,Integer> getAttributeSetFailures();
>
> /**
> - Get a Map<attribute name, count> of unknown Attribute
> accesses.
> + Get a Map&lt;attribute name, count&gt; of unknown Attribute
> accesses.
> */
> public Map<String,Integer> getUnknownAttributes();
>
> /**
> - Get a Map<operation name, count> of unknown operation
> accesses.
> + Get a Map&lt;operation name, count&gt; of unknown operation
> accesses.
> */
> public Map<String,Integer> getUnknownOperations();
>
>
> On Thu, Aug 7, 2008 at 2:06 PM, Jason Lee <jason_at_steeplesoft.com>
> wrote:
>> Two more things to note:
>>
>> It failed on jdk 5 on Linux, and if I remove
>> src/main/java/com/sun/appserv/management, the docs build correctly,
>> if
>> not incompletely. I'm slowly adding directories back in to see which
>> one causes the failure, then I'll camp out there.
>>
>> On Thu, Aug 7, 2008 at 1:52 PM, Lloyd Chambers <Lloyd.Chambers_at_sun.com
>> > wrote:
>>> Jason,
>>>
>>> Thanks, I'm in the midst of correcting all the javadoc errors.
>>> Feel free to
>>> commit, but I've already committed some changes, and there might be
>>> conflicts.
>>>
>>> It's not clear the bad links stuff is causing the problem.
>>>
>>> Lloyd
>>>
>>> ..............................................
>>> Lloyd Chambers
>>> lloyd.chambers_at_sun.com
>>> GlassFish team, admin
>>>
>>>
>>>
>>>
>>> On Aug 7, 2008, at 11:39 AM, Jason Lee wrote:
>>>
>>>> Lloyd, I'm seeing this to on Leopard. I thought it might be a
>>>> broken
>>>> @link element in the javadoc (because of
>>>> doclet.malformed_html_link_tag), so I went grepping, and managed to
>>>> find some that look wrong. With your blessing, I'll commit these
>>>> changes:
>>>>
>>>> Index:
>>>> src/main/java/org/glassfish/admin/amx/config/grizzly/
>>>> ProtocolConfig.java
>>>> ===================================================================
>>>> ---
>>>> src/main/java/org/glassfish/admin/amx/config/grizzly/
>>>> ProtocolConfig.java
>>>> (revision
>>>> 21662)
>>>> +++
>>>> src/main/java/org/glassfish/admin/amx/config/grizzly/
>>>> ProtocolConfig.java
>>>> (working
>>>> copy)
>>>> @@ -117,9 +117,9 @@
>>>> public void setOobInline(String oobInline);
>>>>
>>>> /**
>>>> - * Get the {_at_link Protocol> SSL configuration
>>>> + * Get the {_at_link Protocol} SSL configuration
>>>> *
>>>> - * @return the {_at_link Protocol> SSL configuration
>>>> + * @return the {_at_link Protocol} SSL configuration
>>>> */
>>>> public SSLConfig getSSLConfig();
>>>>
>>>> Index:
>>>> src/main/java/com/sun/appserv/management/config/
>>>> WebServiceEndpointConfigKeys.java
>>>> ===================================================================
>>>> ---
>>>> src/main/java/com/sun/appserv/management/config/
>>>> WebServiceEndpointConfigKeys.java
>>>> (revision
>>>> 21662)
>>>> +++
>>>> src/main/java/com/sun/appserv/management/config/
>>>> WebServiceEndpointConfigKeys.java
>>>> (working
>>>> copy)
>>>> @@ -54,11 +54,11 @@
>>>> public final static String JBI_ENABLED_KEY=
>>>> "JBIEnabled";
>>>>
>>>>
>>>> - /** Key for use with @link {
>>>> WebServiceEndpointConfigCR#createWebServiceEndpointConfig} */
>>>> + /** Key for use with {_at_link
>>>> WebServiceEndpointConfigCR#createWebServiceEndpointConfig} */
>>>> public final static String MONITORING_LEVEL_KEY =
>>>> "MonitoringLevel";
>>>>
>>>> - /** Key for use with @link {
>>>> WebServiceEndpointConfigCR#createWebServiceEndpointConfig} */
>>>> + /** Key for use with {_at_link
>>>> WebServiceEndpointConfigCR#createWebServiceEndpointConfig} */
>>>> public final static String
>>>> MAX_HISTORY_SIZE_KEY =
>>>> "MaxHistorySize";
>>>>
>>>> }
>>>> Index:
>>>> src/main/java/com/sun/appserv/management/config/
>>>> JDBCConnectionPoolConfigKeys.java
>>>> ===================================================================
>>>> ---
>>>> src/main/java/com/sun/appserv/management/config/
>>>> JDBCConnectionPoolConfigKeys.java
>>>> (revision
>>>> 21662)
>>>> +++
>>>> src/main/java/com/sun/appserv/management/config/
>>>> JDBCConnectionPoolConfigKeys.java
>>>> (working
>>>> copy)
>>>> @@ -61,36 +61,36 @@
>>>> public final static String
>>>> CONNECTION_VALIDATION_METHOD_KEY=
>>>> "connection-validation-method";
>>>>
>>>>
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String
>>>> VALIDATION_TABLE_NAME_KEY =
>>>> "validation-table-name";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String DATASOURCE_CLASSNAME_KEY
>>>> = "datasource-classname";
>>>> /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String,
>>>> Map)} */
>>>> public final static String FAIL_ALL_CONNECTIONS_KEY
>>>> = "fail-all-connections";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String IDLE_TIMEOUT_IN_SECONDS_KEY
>>>> =
>>>> "idle-timeout-in-seconds";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String
>>>> IS_CONNECTION_VALIDATION_REQUIRED_KEY=
>>>> "is-connection-validation-required";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String
>>>> IS_ISOLATION_LEVEL_GUARANTEED_KEY=
>>>> "is-isolation-level-guaranteed";
>>>> /**
>>>> - Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> + Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> See {_at_link IsolationValues}.
>>>> */
>>>> public final static String
>>>> TRANSACTION_ISOLATION_LEVEL_KEY=
>>>> "transaction-isolation-level";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String MAX_POOL_SIZE_KEY
>>>> = "max-pool-size";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String MAX_WAIT_TIME_MILLIS_KEY
>>>> =
>>>> "max-wait-time-in-millis";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String POOL_RESIZE_QUANTITY_KEY
>>>> = "pool-resize-quantity";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String
>>>> NON_TRANSACTIONAL_CONNECTIONS_KEY =
>>>> "non-transactional-connections";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String ALLOW_NON_COMPONENT_CALLERS_KEY =
>>>> "allow-non-component-callers";
>>>>
>>>> /**
>>>> - Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> + Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> Possible values:
>>>> <ul>
>>>> <li>javax.sql.DataSource</li>
>>>> @@ -99,13 +99,13 @@
>>>> </ul>
>>>> */
>>>> public final static String RES_TYPE_KEY
>>>> = "res-type";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String STEADY_POOL_SIZE_KEY
>>>> = "steady-pool-size";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String DATABASE_NAME_KEY
>>>> = "property.DatabaseName";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String DATABASE_USER_KEY
>>>> = "property.User";
>>>> - /** Key for use with @link {
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> + /** Key for use with {_at_link
>>>> DomainConfig#createJDBCConnectionPoolConfig(String, String, Map)}
>>>> */
>>>> public final static String DATABASE_PASSWORD_KEY
>>>> = "property.Password";
>>>> }
>>>>
>>>> Index: src/main/java/com/sun/appserv/management/base/Pathnames.java
>>>> ===================================================================
>>>> --- src/main/java/com/sun/appserv/management/base/Pathnames.java
>>>> (revision
>>>> 21662)
>>>> +++ src/main/java/com/sun/appserv/management/base/Pathnames.java
>>>> (working copy)
>>>> @@ -49,7 +49,7 @@
>>>> <li>root -- represents {_at_link
>>>> com.sun.appserv.management.DomainRoot}</li>
>>>> <li>root.SystemStatus -- represents {_at_link
>>>> com.sun.appserv.management.base.SystemStatus}</li>
>>>> <li>root.domain -- represents {_at_link
>>>> com.sun.appserv.management.config.DomainConfig}</li>
>>>> - <li>root.domain.servers.server -- represents {_at_link
>>>> com.sun.appserv.management.config.ServerConfig 'server'}</li>
>>>> + <li>root.domain.servers.server -- represents {_at_link
>>>> com.sun.appserv.management.config.ServerConfig} 'server'</li>
>>>> </ul>
>>>> <p>
>>>> A 'target' of a dotted name is the AMX MBean to which it
>>>> resolves.
>>>>
>>>>
>>>> On Thu, Aug 7, 2008 at 1:15 PM, Lloyd Chambers <Lloyd.Chambers_at_sun.com
>>>> >
>>>> wrote:
>>>>>
>>>>> Anyone know what might be causing this?
>>>>>
>>>>> MB2:amx-api lloyd$ mvn javadoc:javadoc
>>>>>
>>>>> ...
>>>>>
>>>>> java.util.MissingResourceException: Can't find resource for bundle
>>>>> com.sun.tools.doclets.formats.html.resources.standard, key
>>>>> doclet.malformed_html_link_tag
>>>>> at java.util.ResourceBundle.getObject(ResourceBundle.java:325)
>>>>> at java.util.ResourceBundle.getString(ResourceBundle.java:285)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .internal
>>>>> .toolkit.util.MessageRetriever.getText(MessageRetriever.java:114)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .internal
>>>>> .toolkit.util.MessageRetriever.getText(MessageRetriever.java:92)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .internal
>>>>> .toolkit.util.MessageRetriever.getText(MessageRetriever.java:81)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .internal
>>>>> .toolkit.util.MessageRetriever.warning(MessageRetriever.java:290)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html
>>>>> .HtmlDocletWriter.redirectRelativeLinks(HtmlDocletWriter.java:
>>>>> 1526)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html.HtmlDocletWriter.commentTagsToString(HtmlDocletWriter.java:
>>>>> 1438)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html.HtmlDocletWriter.printCommentTags(HtmlDocletWriter.java:
>>>>> 1397)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html.HtmlDocletWriter.printSummaryComment(HtmlDocletWriter.java:
>>>>> 1370)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html.HtmlDocletWriter.printSummaryComment(HtmlDocletWriter.java:
>>>>> 1366)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html.AbstractIndexWriter.printComment(AbstractIndexWriter.java:
>>>>> 192)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html
>>>>> .AbstractIndexWriter.printDescription(AbstractIndexWriter.java:
>>>>> 164)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html
>>>>> .AbstractIndexWriter.generateContents(AbstractIndexWriter.java:89)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats
>>>>> .html.SingleIndexWriter.generateIndexFile(SingleIndexWriter.java:
>>>>> 76)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats.html.SingleIndexWriter.generate(SingleIndexWriter.java:
>>>>> 52)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .formats.html.HtmlDoclet.generateOtherFiles(HtmlDoclet.java:103)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .internal
>>>>> .toolkit.AbstractDoclet.startGeneration(AbstractDoclet.java:122)
>>>>> at
>>>>>
>>>>> com
>>>>> .sun
>>>>> .tools
>>>>> .doclets
>>>>> .internal.toolkit.AbstractDoclet.start(AbstractDoclet.java:64)
>>>>> at
>>>>> com
>>>>> .sun.tools.doclets.formats.html.HtmlDoclet.start(HtmlDoclet.java:
>>>>> 42)
>>>>> at
>>>>> com.sun.tools.doclets.standard.Standard.start(Standard.java:23)
>>>>> at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method)
>>>>> at
>>>>>
>>>>> sun
>>>>> .reflect
>>>>> .NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39)
>>>>> at
>>>>>
>>>>> sun
>>>>> .reflect
>>>>> .DelegatingMethodAccessorImpl
>>>>> .invoke(DelegatingMethodAccessorImpl.java:25)
>>>>> at java.lang.reflect.Method.invoke(Method.java:585)
>>>>> at
>>>>> com.sun.tools.javadoc.DocletInvoker.invoke(DocletInvoker.java:269)
>>>>> at
>>>>> com.sun.tools.javadoc.DocletInvoker.start(DocletInvoker.java:143)
>>>>> at com.sun.tools.javadoc.Start.parseAndExecute(Start.java:340)
>>>>> at com.sun.tools.javadoc.Start.begin(Start.java:128)
>>>>> at com.sun.tools.javadoc.Main.execute(Main.java:41)
>>>>> at com.sun.tools.javadoc.Main.main(Main.java:31)
>>>>>
>>>>> Command line was:"cd /v3/code/common/amx-api/target/site/apidocs
>>>>> &&
>>>>>
>>>>> /System/Library/Frameworks/JavaVM.framework/Versions/1.5.0/Home/
>>>>> bin/javadoc"
>>>>> @options @packages
>>>>>
>>>>>
>>>>> ..............................................
>>>>> Lloyd Chambers
>>>>> lloyd.chambers_at_sun.com
>>>>> GlassFish team, admin
>>>>>
>>>>>
>>>>>
>>>>>
>>>>>
>>>>> ---------------------------------------------------------------------
>>>>> To unsubscribe, e-mail: dev-unsubscribe_at_glassfish.dev.java.net
>>>>> For additional commands, e-mail: dev-help_at_glassfish.dev.java.net
>>>>>
>>>>>
>>>>
>>>>
>>>>
>>>> --
>>>> Jason Lee, SCJP
>>>> Senior Java Developer, Sun Microsystems
>>>> Mojarra and Mojarra Scales Dev Team
>>>> https://mojarra.dev.java.net
>>>> https://scales.dev.java.net
>>>> http://blogs.steeplesoft.com
>>>>
>>>> ---------------------------------------------------------------------
>>>> To unsubscribe, e-mail: dev-unsubscribe_at_glassfish.dev.java.net
>>>> For additional commands, e-mail: dev-help_at_glassfish.dev.java.net
>>>>
>>>
>>>
>>> ---------------------------------------------------------------------
>>> To unsubscribe, e-mail: dev-unsubscribe_at_glassfish.dev.java.net
>>> For additional commands, e-mail: dev-help_at_glassfish.dev.java.net
>>>
>>>
>>
>>
>>
>> --
>> Jason Lee, SCJP
>> Senior Java Developer, Sun Microsystems
>> Mojarra and Mojarra Scales Dev Team
>> https://mojarra.dev.java.net
>> https://scales.dev.java.net
>> http://blogs.steeplesoft.com
>>
>
>
>
> --
> Jason Lee, SCJP
> Senior Java Developer, Sun Microsystems
> Mojarra and Mojarra Scales Dev Team
> https://mojarra.dev.java.net
> https://scales.dev.java.net
> http://blogs.steeplesoft.com
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscribe_at_glassfish.dev.java.net
> For additional commands, e-mail: dev-help_at_glassfish.dev.java.net
>