AI 146546: am: CL 146204 am: CL 146203 New .jd files, modified Pdk.mk to fix doxygen </div> bug on line 25 of *-source.html files, removed extraneous SDK examples.

Original author: mritter
  Merged from: //branches/cupcake/...
  Original author: android-build

Automated import of CL 146546
This commit is contained in:
Mike Ritter
2009-04-18 15:46:37 -07:00
committed by The Android Open Source Project
parent fb9412141e
commit fd46c2cf5a
24 changed files with 148 additions and 229 deletions

View File

@@ -1,3 +1,8 @@
V 0.9 MWR Apr 6, 2009
#####################
* New files for new css files using droiddoc/clearsilver
V 0.3 - June 9, 2008
####################
@@ -15,4 +20,4 @@ V 0.3 - June 9, 2008
* Updated Build System (build_system.html): Switched Device code options 1 & 2 to emphasize that
the new first option yields more consistent results.
* Updated Bring Up (bring_up.html): removed "hotplugd" from step 7.
* Updated Bring Up (bring_up.html): removed "hotplugd" from step 7.

View File

@@ -53,4 +53,4 @@ include $(BUILD_SHARED_LIBRARY)
<p class="note"><strong>Note</strong>: This document relies on some Doxygen-generated content that appears in an iFrame below. To return to the Doxygen default content for this page, <a href="audio_sub_system.html">click here</a>.</p>
<iframe onLoad="resizeHeight();" src="_audio_hardware_interface_8h.html" scrolling="no" scroll="no" id="doxygen" marginwidth="0" marginheight="0" frameborder="0" style="width:100%;"></iframe>
<iframe onLoad="resizeDoxFrameHeight();" src="_audio_hardware_interface_8h.html" scrolling="no" scroll="no" id="doxygen" marginwidth="0" marginheight="0" frameborder="0" style="width:100%;"></iframe>

View File

@@ -1,25 +1,15 @@
page.title=Bluetooth
pdk.version=1.0
@jd:body
<div id="qv-wrapper">
<div id="qv">
<a name="toc"/>
<div style="padding:10px">
<a href="#androidBluetoothIntro">Introduction</a><br/>
<a href="#androidBluetoothPorting">Porting</a><br/><div style="padding-left:40px">
<h2>In this document</h2>
<ol>
<li><a href="#androidBluetoothIntro">Introduction</a></li>
<li><a href="#androidBluetoothPorting">Porting</a>
<ol>
<li><a href="#androidBluetoothPortingDriver">UART Driver</a></li>
<li><a href="#androidBluetoothPortingPowerOnOff">Bluetooth Power On / Off</a></li>
</ol>
</li>
<li><a href="#androidBluetoothTools">Tools</a></li>
</ol>
</div>
</div>
<a href="#androidBluetoothPortingDriver">UART Driver</a><br/>
<a href="#androidBluetoothPortingPowerOnOff">Bluetooth Power On / Off</a><br/></div>
<a href="#androidBluetoothTools">Tools</a><br/></div></font></div>
<a name="androidBluetoothIntro"></a><h2>Introduction</h2>
@@ -77,6 +67,3 @@ Solid elements represent Android blocks and dashed elements represent partner-sp
<li><code>dbus-monitor</code></li>
</ul>
</p>

View File

@@ -1,4 +1,5 @@
page.title=Bring Up
pdk.version=1.0
@jd:body
<p>Once your code is built and you have verified that all necessary directories exist, power on and test your device with basic bring up, as described below. Bring up tests are typically designed to stress certain aspects of your system and allow you to characterize the device's behavior. </p>
@@ -6,7 +7,6 @@ page.title=Bring Up
<h3>1. Confirm a Clean Installation of a Basic Linux Kernel </h3>
<p>Before considering Android-specific modifications to the Linux kernel, verify that you can build, deploy, and boot a core Linux kernel on your target hardware. </p>
<p>&nbsp;</p>
<h3>2. Modify Your Kernel Configuration to Accommodate Android Drivers</h3>
<p>Your kernel configuration file should include the following:</p>
<pre class="prettyprint">
@@ -355,6 +355,4 @@ service akmd /sbin/akmd
disabled
user akmd
group akmd
</pre>
</pre>

