Blame src/api/doxy/chk_support.dp

Packit 3ff1e7
/** @page chk_support Checking whether an URL is supported
Packit 3ff1e7
Packit 3ff1e7
Checking whether the available @ref m_script or @ref pl_script collection
Packit 3ff1e7
accepts the URL may be done either with or without an internet connection.
Packit 3ff1e7
Packit 3ff1e7
Note, however, that most checks will return the "no support" error
Packit 3ff1e7
with the @ref sh_url and the @ref QUVI_SUPPORTS_MODE_OFFLINE, as this
Packit 3ff1e7
would normally require resolving the URL over the Internet, first.
Packit 3ff1e7
Packit 3ff1e7
@code
Packit 3ff1e7
QuviBoolean r = quvi_supports(q, URL,
Packit 3ff1e7
                              QUVI_SUPPORTS_MODE_OFFLINE,
Packit 3ff1e7
                              QUVI_SUPPORTS_TYPE_MEDIA);
Packit 3ff1e7
@endcode
Packit 3ff1e7
Packit 3ff1e7
Similar to the above but do an online check, instead:
Packit 3ff1e7
Packit 3ff1e7
@code
Packit 3ff1e7
QuviBoolean r = quvi_supports(q, URL,
Packit 3ff1e7
                              QUVI_SUPPORTS_MODE_ONLINE,
Packit 3ff1e7
                              QUVI_SUPPORTS_TYPE_MEDIA);
Packit 3ff1e7
@endcode
Packit 3ff1e7
Packit 3ff1e7
The above two examples limit the check to @ref m_script support only.
Packit 3ff1e7
The example below tells the library to check the URL against
Packit 3ff1e7
@ref m_script and @ref pl_script collections.
Packit 3ff1e7
Packit 3ff1e7
@code
Packit 3ff1e7
QuviBoolean r = quvi_supports(q, URL,
Packit 3ff1e7
                              QUVI_SUPPORTS_MODE_ONLINE,
Packit 3ff1e7
                              QUVI_SUPPORTS_TYPE_ANY);
Packit 3ff1e7
@endcode
Packit 3ff1e7
Packit 3ff1e7
@sa QuviSupportsMode
Packit 3ff1e7
@sa QuviSupportsType
Packit 3ff1e7
Packit 3ff1e7
The available @ref m_script and @ref pl_script collection determines which
Packit 3ff1e7
websites are supported by the library.
Packit 3ff1e7
*/