Sunday, November 13, 2011

Seamless access to the Java SE API documentation

API documentation for Java SE and Hadoop (and other frameworks) can be downloaded for offline access. But, the Hadoop API documentation is not aware of the offline copy of Java SE documentation.

For seamless interaction between the two API, reference to

http://java.sun.com/....../ConcurrentLinkedQueue.html

in the Hadoop API should be replaced with

file:///home/praveensripati/....../ConcurrentLinkedQueue.html

The below command will replace all such references in the API documentation (note that back slash has to be escaped)

find  ./ -type f -name *.html -exec sed -i 's/http:\/\/java.sun.com\/javase\/6\/docs\//file:\/\/\/home\/praveensripati\/Documents\/Java6API\//' {} \;

This enables for seamless offline access and better productivity.

2 comments:

  1. Hi,

    Would you know where I can download a copy of the Hadoop API documentation for version 1.0.3??? It's this page:

    http://hadoop.apache.org/common/docs/r1.0.3/api/

    That I want to access offline.

    Many thanks.

    ReplyDelete
    Replies
    1. Looks like the API docs is not bundled with the jars. You should be able to generate the API docs from the code. Post in the Apache forums and someone will help you with the command to generate the API docs.

      Delete