• Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

Android API Documentation

 
Peter Sorotokin
Ranch Hand
Posts: 36
1
Java Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi
I have downloaded an offline version of Android API Documentation , But It has not any choice for searching among methods .
How I can do that ??? For example in Java API Doc there is a choice for viewing index of every thing in that ( in alphabetical order )
and in that there were every thing include methods and classes and final constants . But in Android API Doc there is no such thing
and I often need to search among methods . How I can do that easily ???
 
Ron McLeod
Bartender
Pie
Posts: 1022
64
Android Eclipse IDE Java Linux MySQL Database Redhat
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If you download the SDK, the launch page is index.html, under the docs directory.

file:///path/to/sdk/docs/index.html
 
Ulf Dittmer
Rancher
Posts: 42969
73
  • Likes 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Yeah, strangely they did not mimic that behavior of the standard Java javadocs. I can't say I've missed it much, though. For the java[x] classes and HttpClient one can use their "normal" javadocs. Otherwise I just briefly read through what a class offers when I first encounter it. So, no real solution as far as I know.
 
Irina Goble
Ranch Hand
Posts: 91
  • Likes 3
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Peter, you could download the source code (check in "Sources for Android SDK" in the Adroid SDK Manager) and run javadoc on it.
 
Ulf Dittmer
Rancher
Posts: 42969
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
That's an interesting idea - although the standard javadoc tool that comes with the JDK does not know about Android versions, so the little popup menu to grey out classes introduced in newer Android versions than the selected one would not be generated.
 
Irina Goble
Ranch Hand
Posts: 91
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
If it is done for the standard Java documentation, it should be possible to do. I'm going to look into this.
 
Steve Luke
Bartender
Posts: 4181
22
IntelliJ IDE Java Python
  • Likes 1
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Another idea (just to throw it out there - I like Irina's answer a lot) is to use a file indexer, (like X1 or DocFetcher) which indexes the contents of files. It would mean using a different application to do your search but should be fairly easy and quick.
 
Irina Goble
Ranch Hand
Posts: 91
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Ulf, how and where do you get that little popup menu to grey out classes?
 
Ulf Dittmer
Rancher
Posts: 42969
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
The Android javadocs have that, but not the standard Java javadocs. In http://developer.android.com/reference/packages.html it's at the upper left next to "API Level". Very useful if you need to support different API levels.
 
Irina Goble
Ranch Hand
Posts: 91
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thanks, I see it now. It looks like it is built using Doclava.
 
Ulf Dittmer
Rancher
Posts: 42969
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
It's good to see innovation in this space, but too bad that the tool is severely underdocumented. Particularly the areas discussed here -API versioning and customizing it to create method information- are barely mentioned at all, and the download comes with no example at all. I think it's fair to say that the creators are not particularly interested in seeing it adopted more widely.
 
Consider Paul's rocket mass heater.
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic