From aaffdde5fd1d826c35c1931a91bfebab1327d4fe Mon Sep 17 00:00:00 2001
From: Toni Gundogdu <legatvs.git@gmail.com>
Date: Mon, 3 Jan 2011 17:27:06 +0200
Subject: [PATCH] Tweak API function descriptions

* quvi_supported
* quvi_next_supported_website
---
 include/quvi/quvi.h.in | 26 ++++++++++++++++++--------
 1 file changed, 18 insertions(+), 8 deletions(-)

diff --git a/include/quvi/quvi.h.in b/include/quvi/quvi.h.in
index 9729e58..32e6041 100644
--- a/include/quvi/quvi.h.in
+++ b/include/quvi/quvi.h.in
@@ -491,19 +491,27 @@ QUVIcode quvi_getprop(quvi_video_t video, QUVIproperty prop, ...);
 /**
 * @brief Checks whether the URL would be supported by one of the scripts
 *
-* This function does not require a network connection. This means that this
-* function will return QUVI_NOSUPPORT for most shortened URLs. See also
-* the notes below.
+* This function does not require an Internet connection. Note that this
+* function will return QUVI_NOSUPPORT for nearly all shortened (or
+* "compressed") URLs as they require querying a redirection over the
+* Internet. See the "Exceptions" below.
 *
 * @param quvi Handle to session
 * @param url Null-terminated string to an URL
 *
 * @note
+*   - Most shorteners require retrieving the redirection from the
+*     services before
 *   - Returns QUVI_NOSUPPORT for most shortened URLs
-*   - Only exceptions are those that have been hardcoded to lua scripts
-*   as "official" shorteners for those websites (e.g. youtu.be or
-*   dai.ly)
-*
+*   - Examples:
+*     - is.gd
+*     - goo.gl
+*     - ...
+*   - Exceptions:
+*     - youtu.be (script: youtube.lua)
+*     - dai.y (script: dailymotion.lua)
+*     - These services do not "compress" the video ID which can be used
+*     in the above scripts to reconstruct the original URL
 * @return Non-zero if an error occurred
 */
 QUVIcode quvi_supported(quvi_t quvi, char *url);
@@ -579,7 +587,9 @@ void quvi_parse_close(quvi_video_t *video);
 *
 * @return QUVI_OK or a non-zero value if an error occurred
 *   - QUVI_LAST indicates end of the list of the websites
-*   - Any other returned non-zero value indicates an actual error and should be handled accordingly (e.g. relaying the return code to \a quvi_strerror)
+*   - Any other returned non-zero value indicates an actual error and
+*     should be handled accordingly (e.g. relaying the return code to
+*     \a quvi_strerror)
 *
 * @note
 *   - Both domain and formats string must be quvi_free()d after use
-- 
2.11.4.GIT