I'd like to report a couple of problems with the Android documentation
and web site.

1. Currently there are two versions of the Android documentation, and
they are not identical. For example compare:

   a) http://code.google.com/android/devel/resources-i18n.html vs.
   http://developer.android.com/guide/topics/resources/resources-i18n.html

   b) http://code.google.com/android/reference/android/view/View.html
vs.
   http://developer.android.com/reference/android/view/View.html

The version at code.google.com has this date at the bottom: "Build
123965-123965 - 15 Dec 2008 10:58", while the version at
developer.android.com is dated "Android 1.1 r1 - 09 Feb 2009 17:46"

I reference about a dozen or so URLs from code.google.com in my book
(http://www.pragprog.com/titles/eband/hello-android , list available
on request) so on the one hand I don't want them to go away, but on
the other hand it's going to be confusing to developers to have two
versions at these two different sites. For example, if a developer
does a Google search for "android resources i18n" then the first
result is the page at code.google.com.

I suggest:

   a) Adopting a permanent URL naming scheme that incorporates the
version number.
   For example, Adobe has several versions of Flex, and their SDK
pages have names like this:

      http://livedocs.adobe.com/flex/3/html/controls_04.html
      http://livedocs.adobe.com/flex/3/langref/mx/controls/Button.html
       (note the "3" in the URL so that Flex3, Flex2, and other
versions can exist at the same time)

   b) If one of the locations is deprecated then set up redirections
so that links will not be broken.


2. New APIs are not identified in the documentation. For example this
is a new method introduced in 1.1_r1:

   
http://developer.android.com/reference/android/view/View.html#isPaddingOffsetRequired()

The fact that it's new in 1.1 and didn't exist in 1.0 must be clearly
noted in the documentation. The Javadoc style of using "@since 1.1"
would be fine. For example here's the documentation on a method added
in Java SE 1.6:

   
http://java.sun.com/javase/6/docs/api/javax/swing/ButtonGroup.html#clearSelection()


3. I noticed a couple of broken links on this page:

   http://developer.android.com/sdk/1.1_r1/upgrading.html

The links are:

    Overview of Changes (http://code.google.com/android/migrating/
changes-overview.html) - not found
    API Diffs Report (http://code.google.com/android/migrating/
changes.html) - not found

--~--~---------~--~----~------------~-------~--~----~
You received this message because you are subscribed to the Google Groups 
"Android Discuss" group.
To post to this group, send email to [email protected]
To unsubscribe from this group, send email to 
[email protected]
For more options, visit this group at 
http://groups.google.com/group/android-discuss?hl=en
-~----------~----~----~----~------~----~------~--~---

Reply via email to