Please have javadocs link to Sun Java API

[GoogleCodeExporter]

The supplied patch (use patch -U < pom.xml.diff) will make the Javadoc
generator automatically link standard java classes to Sun's API
documentation at 

http://java.sun.com/javase/6/docs/api/

Original issue reported on code.google.com by infinity0x@gmail.com on 7 Aug 2009 at 10:28

Attachments:

• pom.xml.diff

[GoogleCodeExporter]

(sorry, ignore the comment about the -U, i was being stupid)

Original comment by infinity0x@gmail.com on 7 Aug 2009 at 10:33

[GoogleCodeExporter]

I have applied the patch but I could not find the link.
Where can I see it ?

Original comment by py4fun@gmail.com on 8 Aug 2009 at 6:02

• Removed labels: Type-Defect

[GoogleCodeExporter]

if you regenerate the javadocs, you'll see that (for example) all the 
references to
java.lang.Object (eg. class X extends Object) have been replaced with a link to 
the
API for Object :)

Original comment by infinity0x@gmail.com on 8 Aug 2009 at 8:14

[GoogleCodeExporter]

when I regenerate the javadocs with the patch applied I still see 
"java.lang.String".
Is there anything else required ? Do you see the links when you build locally ?
(I assume you build it with 'mvn clean site')

Original comment by aso...@gmail.com on 9 Aug 2009 at 10:57

[GoogleCodeExporter]

internet connection is required on the computer that builds the javadocs. there 
is a
way to do it without, but i don't know exactly how on maven. basically you need 
to
download http://java.sun.com/javase/6/docs/api/package-list and use 
"linkoffline"
instead of "link", and point to the local package-list

i was using "maven clean package" and i think maybe "maven javadoc:jar"...  try
deleting target/ and regenerating everything?

Original comment by infinity0x@gmail.com on 9 Aug 2009 at 2:15

[GoogleCodeExporter]

I do have an internet connection.
I tried to delete everything but the link did not appear either.
Can you please execute a command and attach the command with an example of 
generated
JavaDoc file ?

Original comment by aso...@gmail.com on 10 Aug 2009 at 8:17

[GoogleCodeExporter]

~/ext$ rm -rf snakeyaml/
~/ext$ hg clone https://snakeyaml.googlecode.com/hg/ snakeyaml
requesting all changes
adding changesets
adding manifests
adding file changes
added 880 changesets with 4107 changes to 1043 files
updating working directory
781 files updated, 0 files merged, 0 files removed, 0 files unresolved
~/ext$ cd snakeyaml/
~/ext/snakeyaml$ ls
src/, announcement.msg, AUTHORS, Eclipse-format.xml, LICENSE, pom.xml
~/ext/snakeyaml$ cat ../pom.xml.diff 
--- pom.xml 2009-08-07 23:25:08.000000000 +0100
+++ pom.xml.new 2009-08-07 23:26:31.000000000 +0100
@@ -205,6 +205,11 @@
            <plugin>
                <groupId>org.apache.maven.plugins</groupId>
                <artifactId>maven-javadoc-plugin</artifactId>
+               <configuration>
+                   <links>
+                       <link>http://java.sun.com/javase/6/docs/api/</link>
+                   </links>
+               </configuration>
                <reportSets>
                    <reportSet>
                        <id>html</id>
~/ext/snakeyaml$ patch < ../pom.xml.diff 
patching file pom.xml
~/ext/snakeyaml$ mvn clean package

[snip]

