elm_app.h: added elm_app into doxygen entry.

This commit is contained in:
Daniel Juyung Seo 2013-03-16 22:16:09 +09:00
parent 1bfede5163
commit 5a74e5a072
1 changed files with 26 additions and 0 deletions

View File

@ -1,4 +1,6 @@
/**
* @defgroup App App
* @ingroup Elementary
* Provide information in order to make Elementary determine the @b
* run time location of the software in question, so other data files
* such as images, sound files, executable utilities, libraries,
@ -73,6 +75,8 @@
* @see elm_app_lib_dir_get()
* @see elm_app_data_dir_get()
* @see elm_app_locale_dir_get()
*
* @ingroup App
*/
EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *checkfile);
@ -81,6 +85,7 @@ EAPI void elm_app_info_set(void *mainfunc, const char *dom, const char *c
*
* @param name Application name.
*
* @ingroup App
* @since 1.8
*/
EAPI void elm_app_name_set(const char *name);
@ -94,6 +99,7 @@ EAPI void elm_app_name_set(const char *name);
* @warning Since this path is very environment dependent,
* this will hold whatever value is passed to it.
*
* @ingroup App
* @since 1.8
*/
EAPI void elm_app_desktop_entry_set(const char *path);
@ -113,6 +119,8 @@ EAPI void elm_app_desktop_entry_set(const char *path);
*
* @warning You should call this function @b before
* elm_app_info_set().
*
* @ingroup App
*/
EAPI void elm_app_compile_bin_dir_set(const char *dir);
@ -131,6 +139,8 @@ EAPI void elm_app_compile_bin_dir_set(const char *dir);
*
* @warning You should call this function @b before
* elm_app_info_set().
*
* @ingroup App
*/
EAPI void elm_app_compile_lib_dir_set(const char *dir);
@ -149,6 +159,8 @@ EAPI void elm_app_compile_lib_dir_set(const char *dir);
*
* @warning You should call this function @b before
* elm_app_info_set().
*
* @ingroup App
*/
EAPI void elm_app_compile_data_dir_set(const char *dir);
@ -162,6 +174,8 @@ EAPI void elm_app_compile_data_dir_set(const char *dir);
*
* @warning You should call this function @b before
* elm_app_info_set().
*
* @ingroup App
*/
EAPI void elm_app_compile_locale_set(const char *dir);
@ -170,6 +184,7 @@ EAPI void elm_app_compile_locale_set(const char *dir);
*
* @return The application formal name.
*
* @ingroup App
* @since 1.8
*/
EAPI const char *elm_app_name_get(void);
@ -180,6 +195,7 @@ EAPI const char *elm_app_name_get(void);
*
* @return The '.desktop' file path.
*
* @ingroup App
* @since 1.8
*/
EAPI const char *elm_app_desktop_entry_get(void);
@ -190,6 +206,8 @@ EAPI const char *elm_app_desktop_entry_get(void);
* run from.
*
* @return The directory prefix the application is actually using.
*
* @ingroup App
*/
EAPI const char *elm_app_prefix_dir_get(void);
@ -200,6 +218,8 @@ EAPI const char *elm_app_prefix_dir_get(void);
*
* @return The binaries directory prefix the application is actually
* using.
*
* @ingroup App
*/
EAPI const char *elm_app_bin_dir_get(void);
@ -210,6 +230,8 @@ EAPI const char *elm_app_bin_dir_get(void);
*
* @return The libraries directory prefix the application is actually
* using.
*
* @ingroup App
*/
EAPI const char *elm_app_lib_dir_get(void);
@ -220,6 +242,8 @@ EAPI const char *elm_app_lib_dir_get(void);
*
* @return The data directory prefix the application is actually
* using.
*
* @ingroup App
*/
EAPI const char *elm_app_data_dir_get(void);
@ -230,5 +254,7 @@ EAPI const char *elm_app_data_dir_get(void);
*
* @return The locale directory prefix the application is actually
* using.
*
* @ingroup App
*/
EAPI const char *elm_app_locale_dir_get(void);