View File

@@ -27,7 +27,7 @@ pdk.version=1.0
PRODUCT_NAME := &lt;first_product_name&gt;
PRODUCT_DEVICE := &lt;board_name&gt;</pre></li>
<li>In the <code>products</code> directory, create an <code>AndroidProducts.mk</code> file that point to (and is responsible for finding) the individual product make files.<BR>
<pre class="prettyprint">
<pre class="prettypring">
#
# This file should set PRODUCT_MAKEFILES to a list of product makefiles
# to expose to the build system. LOCAL_DIR will already be set to
@@ -127,4 +127,4 @@ pdk.version=1.0
</ul>
</ul>
</ul>
</p>
</p>

View File

@@ -251,4 +251,4 @@ Java HotSpot(TM) Client VM (build 1.5.0_07-87, mixed mode, sharing)
<p>To build the kernel, execute:</p>
<pre class="prettyprint">
% make -j4
</pre>
</pre>

View File

@@ -1,26 +1,16 @@
page.title=Camera Subsystem
page.title=Camera
pdk.version=1.0
@jd:body
<div id="qv-wrapper">
<div id="qv">
<a name="toc"/>
<div style="padding:10px">
<a href="#androidCameraIntroduction">Introduction</a><br/>
<a href="#androidCameraBuildingDriver">Building a Camera Library</a><br/>
<a href="#androidCameraSequenceDiagrams">Sequence Diagrams</a><br/><div style="padding-left:40px">
<h2>In this document</h2>
<ol>
<li><a href="#androidCameraIntroduction">Introduction</a></li>
<li><a href="#androidCameraBuildingDriver">Building a Camera Library</a></li>
<li><a href="#androidCameraSequenceDiagrams">Sequence Diagrams</a>
<ol>
<li><a href="#androidCameraSequenceDiagramsPreview">Preview</a></li>
<li><a href="#androidCameraSequenceDiagramsTakePic">Taking a Picture</a></li>
</ol>
</li>
<li><a href="#androidCameraInterfaceIntro">Interface</a></li>
</ol>
</div>
</div>
<a href="#androidCameraSequenceDiagramsPreview">Preview</a><br/>
<a href="#androidCameraSequenceDiagramsTakePic">Taking a Picture</a><br/></div>
<a href="#androidCameraInterfaceIntro">Interface</a><br/></div></font></div>
<a name="androidCameraIntroduction"></a><h2>Introduction</h2>
@@ -82,6 +72,4 @@ include $(BUILD_SHARED_LIBRARY)
<p class="note"><strong>Note</strong>: This document relies on some Doxygen-generated content that appears in an iFrame below. To return to the Doxygen default content for this page, <a href="camera.html">click here</a>.</p>
<iframe onLoad="resizeDoxFrameHeight();" src="CameraHardwareInterface_8h.html " scrolling="no" scroll="no" id="doxygen" marginwidth="0" marginheight="0" frameborder="0" style="width:100%;"></iframe>
<iframe onLoad="resizeDoxFrameHeight();" src="_camera_hardware_interface_8h.html" scrolling="no" scroll="no" id="doxygen" marginwidth="0" marginheight="0" frameborder="0" style="width:100%;"></iframe>

View File

