Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit ee58d1bf authored by Dirk Dougherty's avatar Dirk Dougherty
Browse files

doc change: Add docs for SDK. Support new modular structure. In Android.mk,... 

doc change: Add docs for SDK. Support new modular structure. In Android.mk, change @since level identifier to 5.xml, expose adt downloadable vars. Fix links that pointed to @sdkCurrent.

Change-Id:I368345755dd753b1056fb06ff25e4b32f3020e4d
Bug:2160782
parent 6797b9fa

Android.mk

+12 −2
Original line number Diff line number Diff line
@@ -343,7 +343,7 @@ framework_docs_LOCAL_DROIDDOC_OPTIONS := \ 
    -since ./frameworks/base/api/2.xml 2 \

    -since ./frameworks/base/api/3.xml 3 \

    -since ./frameworks/base/api/4.xml 4 \

    -since ./frameworks/base/api/current.xml Eclair \

    -since ./frameworks/base/api/5.xml 5 \

		-error 1 -error 2 -warning 3 -error 4 -error 6 -error 8 \

		-overview $(LOCAL_PATH)/core/java/overview.html
@@ -380,10 +380,20 @@ framework_docs_SDK_CURRENT_DIR:=$(framework_docs_SDK_VERSION)_r$(framework_docs_ 
  # flag to build offline docs for a preview release

framework_docs_SDK_PREVIEW:=0



## Latest ADT version identifiers, for reference from published docs

framework_docs_ADT_VERSION:=0.9.4

framework_docs_ADT_DOWNLOAD:=ADT-0.9.4.zip

framework_docs_ADT_BYTES:=0

framework_docs_ADT_CHECKSUM:=0



framework_docs_LOCAL_DROIDDOC_OPTIONS += \

		-hdf sdk.version $(framework_docs_SDK_VERSION) \

		-hdf sdk.rel.id $(framework_docs_SDK_REL_ID) \

		-hdf sdk.current $(framework_docs_SDK_CURRENT_DIR)

		-hdf sdk.current $(framework_docs_SDK_CURRENT_DIR) \

		-hdf adt.zip.version $(framework_docs_ADT_VERSION) \

		-hdf adt.zip.download $(framework_docs_ADT_DOWNLOAD) \

		-hdf adt.zip.bytes $(framework_docs_ADT_BYTES) \

		-hdf adt.zip.checksum $(framework_docs_ADT_CHECKSUM) 



# ====  the api stubs and current.xml ===========================

include $(CLEAR_VARS)

docs/html/guide/appendix/api-levels.jd

+26 −18
Original line number Diff line number Diff line
@@ -83,6 +83,7 @@ Android platform.</p> 


<table>

  <tr><th>Platform Version</th><th>API Level</th></tr>

  <tr><td>Android 2.0</td><td>5</td></tr>

  <tr><td>Android 1.6</td><td>4</td></tr>

  <tr><td>Android 1.5</td><td>3</td></tr>

  <tr><td>Android 1.1</td><td>2</td></tr>
@@ -115,6 +116,10 @@ they are designed to support. The element offers two key attributes:</p> 
<ul>

<li><code>android:minSdkVersion</code> &mdash; Specifies the minimum API Level

on which the application is able to run. The default value is "1".</li>

<li><code>android:targetSdkVersion</code> &mdash; Specifies the API Level

on which the application is designed to run. In some cases, this allows the

application to use manifest elements or behaviors defined in the target

API Level, rather than those in the minimum API Level.</li>

<li><code>android:maxSdkVersion</code> &mdash; Specifies the maximum API Level

on which the application is able to run.</li>

</ul>
@@ -146,7 +151,7 @@ element might look like this: </p> 


<pre>&lt;manifest&gt;

  ...

  &lt;uses-sdk android:minSdkVersion="4" /&gt;

  &lt;uses-sdk android:minSdkVersion="5" /&gt;

  ...

&lt;/manifest&gt;</pre>
@@ -288,23 +293,26 @@ a list of platform versions and their API Levels. </p> 


<h2 id="provisional">Using a Provisional API Level</h2>



<p>During an "Early Look" SDK release, the APIs may not be final, so the API Level integer

will not be specified. You must instead use a provisional API Level in your application

manifest in order to build applications against the Early Look platform. In this case,

the provisional API Level is not an integer, but a string matching the codename of the

unreleased platform version (for example, "Eclair"). The provisional API Level will be specified

in the Early Look SDK release notes and is case-sensitive.</p>



<p>The use of a provisional API Level is designed to protect developers 

and device users from inadvertently publishing or installing applications based on the 

Early Look framework API, which may not run properly on actual devices running the final

system image.</p>



<p>The provisional API Level will only be valid while using the Early Look SDK to run

applications in the emulator. An application using the provisional API Level can never be 

installed on an Android device. When the final SDK is released, you must replace any

instances of the provisional API Level in your application manifest with the final 

API Level integer.</p>

<p>In some cases, an "Early Look" Android SDK platform may be available. To let

you begin developing on the platform although the APIs may not be final, the

platform's API Level integer will not be specified. You must instead use the

platform's <em>provisional API Level</em> in your application manifest, in order

to build applications against the platform. A provisional API Level is not an

integer, but a string matching the codename of the unreleased platform version.

The provisional API Level will be specified in the release notes for the Early

Look SDK release notes and is case-sensitive.</p>



<p>The use of a provisional API Level is designed to protect developers and

device users from inadvertently publishing or installing applications based on

the Early Look framework API, which may not run properly on actual devices

running the final system image.</p>



<p>The provisional API Level will only be valid while using the Early Look SDK

and can only be used to run applications in the emulator. An application using

the provisional API Level can never be installed on an Android device. At the

final release of the platform, you must replace any instances of the provisional

API Level in your application manifest with the final platform's actual API

Level integer.</p>





<h2 id="filtering">Filtering the Reference Documentation by API Level</h2>

docs/html/guide/developing/eclipse-adt.jd

+2 −2
Original line number Diff line number Diff line
@@ -38,12 +38,12 @@ manifest and resource files.</li> 


<p>To begin developing Android applications in the Eclipse IDE with ADT, you first need to 

download the Eclipse IDE and then download and install the ADT plugin. To do so, follow the 

steps given in <a href="{@docRoot}sdk/{@sdkCurrent}/installing.html#installingplugin">Installing 

steps given in <a href="{@docRoot}sdk/eclipse-adt.html#installing">Installing 

the ADT Plugin</a>.</p>



<p>If you are already developing applications using a version of ADT earlier than 0.9, make

sure to upgrade to the latest version before continuing. See the guide to

<a href="{@docRoot}sdk/{@sdkCurrent}/upgrading.html#UpdateAdt">Updating Your Eclipse ADT Plugin</a>.</p>

<a href="{@docRoot}sdk/eclipse-adt.html#updating">Updating Your ADT Plugin</a>.</p>



<p class="note"><strong>Note:</strong> This guide assumes you are using the latest version of

the ADT plugin. While most of the information covered also applies to previous

docs/html/guide/developing/tools/othertools.jd

+2 −2
Original line number Diff line number Diff line
@@ -26,14 +26,14 @@ Android applications. </p> 
  <li>Create and update Android projects. See

  <a href="{@docRoot}guide/developing/other-ide.html">Developing in Other IDEs</a>.</li>

  <li>Update your Android SDK with new platforms, add-ons, and documentation. See

  <a href="{@docRoot}guide/developing/updating-sdk.html">Updating Your SDK</a>.</li>

  <a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>.</li>

</ul>



<p>If you develop in Eclipse with the ADT plugin, you can perform

these tasks directly from the IDE. To create

Android projects and AVDs from Eclipse, see <a href="{@docRoot}guide/developing/eclipse-adt.html">Developing

In Eclipse</a>. To update your SDK from Eclipse, see

<a href="{@docRoot}guide/developing/updating-sdk.html">Updating Your SDK</a>. 

<a href="{@docRoot}sdk/adding-components.html">Adding SDK Components</a>. 

</p>

docs/html/guide/tutorials/hello-world.jd

+1 −1
Original line number Diff line number Diff line
@@ -29,7 +29,7 @@ You can then return to this tutorial and ignore anything about Eclipse.</p> 


<p>Before you start, you should already have the very latest SDK installed, and if you're using

Eclipse, you should have installed the ADT plugin as well. If you have not installed these, see 

<a href="{@docRoot}sdk/{@sdkCurrent}/installing.html">Installing the Android SDK</a> and return

<a href="{@docRoot}sdk/installing.html">Installing the Android SDK</a> and return

here when you've completed the installation.</p>



<h2 id="avd">Create an AVD</h2>