~/ext/snakeyaml$ cd target/apidocs/
~/ext/snakeyaml/target/apidocs$ grep -lR "javase/6" .
./constant-values.html
./serialized-form.html
./overview-tree.html
./org/yaml/snakeyaml/Dumper.html
./org/yaml/snakeyaml/error/YAMLException.html
./org/yaml/snakeyaml/error/package-tree.html
./org/yaml/snakeyaml/error/class-use/Mark.html
./org/yaml/snakeyaml/error/MarkedYAMLException.html
./org/yaml/snakeyaml/error/Mark.html
./org/yaml/snakeyaml/tokens/Token.html
./org/yaml/snakeyaml/tokens/DocumentEndToken.html
./org/yaml/snakeyaml/tokens/BlockMappingStartToken.html
./org/yaml/snakeyaml/tokens/FlowMappingEndToken.html
./org/yaml/snakeyaml/tokens/ScalarToken.html
./org/yaml/snakeyaml/tokens/KeyToken.html
./org/yaml/snakeyaml/tokens/BlockSequenceStartToken.html
./org/yaml/snakeyaml/tokens/package-tree.html
./org/yaml/snakeyaml/tokens/StreamStartToken.html
./org/yaml/snakeyaml/tokens/BlockEntryToken.html
./org/yaml/snakeyaml/tokens/class-use/Token.html
./org/yaml/snakeyaml/tokens/FlowEntryToken.html
./org/yaml/snakeyaml/tokens/AliasToken.html
./org/yaml/snakeyaml/tokens/ValueToken.html
./org/yaml/snakeyaml/tokens/FlowSequenceEndToken.html
./org/yaml/snakeyaml/tokens/FlowMappingStartToken.html
./org/yaml/snakeyaml/tokens/BlockEndToken.html
./org/yaml/snakeyaml/tokens/StreamEndToken.html
./org/yaml/snakeyaml/tokens/DocumentStartToken.html
./org/yaml/snakeyaml/tokens/AnchorToken.html
./org/yaml/snakeyaml/tokens/DirectiveToken.html
./org/yaml/snakeyaml/tokens/FlowSequenceStartToken.html
./org/yaml/snakeyaml/tokens/TagToken.html
./org/yaml/snakeyaml/introspector/MethodProperty.html
./org/yaml/snakeyaml/introspector/package-tree.html
./org/yaml/snakeyaml/introspector/Property.html
./org/yaml/snakeyaml/introspector/FieldProperty.html
./org/yaml/snakeyaml/JavaBeanLoader.html
./org/yaml/snakeyaml/util/package-tree.html
./org/yaml/snakeyaml/util/Base64Coder.html
./org/yaml/snakeyaml/Loader.html
./org/yaml/snakeyaml/serializer/SerializerException.html
./org/yaml/snakeyaml/serializer/Serializer.html
./org/yaml/snakeyaml/serializer/package-tree.html
./org/yaml/snakeyaml/serializer/class-use/Serializer.html
./org/yaml/snakeyaml/DumperOptions.LineBreak.html
./org/yaml/snakeyaml/reader/package-tree.html
./org/yaml/snakeyaml/reader/Reader.html
./org/yaml/snakeyaml/reader/UnicodeReader.html
./org/yaml/snakeyaml/reader/ReaderException.html
./org/yaml/snakeyaml/package-tree.html
./org/yaml/snakeyaml/emitter/package-tree.html
./org/yaml/snakeyaml/emitter/EmitterException.html
./org/yaml/snakeyaml/emitter/Emitter.html
./org/yaml/snakeyaml/TypeDescription.html
./org/yaml/snakeyaml/constructor/ConstructorException.html
./org/yaml/snakeyaml/constructor/Tuple.html
./org/yaml/snakeyaml/constructor/package-tree.html
./org/yaml/snakeyaml/constructor/SafeConstructor.html
./org/yaml/snakeyaml/constructor/class-use/Construct.html
./org/yaml/snakeyaml/constructor/Construct.html
./org/yaml/snakeyaml/constructor/Constructor.ConstructScalar.html
./org/yaml/snakeyaml/constructor/AbstractConstruct.html
./org/yaml/snakeyaml/constructor/Constructor.html
./org/yaml/snakeyaml/constructor/BaseConstructor.html
./org/yaml/snakeyaml/class-use/DumperOptions.LineBreak.html
./org/yaml/snakeyaml/class-use/DumperOptions.html
./org/yaml/snakeyaml/class-use/DumperOptions.ScalarStyle.html
./org/yaml/snakeyaml/class-use/DumperOptions.FlowStyle.html
./org/yaml/snakeyaml/class-use/DumperOptions.Version.html
./org/yaml/snakeyaml/JavaBeanParser.html
./org/yaml/snakeyaml/DumperOptions.html
./org/yaml/snakeyaml/scanner/Scanner.html
./org/yaml/snakeyaml/scanner/ScannerImpl.html
./org/yaml/snakeyaml/scanner/package-tree.html
./org/yaml/snakeyaml/scanner/ScannerException.html
./org/yaml/snakeyaml/DumperOptions.ScalarStyle.html
./org/yaml/snakeyaml/DumperOptions.FlowStyle.html
./org/yaml/snakeyaml/nodes/MappingNode.html
./org/yaml/snakeyaml/nodes/Node.html
./org/yaml/snakeyaml/nodes/CollectionNode.html
./org/yaml/snakeyaml/nodes/package-tree.html
./org/yaml/snakeyaml/nodes/class-use/MappingNode.html
./org/yaml/snakeyaml/nodes/class-use/Node.html
./org/yaml/snakeyaml/nodes/class-use/NodeTuple.html
./org/yaml/snakeyaml/nodes/class-use/SequenceNode.html
./org/yaml/snakeyaml/nodes/class-use/ScalarNode.html
./org/yaml/snakeyaml/nodes/class-use/NodeId.html
./org/yaml/snakeyaml/nodes/NodeTuple.html
./org/yaml/snakeyaml/nodes/SequenceNode.html
./org/yaml/snakeyaml/nodes/ScalarNode.html
./org/yaml/snakeyaml/nodes/NodeId.html
./org/yaml/snakeyaml/nodes/Tags.html
./org/yaml/snakeyaml/resolver/package-tree.html
./org/yaml/snakeyaml/resolver/class-use/Resolver.html
./org/yaml/snakeyaml/resolver/Resolver.html
./org/yaml/snakeyaml/events/MappingEndEvent.html
./org/yaml/snakeyaml/events/NodeEvent.html
./org/yaml/snakeyaml/events/package-tree.html
./org/yaml/snakeyaml/events/MappingStartEvent.html
./org/yaml/snakeyaml/events/SequenceStartEvent.html
./org/yaml/snakeyaml/events/CollectionStartEvent.html
./org/yaml/snakeyaml/events/class-use/Event.html
./org/yaml/snakeyaml/events/class-use/ImplicitTuple.html
./org/yaml/snakeyaml/events/StreamStartEvent.html
./org/yaml/snakeyaml/events/CollectionEndEvent.html
./org/yaml/snakeyaml/events/Event.html
./org/yaml/snakeyaml/events/ImplicitTuple.html
./org/yaml/snakeyaml/events/SequenceEndEvent.html
./org/yaml/snakeyaml/events/DocumentStartEvent.html
./org/yaml/snakeyaml/events/AliasEvent.html
./org/yaml/snakeyaml/events/DocumentEndEvent.html
./org/yaml/snakeyaml/events/ScalarEvent.html
./org/yaml/snakeyaml/events/StreamEndEvent.html
./org/yaml/snakeyaml/Yaml.html
./org/yaml/snakeyaml/DumperOptions.Version.html
./org/yaml/snakeyaml/composer/Composer.html
./org/yaml/snakeyaml/composer/package-tree.html
./org/yaml/snakeyaml/composer/ComposerException.html
./org/yaml/snakeyaml/representer/package-tree.html
./org/yaml/snakeyaml/representer/class-use/Represent.html
./org/yaml/snakeyaml/representer/Representer.html
./org/yaml/snakeyaml/representer/BaseRepresenter.html
./org/yaml/snakeyaml/representer/Represent.html
./org/yaml/snakeyaml/parser/ParserException.html
./org/yaml/snakeyaml/parser/package-tree.html
./org/yaml/snakeyaml/parser/ParserImpl.html
./org/yaml/snakeyaml/parser/Parser.html
./org/yaml/snakeyaml/JavaBeanDumper.html

Original comment by infinity0x@gmail.com on 10 Aug 2009 at 5:15

Attachments:

• Yaml.html

[GoogleCodeExporter]

also:

~/ext/snakeyaml/target/apidocs$ mvn --version
Maven version: 2.0.9
Java version: 1.6.0_0
OS name: "linux" version: "2.6.30-1-amd64" arch: "amd64" Family: "unix"

Original comment by infinity0x@gmail.com on 10 Aug 2009 at 5:44

[GoogleCodeExporter]

Thank you. I see the point now. I am afraid it is a bug in Maven.
target/apidocs does contain the link
target/site/apidocs does NOT contain the link

Unfortunately, I use the latter for the on-line documentation... :(

Original comment by py4fun@gmail.com on 10 Aug 2009 at 8:41

• Changed state: Fixed

[GoogleCodeExporter]

Original comment by aso...@gmail.com on 16 Aug 2009 at 10:31

• Added labels: Milestone-Release1.4

[GoogleCodeExporter]

Original comment by aso...@gmail.com on 16 Aug 2009 at 10:32