@@ -1,12 +1,15 @@
page.title=Display Drivers
pdk.version=1.0
@jd:body
<a name="toc"/>
<div style="padding:10px">
<a href="#androidDisplayDriverIntroduction">Introduction</a><br/>
<a href="#androidDisplayDriverFunctionality">Functionality</a><br/>
<a href="#androidDisplayDriversSourceTemplate">Implementing Your Own Driver (Driver Template)</a><br/>
<a href="#androidDisplayDriversTroubleshooting">Troubleshooting</a><br/></div></font>
<a href="#androidDisplayDriversTroubleshooting">Troubleshooting</a><br/></div></font></div>
<a name="androidDisplayDriverIntroduction"></a><h2>Introduction</h2>
@@ -335,6 +338,4 @@ MODULE_LICENSE("GPL");
<li><strong>Arrow keys</strong>: When an arrow key is pressed, the desired icon doesn't get highlighted. For example, if you browse through icons in the Applications menu, you might notice that icons aren't highlighted as expected when you use the arrow key to navigate between options.</li>
</ul>
<p>Both problems are caused by an incorrect implementation of the frame buffer's page flipping. Key events are captured, but the graphical interface appears to drop every other frame. </p>
<p>Android relies on a double buffer to smoothly render page flips (please see <a href="androidDisplayDriverFunctionality">Functionality</a> for details).
<p>Android relies on a double buffer to smoothly render page flips (please see <a href="androidDisplayDriverFunctionality">Functionality</a> for details).</p>

View File

@@ -1,11 +1,12 @@
page.title=GPS
pdk.version=1.0
@jd:body
<a name="toc"/>
<div style="padding:10px">
<a href="#androidGpsIntroduction">Introduction</a><br/>
<a href="#androidGPSBuildingDriver">Building a GPS Library</a><br/>
<a href="#androidGPSInterface">Interface</a><br/></div>
<a href="#androidGPSInterface">Interface</a><br/></div></font></div>
<a name="androidGpsIntroduction"></a><h2>Introduction</h2>
@@ -47,3 +48,9 @@ include $(BUILD_SHARED_LIBRARY)
<p><span class="lh2"><a name="androidDoxygenNote"></a></span>
<p class="note"><strong>Note</strong>: This document relies on some Doxygen-generated content that appears in an iFrame below. To return to the Doxygen default content for this page, <a href="gps.html">click here</a>.</p>
<iframe onLoad="resizeDoxFrameHeight();" src="gps_8h.html" scrolling="no" scroll="no" id="doxygen" marginwidth="0" marginheight="0" frameborder="0" style="width:100%;"></iframe>

View File

@@ -1,4 +1,3 @@
home=true
page.title=Welcome to the Android Porting Guide
pdk.version=1.0
@jd:body
@@ -36,4 +35,4 @@ with at least keypad and display drivers properly installed.</p>
<dt><a href="bring_up.html">Basic Bring up </a></dt>
<dd>Establish core components necessary to your device, such as keymaps / keyboard input and display drivers. </dd>
<dt>&nbsp;</dt>
</dl>
</dl>

View File

