summaryrefslogtreecommitdiff
path: root/src/lib/eina
diff options
context:
space:
mode:
authorBryce Harrington <bryce@osg.samsung.com>2018-07-27 20:20:44 -0400
committerChris Michael <cp.michael@samsung.com>2018-07-27 20:20:44 -0400
commit06e7c859c945d6329c63e772a5d70162ce19157f (patch)
treef1eb2edb8341112c9eb1c3ba5e1c707519198e98 /src/lib/eina
parentad379ce04fa3dae4ef06c5f6211bc4b962cb3fa4 (diff)
eina: Add doxygen in/out tags for log
Subscribers: cedric, #committers, zmike Tags: #efl Differential Revision: https://phab.enlightenment.org/D6690
Diffstat (limited to 'src/lib/eina')
-rw-r--r--src/lib/eina/eina_log.h142
1 files changed, 71 insertions, 71 deletions
diff --git a/src/lib/eina/eina_log.h b/src/lib/eina/eina_log.h
index 83e7cb312d..b4254fed4f 100644
--- a/src/lib/eina/eina_log.h
+++ b/src/lib/eina/eina_log.h
@@ -493,8 +493,8 @@ typedef enum _Eina_Log_State
493/** 493/**
494 * Sets logging method to use. 494 * Sets logging method to use.
495 * 495 *
496 * @param cb The callback to call when printing a log. 496 * @param[in] cb The callback to call when printing a log.
497 * @param data The data to pass to the callback. 497 * @param[in] data The data to pass to the callback.
498 * 498 *
499 * By default, eina_log_print_cb_stderr() is used. 499 * By default, eina_log_print_cb_stderr() is used.
500 * 500 *
@@ -510,7 +510,7 @@ EAPI void eina_log_print_cb_set(Eina_Log_Print_Cb cb, void *data) EINA_ARG_NONNU
510/** 510/**
511 * @brief Sets the default log level. 511 * @brief Sets the default log level.
512 * 512 *
513 * @param level The log level. 513 * @param[in] level The log level.
514 * 514 *
515 * This function sets the log level @p level. It is used in 515 * This function sets the log level @p level. It is used in
516 * eina_log_print(). 516 * eina_log_print().
@@ -533,7 +533,7 @@ EAPI int eina_log_level_get(void) EINA_WARN_UNUSED_RESULT;
533/** 533/**
534 * @brief Determines if a given @p level should be logged. 534 * @brief Determines if a given @p level should be logged.
535 * 535 *
536 * @param level The log level to check 536 * @param[in] level The log level to check
537 * 537 *
538 * @return #EINA_TRUE if the @p level should be logged, else #EINA_FALSE. 538 * @return #EINA_TRUE if the @p level should be logged, else #EINA_FALSE.
539 * 539 *
@@ -559,7 +559,7 @@ EAPI Eina_Bool eina_log_main_thread_check(void) EINA_CONST EINA_WARN_UN
559/** 559/**
560 * @brief Enables or disables colored text in the logs. 560 * @brief Enables or disables colored text in the logs.
561 * 561 *
562 * @param disabled If #EINA_TRUE, color logging should be disabled. 562 * @param[in] disabled If #EINA_TRUE, color logging should be disabled.
563 * 563 *
564 * @note this is initially set to envvar EINA_LOG_COLOR_DISABLE by eina_init(). 564 * @note this is initially set to envvar EINA_LOG_COLOR_DISABLE by eina_init().
565 * 565 *
@@ -579,7 +579,7 @@ EAPI Eina_Bool eina_log_color_disable_get(void) EINA_WARN_UNUSED_RESULT
579/** 579/**
580 * @brief Sets if originating file name logging should be disabled. 580 * @brief Sets if originating file name logging should be disabled.
581 * 581 *
582 * @param disabled If #EINA_TRUE, file name logging should be disabled. 582 * @param[in] disabled If #EINA_TRUE, file name logging should be disabled.
583 * 583 *
584 * @note this is initially set to envvar EINA_LOG_FILE_DISABLE by eina_init(). 584 * @note this is initially set to envvar EINA_LOG_FILE_DISABLE by eina_init().
585 * 585 *
@@ -599,7 +599,7 @@ EAPI Eina_Bool eina_log_file_disable_get(void) EINA_WARN_UNUSED_RESULT;
599/** 599/**
600 * @brief Sets if originating function name logging should be disabled. 600 * @brief Sets if originating function name logging should be disabled.
601 * 601 *
602 * @param disabled If #EINA_TRUE, function name logging should be disabled. 602 * @param[in] disabled If #EINA_TRUE, function name logging should be disabled.
603 * 603 *
604 * @note this is initially set to envvar EINA_LOG_FUNCTION_DISABLE by 604 * @note this is initially set to envvar EINA_LOG_FUNCTION_DISABLE by
605 * eina_init(). 605 * eina_init().
@@ -620,7 +620,7 @@ EAPI Eina_Bool eina_log_function_disable_get(void) EINA_WARN_UNUSED_RES
620/** 620/**
621 * @brief Sets if critical messages should abort the program. 621 * @brief Sets if critical messages should abort the program.
622 * 622 *
623 * @param abort_on_critical If #EINA_TRUE, messages with level equal 623 * @param[in] abort_on_critical If #EINA_TRUE, messages with level equal
624 * or smaller than eina_log_abort_on_critical_level_get() will 624 * or smaller than eina_log_abort_on_critical_level_get() will
625 * abort the program. 625 * abort the program.
626 * 626 *
@@ -647,8 +647,8 @@ EAPI Eina_Bool eina_log_abort_on_critical_get(void) EINA_WARN_UNUSED_RE
647/** 647/**
648 * @brief Sets level that triggers abort if abort-on-critical is set. 648 * @brief Sets level that triggers abort if abort-on-critical is set.
649 * 649 *
650 * @param critical_level Levels equal or smaller than the given value 650 * @param[in] critical_level Levels equal or smaller than the given
651 * will trigger program abortion if 651 * value will trigger program abortion if
652 * eina_log_abort_on_critical_get() returns #EINA_TRUE. 652 * eina_log_abort_on_critical_get() returns #EINA_TRUE.
653 * 653 *
654 * @note this is initially set to envvar EINA_LOG_ABORT_LEVEL by 654 * @note this is initially set to envvar EINA_LOG_ABORT_LEVEL by
@@ -678,18 +678,18 @@ EAPI int eina_log_abort_on_critical_level_get(void) EINA_WARN_UNU
678 * This call has the same effect as setting 678 * This call has the same effect as setting
679 * EINA_LOG_LEVELS=&lt;@p domain_name&gt;:&lt;@p level&gt; 679 * EINA_LOG_LEVELS=&lt;@p domain_name&gt;:&lt;@p level&gt;
680 * 680 *
681 * @param domain_name Domain name to change the level. It may be of a 681 * @param[in] domain_name Domain name to change the level. It may be of
682 * still not registered domain. If the domain is not registered 682 * a still not registered domain. If the domain is not registered
683 * yet, it will be saved as a pending set and applied upon 683 * yet, it will be saved as a pending set and applied upon
684 * registration. 684 * registration.
685 * @param level Level to use to limit eina_log_print() for given domain. 685 * @param[in] level Level to use to limit eina_log_print() for given domain.
686 */ 686 */
687EAPI void eina_log_domain_level_set(const char *domain_name, int level) EINA_ARG_NONNULL(1); 687EAPI void eina_log_domain_level_set(const char *domain_name, int level) EINA_ARG_NONNULL(1);
688 688
689/** 689/**
690 * @brief Gets the domain level given its name. 690 * @brief Gets the domain level given its name.
691 * 691 *
692 * @param domain_name Domain name to retrieve the level. It may be of 692 * @param[in] domain_name Domain name to retrieve the level. It may be of
693 * a still not registered domain. If the domain is not 693 * a still not registered domain. If the domain is not
694 * registered yet, but there is a pending value, either from 694 * registered yet, but there is a pending value, either from
695 * eina_log_domain_level_set(),EINA_LOG_LEVELS environment 695 * eina_log_domain_level_set(),EINA_LOG_LEVELS environment
@@ -709,7 +709,7 @@ EAPI int eina_log_domain_level_get(const char *domain_name) EINA_
709/** 709/**
710 * @brief Gets the domain level given its identifier. 710 * @brief Gets the domain level given its identifier.
711 * 711 *
712 * @param domain Identifier, so it must be previously registered with 712 * @param[in] domain Identifier, so it must be previously registered with
713 * eina_log_domain_register(). It's a much faster version of 713 * eina_log_domain_register(). It's a much faster version of
714 * eina_log_domain_level_get(), but relies on domain being 714 * eina_log_domain_level_get(), but relies on domain being
715 * present. 715 * present.
@@ -722,11 +722,11 @@ EAPI int eina_log_domain_registered_level_get(int domain) EINA_WA
722/** 722/**
723 * @brief Sets the domain level given its identifier. 723 * @brief Sets the domain level given its identifier.
724 * 724 *
725 * @param domain Identifier, so it must be previously registered with 725 * @param[in] domain Identifier, so it must be previously registered with
726 * eina_log_domain_register(). It's a much faster version of 726 * eina_log_domain_register(). It's a much faster version of
727 * eina_log_domain_level_get(), but relies on domain being 727 * eina_log_domain_level_get(), but relies on domain being
728 * present. 728 * present.
729 * @param level Level to use to limit eina_log_print() for given domain. 729 * @param[in] level Level to use to limit eina_log_print() for given domain.
730 * @since 1.10 730 * @since 1.10
731 */ 731 */
732EAPI void eina_log_domain_registered_level_set(int domain, int level); 732EAPI void eina_log_domain_registered_level_set(int domain, int level);
@@ -738,8 +738,8 @@ static inline Eina_Bool eina_log_domain_level_check(int domain, int level);
738 */ 738 */
739 739
740/** 740/**
741 * @param name Domain name 741 * @param[in] name Domain name
742 * @param color Color of the domain name 742 * @param[in] color Color of the domain name
743 * 743 *
744 * @return Domain index that will be used as the DOMAIN parameter on log 744 * @return Domain index that will be used as the DOMAIN parameter on log
745 * macros. A negative return value means an error occurred. 745 * macros. A negative return value means an error occurred.
@@ -751,7 +751,7 @@ EAPI int eina_log_domain_register(const char *name, const char *color) EINA_ARG
751/** 751/**
752 * @brief Forgets about a logging domain registered by eina_log_domain_register() 752 * @brief Forgets about a logging domain registered by eina_log_domain_register()
753 * 753 *
754 * @param domain Domain identifier as reported by eina_log_domain_register(), 754 * @param[in] domain Domain identifier as reported by eina_log_domain_register(),
755 * must be >= 0. 755 * must be >= 0.
756 * 756 *
757 * @note MT: Safe to call from any thread. 757 * @note MT: Safe to call from any thread.
@@ -769,18 +769,18 @@ EAPI void eina_log_domain_unregister(int domain);
769 * macros EINA_LOG(), EINA_LOG_DOM_CRIT(), EINA_LOG_CRIT() and 769 * macros EINA_LOG(), EINA_LOG_DOM_CRIT(), EINA_LOG_CRIT() and
770 * so on. See eina_log.h 770 * so on. See eina_log.h
771 * 771 *
772 * @param domain Logging domain to use or @c EINA_LOG_DOMAIN_GLOBAL if 772 * @param[in] domain Logging domain to use or @c EINA_LOG_DOMAIN_GLOBAL if
773 * you registered none. It is recommended that modules and 773 * you registered none. It is recommended that modules and
774 * applications have their own logging domain. 774 * applications have their own logging domain.
775 * @param level Message level, those with level greater than user 775 * @param[in] level Message level, those with level greater than user
776 * specified value (eina_log_level_set() or environment 776 * specified value (eina_log_level_set() or environment
777 * variables EINA_LOG_LEVEL, EINA_LOG_LEVELS) will be ignored. 777 * variables EINA_LOG_LEVEL, EINA_LOG_LEVELS) will be ignored.
778 * @param file Filename that originated the call, must @b not be @c NULL. 778 * @param[in] file Filename that originated the call, must @b not be @c NULL.
779 * @param function Function that originated the call, must @b not be @c NULL. 779 * @param[in] function Function that originated the call, must @b not be @c NULL.
780 * @param line Originating line in @a file. 780 * @param[in] line Originating line in @a file.
781 * @param fmt Printf-like format to use. Should not provide trailing 781 * @param[in] fmt Printf-like format to use. Should not provide trailing
782 * '\n' as it is automatically included. 782 * '\n' as it is automatically included.
783 * @param ... Variadic args. 783 * @param[in] ... Variadic args.
784 * 784 *
785 * @note MT: This function may be called from different threads if 785 * @note MT: This function may be called from different threads if
786 * eina_log_threads_enable() was called before. 786 * eina_log_threads_enable() was called before.
@@ -800,18 +800,18 @@ EAPI void eina_log_print(int domain,
800 * macros EINA_LOG(), EINA_LOG_DOM_CRIT(), EINA_LOG_CRIT() and 800 * macros EINA_LOG(), EINA_LOG_DOM_CRIT(), EINA_LOG_CRIT() and
801 * so on. See eina_log.h 801 * so on. See eina_log.h
802 * 802 *
803 * @param domain Logging domain to use or @c EINA_LOG_DOMAIN_GLOBAL if 803 * @param[in] domain Logging domain to use or @c EINA_LOG_DOMAIN_GLOBAL if
804 * you registered none. It is recommended that modules and 804 * you registered none. It is recommended that modules and
805 * applications have their own logging domain. 805 * applications have their own logging domain.
806 * @param level Message level, those with level greater than user 806 * @param[in] level Message level, those with level greater than user
807 * specified value (eina_log_level_set() or environment 807 * specified value (eina_log_level_set() or environment
808 * variables EINA_LOG_LEVEL, EINA_LOG_LEVELS) will be ignored. 808 * variables EINA_LOG_LEVEL, EINA_LOG_LEVELS) will be ignored.
809 * @param file Filename that originated the call, must @b not be @c NULL. 809 * @param[in] file Filename that originated the call, must @b not be @c NULL.
810 * @param fnc Function that originated the call, must @b not be @c NULL. 810 * @param[in] fnc Function that originated the call, must @b not be @c NULL.
811 * @param line Originating line in @a file. 811 * @param[in] line Originating line in @a file.
812 * @param fmt Printf-like format to use. Should not provide trailing 812 * @param[in] fmt Printf-like format to use. Should not provide trailing
813 * '\n' as it is automatically included. 813 * '\n' as it is automatically included.
814 * @param args The arguments needed by the format. 814 * @param[in] args The arguments needed by the format.
815 * 815 *
816 * @note MT: this function may be called from different threads if 816 * @note MT: this function may be called from different threads if
817 * eina_log_threads_enable() was called before. 817 * eina_log_threads_enable() was called before.
@@ -833,14 +833,14 @@ EAPI void eina_log_vprint(int domain,
833/** 833/**
834 * @brief Alternative logging method, this will output to standard output stream. 834 * @brief Alternative logging method, this will output to standard output stream.
835 * 835 *
836 * @param d The domain. 836 * @param[in] d The domain.
837 * @param level The level. 837 * @param[in] level The level.
838 * @param file The file which is logged. 838 * @param[in] file The file which is logged.
839 * @param fnc The function which is logged. 839 * @param[in] fnc The function which is logged.
840 * @param line The line which is logged. 840 * @param[in] line The line which is logged.
841 * @param fmt The output format to use. 841 * @param[in] fmt The output format to use.
842 * @param data Not used. 842 * @param[in] data Not used.
843 * @param args The arguments needed by the format. 843 * @param[in] args The arguments needed by the format.
844 * 844 *
845 * This method will colorize output based on domain provided color and 845 * This method will colorize output based on domain provided color and
846 * message logging level. To disable color, set environment variable 846 * message logging level. To disable color, set environment variable
@@ -868,14 +868,14 @@ EAPI void eina_log_print_cb_stdout(const Eina_Log_Domain *d,
868/** 868/**
869 * @brief Default logging method, this will output to standard error stream. 869 * @brief Default logging method, this will output to standard error stream.
870 * 870 *
871 * @param d The domain. 871 * @param[in] d The domain.
872 * @param level The level. 872 * @param[in] level The level.
873 * @param file The file which is logged. 873 * @param[in] file The file which is logged.
874 * @param fnc The function which is logged. 874 * @param[in] fnc The function which is logged.
875 * @param line The line which is logged. 875 * @param[in] line The line which is logged.
876 * @param fmt The output format to use. 876 * @param[in] fmt The output format to use.
877 * @param data Not used. 877 * @param[in] data Not used.
878 * @param args The arguments needed by the format. 878 * @param[in] args The arguments needed by the format.
879 * 879 *
880 * This method will colorize output based on domain provided color and 880 * This method will colorize output based on domain provided color and
881 * message logging level. 881 * message logging level.
@@ -910,14 +910,14 @@ EAPI void eina_log_print_cb_stderr(const Eina_Log_Domain *d,
910/** 910/**
911 * @brief Alternative logging method, this will output to given file stream. 911 * @brief Alternative logging method, this will output to given file stream.
912 * 912 *
913 * @param d The domain. 913 * @param[in] d The domain.
914 * @param level Not used. 914 * @param[in] level Not used.
915 * @param file The file which is logged. 915 * @param[in] file The file which is logged.
916 * @param fnc The function which is logged. 916 * @param[in] fnc The function which is logged.
917 * @param line The line which is logged. 917 * @param[in] line The line which is logged.
918 * @param fmt The output format to use. 918 * @param[in] fmt The output format to use.
919 * @param data The file which will store the output (as a FILE *). 919 * @param[in] data The file which will store the output (as a FILE *).
920 * @param args The arguments needed by the format. 920 * @param[in] args The arguments needed by the format.
921 * 921 *
922 * This method will never output color. 922 * This method will never output color.
923 * 923 *
@@ -938,14 +938,14 @@ EAPI void eina_log_print_cb_file(const Eina_Log_Domain *d,
938/** 938/**
939 * @brief Alternative logging method, this will output to systemd journal. 939 * @brief Alternative logging method, this will output to systemd journal.
940 * 940 *
941 * @param d The domain. 941 * @param[in] d The domain.
942 * @param level Not used. 942 * @param[in] level Not used.
943 * @param file The file which is logged. 943 * @param[in] file The file which is logged.
944 * @param fnc The function which is logged. 944 * @param[in] fnc The function which is logged.
945 * @param line The line which is logged. 945 * @param[in] line The line which is logged.
946 * @param fmt The output format to use. 946 * @param[in] fmt The output format to use.
947 * @param data The file which will store the output (as a FILE *). 947 * @param[in] data The file which will store the output (as a FILE *).
948 * @param args The arguments needed by the format. 948 * @param[in] args The arguments needed by the format.
949 * 949 *
950 * This method will never output color. 950 * This method will never output color.
951 * 951 *
@@ -966,8 +966,8 @@ EAPI void eina_log_print_cb_journald(const Eina_Log_Domain *d,
966/** 966/**
967 * @brief Configures console color of given file. 967 * @brief Configures console color of given file.
968 * 968 *
969 * @param fp File to configure console color (usually stderr or stdout). 969 * @param[in] fp File to configure console color (usually stderr or stdout).
970 * @param color A VT color code such as EINA_COLOR_RED or EINA_COLOR_RESET. 970 * @param[in] color A VT color code such as EINA_COLOR_RED or EINA_COLOR_RESET.
971 * 971 *
972 * @note If color is disabled, nothing is done. See 972 * @note If color is disabled, nothing is done. See
973 * eina_log_color_disable_get() 973 * eina_log_color_disable_get()
@@ -996,9 +996,9 @@ extern EAPI const char *_eina_log_state_shutdown;
996/** 996/**
997 * @brief Starts or stops the timing of a phase. 997 * @brief Starts or stops the timing of a phase.
998 * 998 *
999 * @param domain The domain. 999 * @param[in] domain The domain.
1000 * @param state State indicating if we are starting or stopping a phase. 1000 * @param[in] state State indicating if we are starting or stopping a phase.
1001 * @param phase The name of the phase to be used in the log. 1001 * @param[in] phase The name of the phase to be used in the log.
1002 * 1002 *
1003 * @note One domain can be in only one phase at a time. 1003 * @note One domain can be in only one phase at a time.
1004 * @note If you change the name of the phase, it is assumed that 1004 * @note If you change the name of the phase, it is assumed that