Friday 13 January 2012

Downloading and Integrating Android Javadoc Locally with Eclipse

Missing Javadoc while building an android project ? Don't worry, Here is the solution

Steps for downloading Android Javadoc file for offline use.

1] Go to https://dl-ssl.google.com/android/repository/repository-5.xml
2] Locate the xml block of Javadoc file. As given bellow
<!-- DOCS ........................ -->
<sdk:doc>
 <!-- Generated at Thu Dec 15 16:56:14 2011 from git_ics-mr1 @ 238992 -->
 <sdk:revision>1</sdk:revision>
 <sdk:api-level>15</sdk:api-level>
 <sdk:archives>
  <sdk:archive arch="any" os="any">
   <sdk:size>137065704</sdk:size>
   <sdk:checksum type="sha1">bd6be3d4f40d610963113b956edddcd66aca9327
   </sdk:checksum>
   <sdk:url>docs-15_r01.zip</sdk:url>
  </sdk:archive>
 </sdk:archives>
</sdk:doc>
3] Create url to download the Javadoc file
Append the repository url with <sdk:url> value. So we get the new url as
https://dl-ssl.google.com/android/repository/docs-15_r01.zip
4] Download the Android Javadoc file from the url.
5] Extract the zip to location : 'C:\Program Files\Android\android-sdk\platforms'


Steps for Integrating Android Javadoc with Eclipse IDE.

1] Open Eclipse > Project > Properties > Click on 'Java Build Path' from list
2] Select 'Libraries' Tab
3] Expand 'Android X.X' and then expand android.jar.
4] Select '@ Javadoc location' field and click on Edit Button. A new window will popup.
5] Choose 'Javadoc URL' then click on browse button and select path to ..\doc\reference folder extracted previously. i.e.
'C:\Program Files\Android\android-sdk\platforms\docs\reference'
7] Click Validate button.
Note: Please be sure that you have selected the path to \doc\reference folder otherwise you will get following error while validating
'Location might be invalid. Files 'package-list' and 'index.html' that are typically available at the root of documentation created by the Javadoc tool have not been found.'
So add the correct path given above in step [5] and eclipse will validate the path.
8] Done.

Now the Javadocs are integrated in Eclipse and available for Android Projects.

No comments:

Post a Comment

About Us | Site Map | Privacy Policy | Contact Us | Blog Design | 2007 Company Name