@@ -1,4 +1,5 @@
page.title=Instrumentation Testing
pdk.version=1.0
@jd:body
<a name="toc"/>
@@ -25,11 +26,11 @@ page.title=Instrumentation Testing
<a href="#androidTestingLocationFiles">Location of Files</a><br/>
<a href="#androidTestingContentMakefile">Contents of makefile</a><br/>
<a href="#androidTestingContentManifest">Content of Manifest</a><br/>
<a href="#androidInstrumentationTestingCreatingTestRunner">New InstrumentationTestRunner</a><br/>
<a href="#androidInstrumentationTestingCreatingTestRunner">New Instrumentation TestRunner</a><br/>
<a href="#androidInstrumentationTestingCreatingTestCase">New InstrumentationTestCase</a><br/>
<a href="#androidInstrumentationFrameworkTestCase">Exploring a Test Case</a><br/>
<a href="#androidTestingKindsofTests">Deciding Kinds of Tests to Write</a><br/></div>
<a href="#androidInstrumentationFrameworkTroubleshooting">Troubleshooting</a><br/></div>
<a href="#androidInstrumentationFrameworkTroubleshooting">Troubleshooting</a><br/></div></font></div>
<a name="androidInstrumentationFrameworkIntro"></a><h2>Introduction</h2>
@@ -318,28 +319,23 @@ include $(BUILD_PACKAGE)
<a name="androidTestingContentManifest"></a><h3>Content of Manifest</h3>
<p>Use the following example to create an <code>AndroidManifest.xml</code> file that declares the instrumentation. Specify that the framework supplied InstrumentationTestRunner targets the package of your application, allowing the tests that are run with the instrumentation to get access to all of the classes of your application without having to build the source into the test app. The name of the test application is typically the same as your target application with <code>.tests</code> appended. </p>
<p>Use the following example to create an <code>AndroidManifest.xml</code> file that declares the instrumentation. Specify that the framework supplied Instrumentation TestRunner targest the package of your application, allowing the tests that are run with the instrumentation to get access to all of the classes of your application without having to build the source into the test app. The name of the test application is typically the same as your target application with <code>.tests</code> appended. </p>
<pre>
# Add appropriate copyright banner here
&lt;manifest xmlns:android="http://schemas.android.com/apk/res/android"
package="com.example.android.apis.tests"&gt;
&lt;!-- We add an application tag here just so that we can indicate that
this package needs to link against the android.test library,
which is needed when building test cases. -->
&lt;application>
&lt;uses-library android:name="android.test.runner" />
&lt;/application>
package="com.android.samples.tests"&gt;
&lt;uses-permission android:name="android.permission.RUN_INSTRUMENTATION" /&gt;
&lt;!--
This declares that this app uses the instrumentation test runner targeting
the package of com.example.android.apis. To run the tests use the command:
"adb shell am instrument -w com.example.android.apis.tests/android.test.InstrumentationTestRunner"
-->
the package of com.android.samples. To run the tests use the command:
"adb shell am instrument -w com.android.samples.tests/android.test.InstrumentationTestRunner"
--&gt;
&lt;instrumentation android:name="android.test.InstrumentationTestRunner"
android:targetPackage="com.example.android.apis"
android:label="Tests for Api Demos."/>
android:targetPackage="com.android.samples"
android:label="Tests for Api Demos."/&gt;
&lt;/manifest&gt;
</pre>
<p>&nbsp;</p>
@@ -350,7 +346,7 @@ $ adb shell am instrument -w \
</pre>
<a name="androidInstrumentationTestingCreatingTestRunner"></a><h3>New InstrumentationTestRunner</h3>
<a name="androidInstrumentationTestingCreatingTestRunner"></a><h3>New Instrumentation TestRunner</h3>
<p>Create a class that derives from this class. You must override two abstract methods; one that returns the class loader of the target package, and another that defines all of the tests within the package. For example, the snippet below displays the test runner for the framework tests.</p>
<pre class="prettify">
@@ -374,6 +370,8 @@ public class FrameworkInstrumentationTestRunner extends InstrumentationTestRunne
</pre>
<p> Next, in an appropriate <code>AndroidManifest.xml</code>, define the instrumentation for the derived class with the appropriate <code>android:targetPackage</code> set. For example, the snippet below defines the instrumentation runner for the framework tests.</p>
<pre class="prettify">
&lt;uses-permission android:name="android.permission.RUN_INSTRUMENTATION" /&gt;
&lt;instrumentation android:name="android.tests.FrameworkInstrumentationTestRunner"
android:targetPackage="com.google.android.frameworktest"
android:label="framework instrumentation test runner" /&gt;
@@ -510,5 +508,4 @@ W/ActivityManager( 469): Unable to find instrumentation info for: ComponentInfo
D/AndroidRuntime( 688): Shutting down VM
E/AndroidRuntime( 688): ERROR: thread attach failed
</pre>
<p>It's possible that the instrumentation apk isn't installed on your device or that the package name is incorrect in the Manifest file. </p>
<p>It's possible that the instrumentation apk isn't installed on your device or that the package name is incorrect in the Manifest file. </p>

View File

