Commit d7089b86 authored by Evan W. Patton's avatar Evan W. Patton Committed by Jeffrey Schiller

Add missing block descriptions

Change-Id: Iac1c8f6162fc718ebac82d4036f5b7844770a8e7
parent 366f7db5
...@@ -89,6 +89,9 @@ implements OnStopListener, OnResumeListener, OnPauseListener, OnNewIntentListene ...@@ -89,6 +89,9 @@ implements OnStopListener, OnResumeListener, OnPauseListener, OnNewIntentListene
EventDispatcher.dispatchEvent(this, "TagRead", message); EventDispatcher.dispatchEvent(this, "TagRead", message);
} }
/**
* Indicates that a tag has come into range of the NFC sensor and has been written.
*/
@SimpleEvent @SimpleEvent
public void TagWritten() { public void TagWritten() {
Log.d(TAG, "Tag written: " + textToWrite); Log.d(TAG, "Tag written: " + textToWrite);
......
...@@ -447,51 +447,53 @@ public class Pedometer extends AndroidNonvisibleComponent ...@@ -447,51 +447,53 @@ public class Pedometer extends AndroidNonvisibleComponent
// that has them is loaded. // that has them is loaded.
@Deprecated @Deprecated
@SimpleEvent @SimpleEvent(description = "This event has been deprecated.")
public void StartedMoving() { public void StartedMoving() {
} }
@Deprecated @Deprecated
@SimpleEvent @SimpleEvent(description = "This event has been deprecated.")
public void StoppedMoving() { public void StoppedMoving() {
} }
@Deprecated @Deprecated
@SimpleProperty(category = PropertyCategory.BEHAVIOR) @SimpleProperty(category = PropertyCategory.BEHAVIOR,
description = "This property has been deprecated.")
public void UseGPS(boolean gps) { public void UseGPS(boolean gps) {
} }
@Deprecated @Deprecated
@SimpleEvent @SimpleEvent(description = "This event has been deprecated.")
public void CalibrationFailed() { public void CalibrationFailed() {
} }
@Deprecated @Deprecated
@SimpleEvent @SimpleEvent(description = "This event has been deprecated.")
public void GPSAvailable() { public void GPSAvailable() {
} }
@Deprecated @Deprecated
@SimpleEvent @SimpleEvent(description = "This event has been deprecated.")
public void GPSLost() { public void GPSLost() {
} }
// Properties // Properties
@Deprecated @Deprecated
@SimpleProperty(category = PropertyCategory.BEHAVIOR) @SimpleProperty(category = PropertyCategory.BEHAVIOR,
description = "This property has been deprecated.")
public void CalibrateStrideLength(boolean cal) { public void CalibrateStrideLength(boolean cal) {
} }
@Deprecated @Deprecated
@SimpleProperty @SimpleProperty(description = "This property has been deprecated.")
public boolean CalibrateStrideLength() { public boolean CalibrateStrideLength() {
return false; return false;
} }
@Deprecated @Deprecated
@SimpleProperty @SimpleProperty(description = "This property has been deprecated.")
public boolean Moving() { public boolean Moving() {
return false; return false;
} }
......
...@@ -481,7 +481,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field.</dd> ...@@ -481,7 +481,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field.</dd>
Currently this is only a plain text tag, as specified in the Currently this is only a plain text tag, as specified in the
manifest. See Compiler.java.</dd> manifest. See Compiler.java.</dd>
<dt id="NearField.TagWritten">TagWritten()</dt> <dt id="NearField.TagWritten">TagWritten()</dt>
<dd>Event for TagWritten</dd> <dd>Indicates that a tag has come into range of the NFC sensor and has been written.</dd>
</dl> </dl>
<h2 id="OrientationSensor">OrientationSensor</h2> <h2 id="OrientationSensor">OrientationSensor</h2>
...@@ -544,13 +544,13 @@ Valid values for the month field are 1-12 and 1-31 for the day field.</dd> ...@@ -544,13 +544,13 @@ Valid values for the month field are 1-12 and 1-31 for the day field.</dd>
<dl class="properties"> <dl class="properties">
<dt id="Pedometer.CalibrateStrideLength" class="boolean bo"><em>CalibrateStrideLength</em></dt> <dt id="Pedometer.CalibrateStrideLength" class="boolean bo"><em>CalibrateStrideLength</em></dt>
<dd></dd> <dd>This property has been deprecated.</dd>
<dt id="Pedometer.Distance" class="number ro bo"><em>Distance</em></dt> <dt id="Pedometer.Distance" class="number ro bo"><em>Distance</em></dt>
<dd>The approximate distance traveled in meters.</dd> <dd>The approximate distance traveled in meters.</dd>
<dt id="Pedometer.ElapsedTime" class="number ro bo"><em>ElapsedTime</em></dt> <dt id="Pedometer.ElapsedTime" class="number ro bo"><em>ElapsedTime</em></dt>
<dd>Time elapsed in milliseconds since the pedometer was started.</dd> <dd>Time elapsed in milliseconds since the pedometer was started.</dd>
<dt id="Pedometer.Moving" class="boolean ro bo"><em>Moving</em></dt> <dt id="Pedometer.Moving" class="boolean ro bo"><em>Moving</em></dt>
<dd></dd> <dd>This property has been deprecated.</dd>
<dt id="Pedometer.SimpleSteps" class="number ro bo"><em>SimpleSteps</em></dt> <dt id="Pedometer.SimpleSteps" class="number ro bo"><em>SimpleSteps</em></dt>
<dd>The number of simple steps taken since the pedometer has started.</dd> <dd>The number of simple steps taken since the pedometer has started.</dd>
<dt id="Pedometer.StopDetectionTimeout" class="number"><em>StopDetectionTimeout</em></dt> <dt id="Pedometer.StopDetectionTimeout" class="number"><em>StopDetectionTimeout</em></dt>
...@@ -558,7 +558,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field.</dd> ...@@ -558,7 +558,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field.</dd>
<dt id="Pedometer.StrideLength" class="number"><em>StrideLength</em></dt> <dt id="Pedometer.StrideLength" class="number"><em>StrideLength</em></dt>
<dd>Set the average stride length in meters.</dd> <dd>Set the average stride length in meters.</dd>
<dt id="Pedometer.UseGPS" class="boolean wo bo"><em>UseGPS</em></dt> <dt id="Pedometer.UseGPS" class="boolean wo bo"><em>UseGPS</em></dt>
<dd></dd> <dd>This property has been deprecated.</dd>
<dt id="Pedometer.WalkSteps" class="number ro bo"><em>WalkSteps</em></dt> <dt id="Pedometer.WalkSteps" class="number ro bo"><em>WalkSteps</em></dt>
<dd>the number of walk steps taken since the pedometer has started.</dd> <dd>the number of walk steps taken since the pedometer has started.</dd>
</dl> </dl>
...@@ -567,17 +567,17 @@ Valid values for the month field are 1-12 and 1-31 for the day field.</dd> ...@@ -567,17 +567,17 @@ Valid values for the month field are 1-12 and 1-31 for the day field.</dd>
<dl class="events"> <dl class="events">
<dt id="Pedometer.CalibrationFailed">CalibrationFailed()</dt> <dt id="Pedometer.CalibrationFailed">CalibrationFailed()</dt>
<dd>Event for CalibrationFailed</dd> <dd>This event has been deprecated.</dd>
<dt id="Pedometer.GPSAvailable">GPSAvailable()</dt> <dt id="Pedometer.GPSAvailable">GPSAvailable()</dt>
<dd>Event for GPSAvailable</dd> <dd>This event has been deprecated.</dd>
<dt id="Pedometer.GPSLost">GPSLost()</dt> <dt id="Pedometer.GPSLost">GPSLost()</dt>
<dd>Event for GPSLost</dd> <dd>This event has been deprecated.</dd>
<dt id="Pedometer.SimpleStep">SimpleStep(<em class="number">simpleSteps</em>,<em class="number">distance</em>)</dt> <dt id="Pedometer.SimpleStep">SimpleStep(<em class="number">simpleSteps</em>,<em class="number">distance</em>)</dt>
<dd>This event is run when a raw step is detected</dd> <dd>This event is run when a raw step is detected</dd>
<dt id="Pedometer.StartedMoving">StartedMoving()</dt> <dt id="Pedometer.StartedMoving">StartedMoving()</dt>
<dd>Event for StartedMoving</dd> <dd>This event has been deprecated.</dd>
<dt id="Pedometer.StoppedMoving">StoppedMoving()</dt> <dt id="Pedometer.StoppedMoving">StoppedMoving()</dt>
<dd>Event for StoppedMoving</dd> <dd>This event has been deprecated.</dd>
<dt id="Pedometer.WalkStep">WalkStep(<em class="number">walkSteps</em>,<em class="number">distance</em>)</dt> <dt id="Pedometer.WalkStep">WalkStep(<em class="number">walkSteps</em>,<em class="number">distance</em>)</dt>
<dd>This event is run when a walking step is detected. A walking step is a step that appears to be involved in forward motion.</dd> <dd>This event is run when a walking step is detected. A walking step is a step that appears to be involved in forward motion.</dd>
</dl> </dl>
......
...@@ -435,7 +435,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field. ...@@ -435,7 +435,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field.
manifest. See Compiler.java. manifest. See Compiler.java.
{:id="NearField.TagWritten"} TagWritten() {:id="NearField.TagWritten"} TagWritten()
: Event for TagWritten : Indicates that a tag has come into range of the NFC sensor and has been written.
## OrientationSensor {#OrientationSensor} ## OrientationSensor {#OrientationSensor}
...@@ -494,7 +494,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field. ...@@ -494,7 +494,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field.
{:.properties} {:.properties}
{:id="Pedometer.CalibrateStrideLength" .boolean .bo} *CalibrateStrideLength* {:id="Pedometer.CalibrateStrideLength" .boolean .bo} *CalibrateStrideLength*
: : This property has been deprecated.
{:id="Pedometer.Distance" .number .ro .bo} *Distance* {:id="Pedometer.Distance" .number .ro .bo} *Distance*
: The approximate distance traveled in meters. : The approximate distance traveled in meters.
...@@ -503,7 +503,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field. ...@@ -503,7 +503,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field.
: Time elapsed in milliseconds since the pedometer was started. : Time elapsed in milliseconds since the pedometer was started.
{:id="Pedometer.Moving" .boolean .ro .bo} *Moving* {:id="Pedometer.Moving" .boolean .ro .bo} *Moving*
: : This property has been deprecated.
{:id="Pedometer.SimpleSteps" .number .ro .bo} *SimpleSteps* {:id="Pedometer.SimpleSteps" .number .ro .bo} *SimpleSteps*
: The number of simple steps taken since the pedometer has started. : The number of simple steps taken since the pedometer has started.
...@@ -515,7 +515,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field. ...@@ -515,7 +515,7 @@ Valid values for the month field are 1-12 and 1-31 for the day field.
: Set the average stride length in meters. : Set the average stride length in meters.
{:id="Pedometer.UseGPS" .boolean .wo .bo} *UseGPS* {:id="Pedometer.UseGPS" .boolean .wo .bo} *UseGPS*
: : This property has been deprecated.
{:id="Pedometer.WalkSteps" .number .ro .bo} *WalkSteps* {:id="Pedometer.WalkSteps" .number .ro .bo} *WalkSteps*
: the number of walk steps taken since the pedometer has started. : the number of walk steps taken since the pedometer has started.
...@@ -525,22 +525,22 @@ Valid values for the month field are 1-12 and 1-31 for the day field. ...@@ -525,22 +525,22 @@ Valid values for the month field are 1-12 and 1-31 for the day field.
{:.events} {:.events}
{:id="Pedometer.CalibrationFailed"} CalibrationFailed() {:id="Pedometer.CalibrationFailed"} CalibrationFailed()
: Event for CalibrationFailed : This event has been deprecated.
{:id="Pedometer.GPSAvailable"} GPSAvailable() {:id="Pedometer.GPSAvailable"} GPSAvailable()
: Event for GPSAvailable : This event has been deprecated.
{:id="Pedometer.GPSLost"} GPSLost() {:id="Pedometer.GPSLost"} GPSLost()
: Event for GPSLost : This event has been deprecated.
{:id="Pedometer.SimpleStep"} SimpleStep(*simpleSteps*{:.number},*distance*{:.number}) {:id="Pedometer.SimpleStep"} SimpleStep(*simpleSteps*{:.number},*distance*{:.number})
: This event is run when a raw step is detected : This event is run when a raw step is detected
{:id="Pedometer.StartedMoving"} StartedMoving() {:id="Pedometer.StartedMoving"} StartedMoving()
: Event for StartedMoving : This event has been deprecated.
{:id="Pedometer.StoppedMoving"} StoppedMoving() {:id="Pedometer.StoppedMoving"} StoppedMoving()
: Event for StoppedMoving : This event has been deprecated.
{:id="Pedometer.WalkStep"} WalkStep(*walkSteps*{:.number},*distance*{:.number}) {:id="Pedometer.WalkStep"} WalkStep(*walkSteps*{:.number},*distance*{:.number})
: This event is run when a walking step is detected. A walking step is a step that appears to be involved in forward motion. : This event is run when a walking step is detected. A walking step is a step that appears to be involved in forward motion.
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment