more doc fixes.

SVN revision: 66672
This commit is contained in:
Carsten Haitzler 2011-12-30 08:37:54 +00:00
parent 4f95bc60b5
commit 843fa4f911
6 changed files with 14 additions and 259 deletions

View File

@ -1,243 +0,0 @@
/**
* @file Elementary.h
* @brief Elementary Widget Library
*/
#ifndef ELEMENTARY_H
#define ELEMENTARY_H
#define ELM_UNIX
#undef ELM_WIN32
#undef ELM_WINCE
#define ELM_EDBUS
#define ELM_EFREET
#define ELM_ETHUMB
#undef ELM_WEB
#undef ELM_EMAP
#undef ELM_DEBUG
#define ELM_ALLOCA_H
#define ELM_LIBINTL_H
#define ELM_DIRENT_H
/* Standard headers for standard system calls etc. */
#include <stdio.h>
#include <stdlib.h>
#include <unistd.h>
#include <string.h>
#include <sys/types.h>
#include <sys/stat.h>
#include <sys/time.h>
#include <sys/param.h>
#include <math.h>
#include <fnmatch.h>
#include <limits.h>
#include <ctype.h>
#include <time.h>
#ifdef ELM_DIRENT_H
#include <dirent.h>
#endif
#include <pwd.h>
#include <errno.h>
#ifdef ELM_UNIX
#include <locale.h>
#ifdef ELM_LIBINTL_H
#include <libintl.h>
#endif
#include <signal.h>
#include <grp.h>
#include <glob.h>
#endif
#ifdef ELM_ALLOCA_H
#include <alloca.h>
#endif
#if defined (ELM_WIN32) || defined (ELM_WINCE)
#include <malloc.h>
#ifndef alloca
#define alloca _alloca
#endif
#endif
/* EFL headers */
#include <Eina.h>
#include <Eet.h>
#include <Evas.h>
#include <Evas_GL.h>
#include <Ecore.h>
#include <Ecore_Evas.h>
#include <Ecore_File.h>
#include <Ecore_IMF.h>
#include <Ecore_Con.h>
#include <Edje.h>
#ifdef ELM_EDBUS
#include <E_DBus.h>
#endif
#ifdef ELM_EFREET
#include <Efreet.h>
#include <Efreet_Mime.h>
#include <Efreet_Trash.h>
#endif
#ifdef ELM_ETHUMB
#include <Ethumb_Client.h>
#endif
#ifdef ELM_EMAP
#include <EMap.h>
#endif
#ifdef EAPI
#undef EAPI
#endif
#ifdef _WIN32
#ifdef ELEMENTARY_BUILD
#ifdef DLL_EXPORT
#define EAPI __declspec(dllexport)
#else
#define EAPI
#endif /* ! DLL_EXPORT */
#else
#define EAPI __declspec(dllimport)
#endif /* ! EFL_EVAS_BUILD */
#else
#ifdef __GNUC__
#if __GNUC__ >= 4
#define EAPI __attribute__ ((visibility("default")))
#else
#define EAPI
#endif
#else
#define EAPI
#endif
#endif /* ! _WIN32 */
#ifdef _WIN32
#define EAPI_MAIN
#else
#define EAPI_MAIN EAPI
#endif
/* allow usage from c++ */
#ifdef __cplusplus
extern "C"
{
#endif
/* docs */
#include <elm_intro.h>
#include <elm_getting_started.h>
#include <elm_authors.h>
#define ELM_VERSION_MAJOR 0
#define ELM_VERSION_MINOR 8
typedef struct _Elm_Version
{
int major;
int minor;
int micro;
int revision;
} Elm_Version;
EAPI extern Elm_Version * elm_version;
/* include these first for general used definitions */
#include <elm_general.h>
#include <elm_object_item.h>
#include <elm_tooltip.h>
/* special widgets - types used elsewhere */
#include <elm_icon.h>
#include <elm_scroller.h>
#include <elm_entry.h>
#include <elm_list.h>
/* other includes */
#include <elc_anchorblock.h>
#include <elc_anchorview.h>
#include <elc_ctxpopup.h>
#include <elc_fileselector_button.h>
#include <elc_fileselector_entry.h>
#include <elc_fileselector.h>
#include <elc_hoversel.h>
#include <elc_multibuttonentry.h>
#include <elc_naviframe.h>
#include <elm_actionslider.h>
#include <elm_app.h>
#include <elm_bg.h>
#include <elm_box.h>
#include <elm_bubble.h>
#include <elm_button.h>
#include <elm_cache.h>
#include <elm_calendar.h>
#include <elm_check.h>
#include <elm_clock.h>
#include <elm_cnp.h>
#include <elm_colorselector.h>
#include <elm_config.h>
#include <elm_conform.h>
#include <elm_cursor.h>
#include <elm_debug.h>
#include <elm_deprecated.h>
#include <elm_diskselector.h>
#include <elm_engine.h>
#include <elm_factory.h>
#include <elm_finger.h>
#include <elm_flip.h>
#include <elm_flipselector.h>
#include <elm_focus.h>
#include <elm_fonts.h>
#include <elm_frame.h>
#include <elm_gengrid.h>
#include <elm_genlist.h>
#include <elm_gesture_layer.h>
#include <elm_glview.h>
#include <elm_grid.h>
#include <elm_hover.h>
#include <elm_image.h>
#include <elm_index.h>
#include <elm_label.h>
#include <elm_layout.h>
#include <elm_macros.h>
#include <elm_mapbuf.h>
#include <elm_map.h>
#include <elm_menu.h>
#include <elm_mirroring.h>
#include <elm_need.h>
#include <elm_notify.h>
#include <elm_object.h>
#include <elm_pager.h>
#include <elm_panel.h>
#include <elm_panes.h>
#include <elm_password.h>
#include <elm_photocam.h>
#include <elm_photo.h>
#include <elm_progressbar.h>
#include <elm_radio.h>
#include <elm_route.h>
#include <elm_scale.h>
#include <elm_scroll.h>
#include <elm_segment_control.h>
#include <elm_separator.h>
#include <elm_slider.h>
#include <elm_slideshow.h>
#include <elm_spinner.h>
#include <elm_store.h>
#include <elm_table.h>
#include <elm_theme.h>
#include <elm_thumb.h>
#include <elm_toolbar.h>
#include <elm_transit.h>
#include <elm_video.h>
#include <elm_web.h>
#include <elm_win.h>
#ifdef __cplusplus
}
#endif
#endif

View File

@ -91,8 +91,8 @@ EAPI Eina_Bool elm_object_focus_get(const Evas_Object *obj) EINA_ARG_
* Set/unset focus to a given Elementary object.
*
* @param obj The Elementary object to operate on.
* @param enable @c EINA_TRUE Set focus to a given object,
* @c EINA_FALSE Unset focus to a given object.
* @param focus @c EINA_TRUE Set focus to a given object,
* @c EINA_FALSE Unset focus to a given object.
*
* @note When you set focus to this object, if it can handle focus, will
* take the focus away from the one who had it previously and will, for

View File

@ -158,7 +158,7 @@ EAPI const char *elm_font_fontconfig_name_get(const char *name, const char
/**
* Free the font string return by elm_font_fontconfig_name_get().
*
* @param efp the font properties struct
* @param name the font properties struct
*
* @ingroup Fonts
*/

View File

@ -24,7 +24,7 @@
* @note whenever extending with new values, try to keep some padding
* to siblings so there is room for further extensions.
*/
typedef enum _Elm_Object_Layer
typedef enum
{
ELM_OBJECT_LAYER_BACKGROUND = EVAS_LAYER_MIN + 64, /**< where to place backgrounds */
ELM_OBJECT_LAYER_DEFAULT = 0, /**< Evas_Object default layer (and thus for Elementary) */
@ -70,7 +70,7 @@ struct _Elm_Event_Policy_Changed
/**
* Policy identifiers.
*/
typedef enum _Elm_Policy
typedef enum
{
ELM_POLICY_QUIT, /**< under which circumstances the application
* should quit automatically. @see
@ -79,7 +79,7 @@ typedef enum _Elm_Policy
ELM_POLICY_LAST
} Elm_Policy; /**< Elementary policy identifiers/groups enumeration. @see elm_policy_set() */
typedef enum _Elm_Policy_Quit
typedef enum
{
ELM_POLICY_QUIT_NONE = 0, /**< never quit the application
* automatically */
@ -88,7 +88,7 @@ typedef enum _Elm_Policy_Quit
* window is closed */
} Elm_Policy_Quit; /**< Possible values for the #ELM_POLICY_QUIT policy */
typedef enum _Elm_Focus_Direction
typedef enum
{
ELM_FOCUS_PREVIOUS,
ELM_FOCUS_NEXT

View File

@ -86,7 +86,7 @@ EAPI void elm_object_part_content_set(Evas_Object *obj,
* Get a content of an object
*
* @param obj The Elementary object
* @param item The content part name to get (NULL for the default content)
* @param part The content part name to get (NULL for the default content)
* @return content of the object or NULL for any error
*
* @note Elementary objects may have many contents
@ -99,7 +99,7 @@ EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_get(const Evas_Object
* Get a content of an object
*
* @param obj The Elementary object
* @param item The content part name to get (NULL for the default content)
* @param part The content part name to get (NULL for the default content)
* @return content of the object or NULL for any error
*
* @note Elementary objects may have many contents
@ -114,7 +114,7 @@ EAPI Evas_Object *elm_object_part_content_get(const Evas_Object
* Unset a content of an object
*
* @param obj The Elementary object
* @param item The content part name to unset (NULL for the default content)
* @param part The content part name to unset (NULL for the default content)
*
* @note Elementary objects may have many contents
* @deprecated Use elm_object_part_content_unset instead.
@ -126,7 +126,7 @@ EINA_DEPRECATED EAPI Evas_Object *elm_object_content_part_unset(Evas_Object *obj
* Unset a content of an object
*
* @param obj The Elementary object
* @param item The content part name to unset (NULL for the default content)
* @param part The content part name to unset (NULL for the default content)
*
* @note Elementary objects may have many contents
*
@ -391,7 +391,7 @@ EAPI void *elm_object_signal_callback_del(Evas_Object *obj, const char *e
* propagation, too.
*
* @note Your event callback will be issued on those events taking
* place only if no other child widget of @obj has consumed the
* place only if no other child widget of @p obj has consumed the
* event already.
*
* @note Not to be confused with @c

View File

@ -1,16 +1,14 @@
/**
* Get the widget object's handle which contains a given item
*
* @param item The Elementary object item
* @param it The Elementary object item
* @return The widget object
*
* @note This returns the widget object itself that an item belongs to.
*
* @ingroup General
*/
EAPI Evas_Object *
elm_object_item_object_get(const Elm_Object_Item *it)
EINA_ARG_NONNULL(1);
EAPI Evas_Object *elm_object_item_object_get(const Elm_Object_Item *it) EINA_ARG_NONNULL(1);
/**
* Set a content of an object item