@@ -1,6 +1,8 @@
page.title=Keymaps and Keyboard Input
pdk.version=1.0
@jd:body
<a name="toc"/>
<div style="padding:10px">
<a href="#androidKeymapIntro">Introduction</a><br/>
@@ -17,7 +19,7 @@ page.title=Keymaps and Keyboard Input
<a href="#androidKeymapKeyCharMapExample">Example of a Key Character Map File</a><br/>
<a href="#androidKeymapKeyCharMapResourceBinaryFileFormat">Resource Binary File Format</a><br/></div>
<a href="#androidKeymapDriverTemplate">Implementing Your Own Driver (Driver Template)</a><br/>
<a href="#androidKeymapKeyCharMapSampleImplementation">Sample Implementation</a><br/></div>
<a href="#androidKeymapKeyCharMapSampleImplementation">Sample Implementation</a><br/></div></font></div>
<a name="androidKeymapIntro"></a><h2>Introduction</h2>
@@ -504,6 +506,4 @@ I/EventHub( 1548): Reporting device opened: id=0x10000, name=/dev/input/event0
I/KeyInputQueue( 1548): Device added: id=0x10000, name=partnerxx_keypad, classes=1
I/KeyInputQueue( 1548): Keymap: partnerxx_keypad.kl
</pre>
<p>The snippet above contains artificial line breaks to maintain a print-friendly document.</p>
<p>The snippet above contains artificial line breaks to maintain a print-friendly document.</p>

View File

@@ -1,6 +1,10 @@
page.title=Power Management
pdk.version=1.0
@jd:body
<a name="toc"/>
<div style="padding:10px">
<a href="#androidPowerIntro">Introduction</a><br/>
@@ -9,7 +13,7 @@ page.title=Power Management
<a href="#androidPowerWakeLocksDefinitions">Types of Wake Locks</a><br/>
<a href="#androidPowerWakeLockExample">Exploring a Wake Lock Example</a><br/></div>
<a href="#androidPowerPowerManagerClass">PowerManager class</a><br/>
<a href="#androidPowerKernelRegistration">Registering Drivers with the PM Driver</a><br/></div>
<a href="#androidPowerKernelRegistration">Registering Drivers with the PM Driver</a><br/></div></font></div>
<a name="androidPowerIntro"></a><h2>Introduction</h2>
@@ -18,7 +22,7 @@ page.title=Power Management
<p>The image below illustrates the Android power management architecture. </p>
<p><img src='androidPMArchitecture.gif'></p>
<p>Solid elements represent Android blocks and dashed elements represent partner-specific blocks.</p>
Solid elements represent Android blocks and dashed elements represent partner-specific blocks.
@@ -102,7 +106,4 @@ wl.release();
android_register_early_suspend(android_early_suspend_t *handler)
android_register_early_resume(android_early_resume_t *handler)
</pre>
<p>It is critical in a drive to return immediately and not wait for anything to happen in the call back.</p>
<p>It is critical in a drive to return immediately and not wait for anything to happen in the call back.</p>

View File

@@ -3,7 +3,6 @@ pdk.version=1.0
@jd:body
<p>While Android is designed to support a wide variety of hardware platforms and configurations, this section provides recommended minimum device requirements.</p>
<table border=1 cellpadding=2 cellspacing=0>
<tbody><tr>
<th scope="col">Feature</th>
@@ -57,7 +56,4 @@ pdk.version=1.0
<li>QWERTY keyboard</li>
<li>WiFi</li>
<li>GPS</li>
</ul>
</ul>

View File

@@ -1,4 +1,5 @@
page.title=Radio Layer Interface
pdk.version=1.0
@jd:body
<a name="toc"/>
@@ -15,7 +16,7 @@ page.title=Radio Layer Interface
<a href="#androidTelephonyRILFunctions">RIL Functions</a><br/><div style="padding-left:40px">
<a href="#androidRilFunctionsSolicited">RIL Solicited Command Requests</a><br/>
<a href="#androidRilFunctionsUnsolicited">RIL Unsolicited Commands</a><br/></div></div>
<a href="#androidRilFunctionsUnsolicited">RIL Unsolicited Commands</a><br/></div></div></font></div>
<a name="androidTelephonyIntro"></a><h2>Introduction</h2>
@@ -221,4 +222,3 @@ RIL_RadioFunctions;
</ul></td>
</tr>
</table></p>

View File

@@ -1,19 +0,0 @@
<div id="footer">
<?cs if:reference||guide ?>
<div id="copyright">
<?cs call:custom_copyright() ?>
</div>
<div id="build_info">
<?cs call:custom_buildinfo() ?>
</div>
<?cs elif:!hide_license_footer ?>
<div id="copyright">
<?cs call:custom_cc_copyright() ?>
</div>
<?cs /if ?>
<div id="footerlinks">
<?cs call:custom_footerlinks() ?>
</div>
</div> <!-- end footer -->

