From: Michael Wallner Date: Thu, 18 Aug 2016 20:58:35 +0000 (+0200) Subject: consolidate notes X-Git-Url: https://git.m6w6.name/?a=commitdiff_plain;h=a6882b68705828177d779e0dee653f79e0569155;p=mdref%2Fmdref-http consolidate notes --- diff --git a/http/Client/Request/setOptions.md b/http/Client/Request/setOptions.md index cbd3b9f..5ff0333 100644 --- a/http/Client/Request/setOptions.md +++ b/http/Client/Request/setOptions.md @@ -5,7 +5,8 @@ See http\Client::setOptions() and http\Client\Curl. Request specific options override general options which were set in the client. -> **Note:** Only options specified prior enqueueing a request are applied to the request. +> ***NOTE:*** +> Only options specified prior enqueueing a request are applied to the request. ## Params: diff --git a/http/Client/count.md b/http/Client/count.md index 851ae1f..67718e6 100644 --- a/http/Client/count.md +++ b/http/Client/count.md @@ -2,7 +2,8 @@ Implements Countable. Retrieve the number of enqueued requests. -> **Note:** The enqueued requests are counted without regard whether they are finished or not. +> ***NOTE:*** +> The enqueued requests are counted without regard whether they are finished or not. ## Params: diff --git a/http/Client/getHistory.md b/http/Client/getHistory.md index 60d3ecf..5cfeca7 100644 --- a/http/Client/getHistory.md +++ b/http/Client/getHistory.md @@ -2,7 +2,8 @@ Simply returns the http\Message chain representing the request/response history. -> **Note:** The history is only recorded while http\Client::$recordHistory is true. +> ***NOTE:*** +> The history is only recorded while http\Client::$recordHistory is true. ## Params: diff --git a/http/Client/getResponse.md b/http/Client/getResponse.md index 00d3d95..f006b3d 100644 --- a/http/Client/getResponse.md +++ b/http/Client/getResponse.md @@ -2,7 +2,8 @@ Retrieve the corresponding reponse of an already finished request, or the last received response if $request is not set. -> **Note:** If $request is NULL, then the response is removed from the internal storage (stack-like operation). +> ***NOTE:*** +> If $request is NULL, then the response is removed from the internal storage (stack-like operation). ## Params: diff --git a/http/Client/setOptions.md b/http/Client/setOptions.md index 50136fb..9a6233f 100644 --- a/http/Client/setOptions.md +++ b/http/Client/setOptions.md @@ -3,7 +3,8 @@ Set client options. See http\Client\Curl. -> **Note:** Only options specified prior enqueueing a request are applied to the request. +> ***NOTE:*** +> Only options specified prior enqueueing a request are applied to the request. ## Params: diff --git a/http/Cookie/getExpires.md b/http/Cookie/getExpires.md index 46300a5..853cde7 100644 --- a/http/Cookie/getExpires.md +++ b/http/Cookie/getExpires.md @@ -3,7 +3,8 @@ Get the currently set expires attribute. See http\Cookie::setExpires(). -> **Note:** A return value of -1 means that the attribute is not set. +> ***NOTE:*** +> A return value of -1 means that the attribute is not set. ## Params: diff --git a/http/Cookie/getMaxAge.md b/http/Cookie/getMaxAge.md index 88c476f..44b61c5 100644 --- a/http/Cookie/getMaxAge.md +++ b/http/Cookie/getMaxAge.md @@ -3,7 +3,8 @@ Get the currently set max-age attribute of the cookie list. See http\Cookie::setMaxAge(). -> **Note:** A return value of -1 means that the attribute is not set. +> ***NOTE:*** +> A return value of -1 means that the attribute is not set. ## Params: diff --git a/http/Cookie/setCookie.md b/http/Cookie/setCookie.md index 15b88d0..88adba4 100644 --- a/http/Cookie/setCookie.md +++ b/http/Cookie/setCookie.md @@ -3,7 +3,8 @@ (Re)set a cookie. See http\Cookie::addCookie() and http\Cookie::setCookies(). -> **Note:** The cookie will be deleted from the list if $cookie_value is NULL. +> ***NOTE:*** +> The cookie will be deleted from the list if $cookie_value is NULL. ## Params: diff --git a/http/Cookie/setExtra.md b/http/Cookie/setExtra.md index ff40921..72312d3 100644 --- a/http/Cookie/setExtra.md +++ b/http/Cookie/setExtra.md @@ -3,7 +3,8 @@ (Re)set an extra attribute. See http\Cookie::addExtra(). -> **Note:** The attribute will be removed from the extras list if $extra_value is NULL. +> ***NOTE:*** +> The attribute will be removed from the extras list if $extra_value is NULL. ## Params: diff --git a/http/Env/Response/setEtag.md b/http/Env/Response/setEtag.md index f71c80b..4321ceb 100644 --- a/http/Env/Response/setEtag.md +++ b/http/Env/Response/setEtag.md @@ -2,7 +2,8 @@ Set a custom ETag. -> **Note:** This will be used for caching and pre-condition checks. +> ***NOTE:*** +> This will be used for caching and pre-condition checks. ## Params: diff --git a/http/Env/Response/setLastModified.md b/http/Env/Response/setLastModified.md index a057605..046f030 100644 --- a/http/Env/Response/setLastModified.md +++ b/http/Env/Response/setLastModified.md @@ -2,7 +2,8 @@ Set a custom last modified time stamp. -> **Note:** This will be used for caching and pre-condition checks. +> ***NOTE:*** +> This will be used for caching and pre-condition checks. ## Params: diff --git a/http/Env/Response/setThrottleRate.md b/http/Env/Response/setThrottleRate.md index 03b7047..686d5e9 100644 --- a/http/Env/Response/setThrottleRate.md +++ b/http/Env/Response/setThrottleRate.md @@ -3,7 +3,8 @@ Enable throttling. Send $chunk_size bytes every $delay seconds. -> **Note:** If you need throttling by regular means, check for other options in your stack, because this method blocks the executing process/thread until the response has completely been sent. +> ***NOTE:*** +> If you need throttling by regular means, check for other options in your stack, because this method blocks the executing process/thread until the response has completely been sent. ## Params: diff --git a/http/Env/negotiate.md b/http/Env/negotiate.md index 86786bb..6463bef 100644 --- a/http/Env/negotiate.md +++ b/http/Env/negotiate.md @@ -2,7 +2,8 @@ Generic negotiator. For specific client negotiation see http\Env::negotiateContentType() and related methods. -> **Note:** The first elemement of $supported serves as a default if no operand matches. +> ***NOTE:*** +> The first elemement of $supported serves as a default if no operand matches. ## Params: diff --git a/http/Env/negotiateCharset.md b/http/Env/negotiateCharset.md index 9db7a79..084c622 100644 --- a/http/Env/negotiateCharset.md +++ b/http/Env/negotiateCharset.md @@ -2,7 +2,8 @@ Negotiate the client's preferred character set. -> **Note:** The first elemement of $supported character sets serves as a default if no character set matches. +> ***NOTE:*** +> The first elemement of $supported character sets serves as a default if no character set matches. ## Params: diff --git a/http/Env/negotiateContentType.md b/http/Env/negotiateContentType.md index d5ee500..ccdac81 100644 --- a/http/Env/negotiateContentType.md +++ b/http/Env/negotiateContentType.md @@ -2,7 +2,8 @@ Negotiate the client's preferred MIME content type. -> **Note:** The first elemement of $supported content types serves as a default if no content-type matches. +> ***NOTE:*** +> The first elemement of $supported content types serves as a default if no content-type matches. ## Params: diff --git a/http/Env/negotiateEncoding.md b/http/Env/negotiateEncoding.md index 7053373..60e90d2 100644 --- a/http/Env/negotiateEncoding.md +++ b/http/Env/negotiateEncoding.md @@ -2,7 +2,8 @@ Negotiate the client's preferred encoding. -> **Note:** The first elemement of $supported encodings serves as a default if no encoding matches. +> ***NOTE:*** +> The first elemement of $supported encodings serves as a default if no encoding matches. ## Params: diff --git a/http/Env/negotiateLanguage.md b/http/Env/negotiateLanguage.md index 4c91b93..a50561c 100644 --- a/http/Env/negotiateLanguage.md +++ b/http/Env/negotiateLanguage.md @@ -2,7 +2,8 @@ Negotiate the client's preferred language. -> **Note:** The first elemement of $supported languages serves as a default if no language matches. +> ***NOTE:*** +> The first elemement of $supported languages serves as a default if no language matches. ## Params: diff --git a/http/Header/negotiate.md b/http/Header/negotiate.md index dd2d1c8..b9aaff9 100644 --- a/http/Header/negotiate.md +++ b/http/Header/negotiate.md @@ -6,7 +6,8 @@ header being negotiated is Accept, then a slash is used as primary type separator, and if the header is Accept-Language respectively, a hyphen is used instead. -> **Note:** The first elemement of $supported serves as a default if no operand matches. +> ***NOTE:*** +> The first elemement of $supported serves as a default if no operand matches. ## Params: diff --git a/http/Message/Body.md b/http/Message/Body.md index ef684ad..89dd07a 100644 --- a/http/Message/Body.md +++ b/http/Message/Body.md @@ -2,7 +2,8 @@ The message body, represented as a PHP (temporary) stream. -> **Note:** Currently, http\Message\Body::addForm() creates multipart/form-data bodies. +> ***NOTE:*** +> Currently, http\Message\Body::addForm() creates multipart/form-data bodies. ## Constants: diff --git a/http/Message/Body/addForm.md b/http/Message/Body/addForm.md index 19e3b6c..5b59fc0 100644 --- a/http/Message/Body/addForm.md +++ b/http/Message/Body/addForm.md @@ -2,7 +2,8 @@ Add form fields and files to the message body. -> **Note:** Currently, http\Message\Body::addForm() creates "multipart/form-data" bodies. +> ***NOTE:*** +> Currently, http\Message\Body::addForm() creates "multipart/form-data" bodies. ## Params: diff --git a/http/Message/prepend.md b/http/Message/prepend.md index 7bc88df..308475d 100644 --- a/http/Message/prepend.md +++ b/http/Message/prepend.md @@ -2,7 +2,8 @@ Prepend message(s) $message to this message, or the top most message of this message chain. -> **Note:** The message chains must not overlap. +> ***NOTE:*** +> The message chains must not overlap. ## Params: diff --git a/http/Message/reverse.md b/http/Message/reverse.md index 9189589..00d8c15 100644 --- a/http/Message/reverse.md +++ b/http/Message/reverse.md @@ -2,7 +2,8 @@ Reverse the message chain and return the former top-most message. -> **Note:** Message chains are ordered in reverse-parsed order by default, i.e. the last parsed message is the message you'll receive from any call parsing HTTP messages. +> ***NOTE:*** +> Message chains are ordered in reverse-parsed order by default, i.e. the last parsed message is the message you'll receive from any call parsing HTTP messages. > > This call re-orders the messages of the chain and returns the message that was parsed first with any later parsed messages re-parentized. diff --git a/http/Message/setRequestUrl.md b/http/Message/setRequestUrl.md index 30e4a7d..766b3d1 100644 --- a/http/Message/setRequestUrl.md +++ b/http/Message/setRequestUrl.md @@ -19,7 +19,8 @@ See http\Message::getRequestUrl() and http\Message::setRequestMethod(). ## Example: -> **Note:** The request URL in a request message usually only consists of the path and the querystring. +> ***NOTE:*** +> The request URL in a request message usually only consists of the path and the querystring. **Note:** This method also resets the response status phrase to the default for that code. +> ***NOTE:*** +> This method also resets the response status phrase to the default for that code. ## Params: diff --git a/http/QueryString/mod.md b/http/QueryString/mod.md index 83068e9..aaff3d5 100644 --- a/http/QueryString/mod.md +++ b/http/QueryString/mod.md @@ -3,7 +3,8 @@ Set additional $params to a clone of this instance. See http\QueryString::set(). -> **Note:** This method returns a clone (copy) of this instance. +> ***NOTE:*** +> This method returns a clone (copy) of this instance. ## Params: diff --git a/http/QueryString/xlate.md b/http/QueryString/xlate.md index 4087b40..06ceb01 100644 --- a/http/QueryString/xlate.md +++ b/http/QueryString/xlate.md @@ -2,7 +2,8 @@ Translate character encodings of the querystring with ext/iconv. -> **Note:** This method is only available when ext/iconv support was enabled at build time. +> ***NOTE:*** +> This method is only available when ext/iconv support was enabled at build time. ## Params: