diff options
author | Joe Fernandez <joefernandez@google.com> | 2011-12-20 10:38:34 -0800 |
---|---|---|
committer | Joe Fernandez <joefernandez@google.com> | 2011-12-22 15:08:23 -0800 |
commit | 3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45 (patch) | |
tree | 7600f58de48f6764d476cc9d6a92ed0a5dddf278 /voip | |
parent | 8f04ae361cd34fdaea41fbedefb85cff2c684e36 (diff) | |
download | frameworks_base-3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45.zip frameworks_base-3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45.tar.gz frameworks_base-3aef8e1d1b2f0b87d470bcccf37ba4ebb6560c45.tar.bz2 |
docs: Add developer guide cross-references, Project ACRE, round 4
Change-Id: I1b43414aaec8ea217b39a0d780c80a25409d0991
Diffstat (limited to 'voip')
-rw-r--r-- | voip/java/android/net/sip/SipAudioCall.java | 9 | ||||
-rw-r--r-- | voip/java/android/net/sip/SipManager.java | 9 | ||||
-rw-r--r-- | voip/java/android/net/sip/SipProfile.java | 7 | ||||
-rw-r--r-- | voip/java/android/net/sip/package.html | 8 |
4 files changed, 30 insertions, 3 deletions
diff --git a/voip/java/android/net/sip/SipAudioCall.java b/voip/java/android/net/sip/SipAudioCall.java index fcdbd2c..1d67055 100644 --- a/voip/java/android/net/sip/SipAudioCall.java +++ b/voip/java/android/net/sip/SipAudioCall.java @@ -44,13 +44,20 @@ import java.util.Map; * * <p class="note"><strong>Note:</strong> Using this class require the * {@link android.Manifest.permission#INTERNET} and - * {@link android.Manifest.permission#USE_SIP} permissions.<br/><br/>In addition, {@link + * {@link android.Manifest.permission#USE_SIP} permissions. In addition, {@link * #startAudio} requires the * {@link android.Manifest.permission#RECORD_AUDIO}, * {@link android.Manifest.permission#ACCESS_WIFI_STATE}, and * {@link android.Manifest.permission#WAKE_LOCK} permissions; and {@link #setSpeakerMode * setSpeakerMode()} requires the * {@link android.Manifest.permission#MODIFY_AUDIO_SETTINGS} permission.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using SIP, read the + * <a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a> + * developer guide.</p> + * </div> */ public class SipAudioCall { private static final String TAG = SipAudioCall.class.getSimpleName(); diff --git a/voip/java/android/net/sip/SipManager.java b/voip/java/android/net/sip/SipManager.java index cd0b5c4..74c3672 100644 --- a/voip/java/android/net/sip/SipManager.java +++ b/voip/java/android/net/sip/SipManager.java @@ -49,9 +49,16 @@ import java.text.ParseException; * SIP. You should always call {@link android.net.sip.SipManager#isVoipSupported * isVoipSupported()} to verify that the device supports VOIP calling and {@link * android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports - * the SIP APIs.<br/><br/>Your application must also request the {@link + * the SIP APIs. Your application must also request the {@link * android.Manifest.permission#INTERNET} and {@link android.Manifest.permission#USE_SIP} * permissions.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using SIP, read the + * <a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a> + * developer guide.</p> + * </div> */ public class SipManager { /** diff --git a/voip/java/android/net/sip/SipProfile.java b/voip/java/android/net/sip/SipProfile.java index 34d91dd..0ef754c 100644 --- a/voip/java/android/net/sip/SipProfile.java +++ b/voip/java/android/net/sip/SipProfile.java @@ -37,6 +37,13 @@ import javax.sip.address.URI; * <p>You can create a {@link SipProfile} using {@link * SipProfile.Builder}. You can also retrieve one from a {@link SipSession}, using {@link * SipSession#getLocalProfile} and {@link SipSession#getPeerProfile}.</p> + * + * <div class="special reference"> + * <h3>Developer Guides</h3> + * <p>For more information about using SIP, read the + * <a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a> + * developer guide.</p> + * </div> */ public class SipProfile implements Parcelable, Serializable, Cloneable { private static final long serialVersionUID = 1L; diff --git a/voip/java/android/net/sip/package.html b/voip/java/android/net/sip/package.html index 790656b..eb683d0 100644 --- a/voip/java/android/net/sip/package.html +++ b/voip/java/android/net/sip/package.html @@ -3,6 +3,11 @@ <p>Provides access to Session Initiation Protocol (SIP) functionality, such as making and answering VOIP calls using SIP.</p> +<p>For more information, see the +<a href="{@docRoot}guide/topics/network/sip.html">Session Initiation Protocol</a> +developer guide.</p> +{@more} + <p>To get started, you need to get an instance of the {@link android.net.sip.SipManager} by calling {@link android.net.sip.SipManager#newInstance newInstance()}.</p> @@ -31,9 +36,10 @@ Not all Android-powered devices support VOIP functionality with SIP. Before perf activity, you should call {@link android.net.sip.SipManager#isVoipSupported isVoipSupported()} to verify that the device supports VOIP calling and {@link android.net.sip.SipManager#isApiSupported isApiSupported()} to verify that the device supports the -SIP APIs.<br/><br/> +SIP APIs. Your application must also request the {@link android.Manifest.permission#INTERNET} and {@link android.Manifest.permission#USE_SIP} permissions in order to use the SIP APIs. </p> + </BODY> </HTML>
\ No newline at end of file |