summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavi Artigas <xavierartigas@yahoo.es>2019-11-18 11:57:30 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-11-18 12:00:35 +0100
commit1c5849c5a8b2b3ccc48caf55e5568f122bb0be9a (patch)
tree194c28da5a4b71743928dfbd49b23e263a076677
parent3f3b7259453a4519e40e90b15962331158928ac4 (diff)
doxygen: Prevent auto-linking of invalid links
Anything starting with http://, ftp:// or file:// is automatically converted into a link by doxygen. However, we have a few instances where we do not want this. Fortunately, doxygen allows using % to forbid specific words from being linked.
-rw-r--r--src/lib/ecore_file/Ecore_File.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/src/lib/ecore_file/Ecore_File.h b/src/lib/ecore_file/Ecore_File.h
index 23a0521945..37f3bd8a0c 100644
--- a/src/lib/ecore_file/Ecore_File.h
+++ b/src/lib/ecore_file/Ecore_File.h
@@ -609,8 +609,8 @@ EAPI Eina_List *ecore_file_app_list(void);
609 * @return @c EINA_TRUE if the download start or @c EINA_FALSE on failure. 609 * @return @c EINA_TRUE if the download start or @c EINA_FALSE on failure.
610 * 610 *
611 * This function starts the download of the URL @p url and saves it to 611 * This function starts the download of the URL @p url and saves it to
612 * @p dst. @p url must provide the protocol, including 'http://', 612 * @p dst. @p url must provide the protocol, including '%http://',
613 * 'ftp://' or 'file://'. Ecore_File must be compiled with CURL to 613 * '%ftp://' or '%file://'. Ecore_File must be compiled with CURL to
614 * download using http and ftp protocols. If @p dst is ill-formed, or 614 * download using http and ftp protocols. If @p dst is ill-formed, or
615 * if it already exists, the function returns @c EINA_FALSE. When the 615 * if it already exists, the function returns @c EINA_FALSE. When the
616 * download is complete, the callback @p completion_cb is called and 616 * download is complete, the callback @p completion_cb is called and
@@ -684,8 +684,8 @@ EAPI void ecore_file_download_abort(Ecore_File_Download_Job *job);
684 * @return @c EINA_TRUE if protocol is handled, @c EINA_FALSE otherwise. 684 * @return @c EINA_TRUE if protocol is handled, @c EINA_FALSE otherwise.
685 * 685 *
686 * This function returns @c EINA_TRUE if @p protocol is supported, 686 * This function returns @c EINA_TRUE if @p protocol is supported,
687 * @c EINA_FALSE otherwise. @p protocol can be 'http://', 'ftp://' or 687 * @c EINA_FALSE otherwise. @p protocol can be '%http://', '%ftp://' or
688 * 'file://'. Ecore_FILE must be compiled with CURL to handle http and 688 * '%file://'. Ecore_FILE must be compiled with CURL to handle http and
689 * ftp protocols. 689 * ftp protocols.
690 */ 690 */
691EAPI Eina_Bool ecore_file_download_protocol_available(const char *protocol); 691EAPI Eina_Bool ecore_file_download_protocol_available(const char *protocol);