summaryrefslogtreecommitdiff
path: root/legacy
diff options
context:
space:
mode:
authorSanjeev BA <iamsanjeev@gmail.com>2011-10-22 02:21:16 +0000
committerSanjeev BA <iamsanjeev@gmail.com>2011-10-22 02:21:16 +0000
commit5ea99dc87f0b16d0b387db978b015e082b4f11b9 (patch)
tree620e9cb7e1ba9515def145cfd8e87e29074dfbb2 /legacy
parent4153b4aa9d000ba49bbbdfdf20edf029215dd07f (diff)
Minor documentation enhancements for elementary.
SVN revision: 64286
Diffstat (limited to 'legacy')
-rw-r--r--legacy/elementary/src/lib/Elementary.h.in20
1 files changed, 10 insertions, 10 deletions
diff --git a/legacy/elementary/src/lib/Elementary.h.in b/legacy/elementary/src/lib/Elementary.h.in
index c51e8221bb..abf3b5b274 100644
--- a/legacy/elementary/src/lib/Elementary.h.in
+++ b/legacy/elementary/src/lib/Elementary.h.in
@@ -749,7 +749,7 @@ extern "C" {
749 * shared data directory for data files. For example, if the system 749 * shared data directory for data files. For example, if the system
750 * directory is @c /usr/local/share, then this directory name is 750 * directory is @c /usr/local/share, then this directory name is
751 * appended, creating @c /usr/local/share/myapp, if it @p was @c 751 * appended, creating @c /usr/local/share/myapp, if it @p was @c
752 * "myapp". It is expected the application installs data files in 752 * "myapp". It is expected that the application installs data files in
753 * this directory. 753 * this directory.
754 * 754 *
755 * The @p checkfile is a file name or path of something inside the 755 * The @p checkfile is a file name or path of something inside the
@@ -773,7 +773,7 @@ extern "C" {
773 773
774 /** 774 /**
775 * Provide information on the @b fallback application's binaries 775 * Provide information on the @b fallback application's binaries
776 * directory, on scenarios where they get overriden by 776 * directory, in scenarios where they get overriden by
777 * elm_app_info_set(). 777 * elm_app_info_set().
778 * 778 *
779 * @param dir The path to the default binaries directory (compile time 779 * @param dir The path to the default binaries directory (compile time
@@ -843,7 +843,7 @@ extern "C" {
843 * elm_app_info_set() and the way (environment) the application was 843 * elm_app_info_set() and the way (environment) the application was
844 * run from. 844 * run from.
845 * 845 *
846 * @return The directory prefix the application is actually using 846 * @return The directory prefix the application is actually using.
847 */ 847 */
848 EAPI const char *elm_app_prefix_dir_get(void); 848 EAPI const char *elm_app_prefix_dir_get(void);
849 849
@@ -853,7 +853,7 @@ extern "C" {
853 * was run from. 853 * was run from.
854 * 854 *
855 * @return The binaries directory prefix the application is actually 855 * @return The binaries directory prefix the application is actually
856 * using 856 * using.
857 */ 857 */
858 EAPI const char *elm_app_bin_dir_get(void); 858 EAPI const char *elm_app_bin_dir_get(void);
859 859
@@ -863,7 +863,7 @@ extern "C" {
863 * was run from. 863 * was run from.
864 * 864 *
865 * @return The libraries directory prefix the application is actually 865 * @return The libraries directory prefix the application is actually
866 * using 866 * using.
867 */ 867 */
868 EAPI const char *elm_app_lib_dir_get(void); 868 EAPI const char *elm_app_lib_dir_get(void);
869 869
@@ -873,7 +873,7 @@ extern "C" {
873 * was run from. 873 * was run from.
874 * 874 *
875 * @return The data directory prefix the application is actually 875 * @return The data directory prefix the application is actually
876 * using 876 * using.
877 */ 877 */
878 EAPI const char *elm_app_data_dir_get(void); 878 EAPI const char *elm_app_data_dir_get(void);
879 879
@@ -883,7 +883,7 @@ extern "C" {
883 * was run from. 883 * was run from.
884 * 884 *
885 * @return The locale directory prefix the application is actually 885 * @return The locale directory prefix the application is actually
886 * using 886 * using.
887 */ 887 */
888 EAPI const char *elm_app_locale_dir_get(void); 888 EAPI const char *elm_app_locale_dir_get(void);
889 889
@@ -904,7 +904,7 @@ extern "C" {
904 EAPI Eina_Bool elm_need_e_dbus(void); 904 EAPI Eina_Bool elm_need_e_dbus(void);
905 905
906 /** 906 /**
907 * This must be called before any other function that handle with 907 * This must be called before any other function that deals with
908 * elm_thumb objects or ethumb_client instances. 908 * elm_thumb objects or ethumb_client instances.
909 * 909 *
910 * @ingroup Thumb 910 * @ingroup Thumb
@@ -912,7 +912,7 @@ extern "C" {
912 EAPI Eina_Bool elm_need_ethumb(void); 912 EAPI Eina_Bool elm_need_ethumb(void);
913 913
914 /** 914 /**
915 * This must be called before any other function that handle with 915 * This must be called before any other function that deals with
916 * elm_web objects or ewk_view instances. 916 * elm_web objects or ewk_view instances.
917 * 917 *
918 * @ingroup Web 918 * @ingroup Web
@@ -942,7 +942,7 @@ extern "C" {
942 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value); 942 EAPI Eina_Bool elm_policy_set(unsigned int policy, int value);
943 943
944 /** 944 /**
945 * Gets the policy value set for given policy identifier. 945 * Gets the policy value for given policy identifier.
946 * 946 *
947 * @param policy policy identifier, as in #Elm_Policy. 947 * @param policy policy identifier, as in #Elm_Policy.
948 * @return The currently set policy value, for that 948 * @return The currently set policy value, for that