View File

@@ -1,37 +0,0 @@
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<link rel="shortcut icon" type="image/x-icon" href="<?cs var:toroot ?>favicon.ico" />
<title><?cs
if:page.title ?><?cs
var:page.title ?><?cs
if:sdk.version ?> (<?cs
var:sdk.version ?>)<?cs
/if ?> | <?cs
/if ?>Android Developers</title><?cs
if:guide||sdk ?>
<link href="<?cs var:toroot ?>assets/android-developer-docs-devguide.css" rel="stylesheet" type="text/css" /><?cs
else ?>
<link href="<?cs var:toroot ?>assets/android-developer-docs.css" rel="stylesheet" type="text/css" /><?cs
/if ?>
<script src="<?cs var:toroot ?>assets/search_autocomplete.js" type="text/javascript"></script>
<script src="<?cs var:toroot ?>reference/lists.js" type="text/javascript"></script>
<script src="<?cs var:toroot ?>assets/jquery-resizable.min.js" type="text/javascript"></script>
<script src="<?cs var:toroot ?>assets/android-developer-docs.js" type="text/javascript"></script>
<script type="text/javascript">
setToRoot("<?cs var:toroot ?>");
</script><?cs
if:reference ?>
<script src="<?cs var:toroot ?>navtree_data.js" type="text/javascript"></script>
<script src="<?cs var:toroot ?>assets/navtree.js" type="text/javascript"></script><?cs
/if ?>
<noscript>
<style type="text/css">
body{overflow:auto;}
#body-content{position:relative; top:0;}
#doc-content{overflow:visible;border-left:3px solid #666;}
#side-nav{padding:0;}
#side-nav .toggle-list ul {display:block;}
#resize-packages-nav{border-bottom:3px solid #666;}
</style>
</noscript>
</head>

View File

@@ -1,3 +0,0 @@
<?cs call:custom_masthead() ?>
<?cs call:custom_left_nav() ?>

View File

@@ -1,8 +0,0 @@
<html>
<head>
<meta http-equiv="refresh" content="0;url=packages.html">
</head>
<body>
<?cs include:"analytics.cs" ?>
</body>
</html>

View File

@@ -1,11 +0,0 @@
</div> <!-- end body-content --> <?cs # normally opened by header.cs ?>
<script type="text/javascript">
init(); /* initialize android-developer-docs.js */
var gaJsHost = (("https:" == document.location.protocol) ? "https://ssl." : "http://www.");
document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
</script>
<script type="text/javascript">
var pageTracker = _gat._getTracker("UA-5831155-1");
pageTracker._trackPageview();
</script>

View File

@@ -1,11 +1,12 @@
page.title=Wi-Fi
pdk.version=1.0
@jd:body
<a name="toc"/>
<div style="padding:10px">
<a href="#androidWifiIntroduction">Introduction</a><br/>
<a href="#androidWifiBuildingDriver">Building a Wi-Fi Library</a><br/>
<a href="#androidWifiInterface">Interface</a><br/></div>
<a href="#androidWifiInterface">Interface</a><br/></div></font></div>
<a name="androidWifiIntroduction"></a><h2>Introduction</h2>
@@ -28,7 +29,7 @@ page.title=Wi-Fi
<pre class="prettify">
LOCAL_SHARED_LIBRARIES += libnetutils
ifeq ($(TARGET_DEVICE),acme)
ifeq ($(TARGET_PRODUCT),acme)
LOCAL_SRC_FILES += wifi/wifi_mywifi.c
else
LOCAL_SRC_FILES += wifi/wifi.c
@@ -44,6 +45,3 @@ endif
<iframe onLoad="resizeDoxFrameHeight();" src="wifi_8h.html" scrolling="no" scroll="no" id="doxygen" marginwidth="0" marginheight="0" frameborder="0" style="width:100%;"></iframe>