Skip to content

Commit

Permalink
docs: convert markdown links to href formatted links (#581)
Browse files Browse the repository at this point in the history
* docs: convert markdown links to href formatted links

* fix long line wrapping

* additional fixes to long line wrapping

* regenerate documentation with corrected long line wrapping

* rebased

Co-authored-by: Jennifer Mah <[email protected]>
  • Loading branch information
JenniferMah and Jennifer Mah authored Sep 17, 2020
1 parent 94eccf2 commit 4548332
Show file tree
Hide file tree
Showing 202 changed files with 1,776 additions and 1,439 deletions.
35 changes: 22 additions & 13 deletions src/main/java/com/twilio/rest/api/v2010/account/CallCreator.java
Original file line number Diff line number Diff line change
Expand Up @@ -246,8 +246,10 @@ public CallCreator setStatusCallback(final String statusCallback) {
* be: `initiated`, `ringing`, `answered`, and `completed`. If no event is
* specified, we send the `completed` status. If you want to receive multiple
* events, specify each one in a separate `status_callback_event` parameter. See
* the code sample for [monitoring call
* progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&amp;code-sdk-version=json). If an `application_sid` is present, this parameter is ignored..
* the code sample for <a
* href="https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&amp;code-sdk-version=json">monitoring
* call progress</a>. If an `application_sid` is present, this parameter is
* ignored..
*
* @param statusCallbackEvent The call progress events that we send to the
* `status_callback` URL.
Expand All @@ -263,8 +265,10 @@ public CallCreator setStatusCallbackEvent(final List<String> statusCallbackEvent
* be: `initiated`, `ringing`, `answered`, and `completed`. If no event is
* specified, we send the `completed` status. If you want to receive multiple
* events, specify each one in a separate `status_callback_event` parameter. See
* the code sample for [monitoring call
* progress](https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&amp;code-sdk-version=json). If an `application_sid` is present, this parameter is ignored..
* the code sample for <a
* href="https://www.twilio.com/docs/voice/api/call-resource?code-sample=code-create-a-call-resource-and-specify-a-statuscallbackevent&amp;code-sdk-version=json">monitoring
* call progress</a>. If an `application_sid` is present, this parameter is
* ignored..
*
* @param statusCallbackEvent The call progress events that we send to the
* `status_callback` URL.
Expand Down Expand Up @@ -407,8 +411,9 @@ public CallCreator setSipAuthPassword(final String sipAuthPassword) {
* us to return `AnsweredBy` as soon as the called party is identified. Use
* `DetectMessageEnd`, if you would like to leave a message on an answering
* machine. If `send_digits` is provided, this parameter is ignored. For more
* information, see [Answering Machine
* Detection](https://www.twilio.com/docs/voice/answering-machine-detection)..
* information, see <a
* href="https://www.twilio.com/docs/voice/answering-machine-detection">Answering
* Machine Detection</a>..
*
* @param machineDetection Enable machine detection or end of greeting detection
* @return this
Expand Down Expand Up @@ -476,9 +481,9 @@ public CallCreator setTrim(final String trim) {

/**
* The phone number, SIP address, or Client identifier that made this call.
* Phone numbers are in [E.164
* format](https://wwnw.twilio.com/docs/glossary/what-e164) (e.g.,
* +16175551212). SIP addresses are formatted as `[email protected]`..
* Phone numbers are in <a
* href="https://wwnw.twilio.com/docs/glossary/what-e164">E.164 format</a>
* (e.g., +16175551212). SIP addresses are formatted as `[email protected]`..
*
* @param callerId The phone number, SIP address, or Client identifier that
* made this call. Phone numbers are in E.164 format (e.g.,
Expand Down Expand Up @@ -616,8 +621,10 @@ public CallCreator setCallReason(final String callReason) {
/**
* The absolute URL that returns the TwiML instructions for the call. We will
* call this URL using the `method` when the call connects. For more
* information, see the [Url
* Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls)..
* information, see the <a
* href="https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter">Url
* Parameter</a> section in <a
* href="https://www.twilio.com/docs/voice/make-calls">Making Calls</a>..
*
* @param url The absolute URL that returns TwiML for this call
* @return this
Expand All @@ -630,8 +637,10 @@ public CallCreator setUrl(final URI url) {
/**
* The absolute URL that returns the TwiML instructions for the call. We will
* call this URL using the `method` when the call connects. For more
* information, see the [Url
* Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls)..
* information, see the <a
* href="https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter">Url
* Parameter</a> section in <a
* href="https://www.twilio.com/docs/voice/make-calls">Making Calls</a>..
*
* @param url The absolute URL that returns TwiML for this call
* @return this
Expand Down
12 changes: 8 additions & 4 deletions src/main/java/com/twilio/rest/api/v2010/account/CallUpdater.java
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,10 @@ public CallUpdater(final String pathAccountSid,
/**
* The absolute URL that returns the TwiML instructions for the call. We will
* call this URL using the `method` when the call connects. For more
* information, see the [Url
* Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls)..
* information, see the <a
* href="https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter">Url
* Parameter</a> section in <a
* href="https://www.twilio.com/docs/voice/make-calls">Making Calls</a>..
*
* @param url The absolute URL that returns TwiML for this call
* @return this
Expand All @@ -72,8 +74,10 @@ public CallUpdater setUrl(final URI url) {
/**
* The absolute URL that returns the TwiML instructions for the call. We will
* call this URL using the `method` when the call connects. For more
* information, see the [Url
* Parameter](https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter) section in [Making Calls](https://www.twilio.com/docs/voice/make-calls)..
* information, see the <a
* href="https://www.twilio.com/docs/voice/make-calls#specify-a-url-parameter">Url
* Parameter</a> section in <a
* href="https://www.twilio.com/docs/voice/make-calls">Making Calls</a>..
*
* @param url The absolute URL that returns TwiML for this call
* @return this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -430,10 +430,10 @@ public IncomingPhoneNumberCreator setBundleSid(final String bundleSid) {
}

/**
* The phone number to purchase specified in
* [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone
* numbers consist of a + followed by the country code and subscriber number
* without punctuation characters. For example, +14155551234..
* The phone number to purchase specified in <a
* href="https://www.twilio.com/docs/glossary/what-e164">E.164</a> format.
* E.164 phone numbers consist of a + followed by the country code and
* subscriber number without punctuation characters. For example, +14155551234..
*
* @param phoneNumber The phone number to purchase in E.164 format
* @return this
Expand All @@ -444,10 +444,10 @@ public IncomingPhoneNumberCreator setPhoneNumber(final com.twilio.type.PhoneNumb
}

/**
* The phone number to purchase specified in
* [E.164](https://www.twilio.com/docs/glossary/what-e164) format. E.164 phone
* numbers consist of a + followed by the country code and subscriber number
* without punctuation characters. For example, +14155551234..
* The phone number to purchase specified in <a
* href="https://www.twilio.com/docs/glossary/what-e164">E.164</a> format.
* E.164 phone numbers consist of a + followed by the country code and
* subscriber number without punctuation characters. For example, +14155551234..
*
* @param phoneNumber The phone number to purchase in E.164 format
* @return this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,10 +70,11 @@ public IncomingPhoneNumberUpdater(final String pathAccountSid,
}

/**
* The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that
* created the IncomingPhoneNumber resource to update. For more information,
* see [Exchanging Numbers Between
* Subaccounts](https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers)..
* The SID of the <a
* href="https://www.twilio.com/docs/iam/api/account">Account</a> that created
* the IncomingPhoneNumber resource to update. For more information, see <a
* href="https://www.twilio.com/docs/iam/api/subaccounts#exchanging-numbers">Exchanging
* Numbers Between Subaccounts</a>..
*
* @param accountSid The SID of the Account that created the resource to update
* @return this
Expand Down
Loading

0 comments on commit 4548332

Please sign in to comment.