forked from enlightenment/efl
Fix documentation
* update Doxyfile file * fix end of groups * fix some warnings * fix link in head.html for Edje API ref SVN revision: 42794
This commit is contained in:
parent
ea4efcb441
commit
e4bea597c7
File diff suppressed because it is too large
Load Diff
|
@ -11,8 +11,6 @@ doc-clean:
|
|||
rm -rf html/ latex/ man/ xml/ $(PACKAGE_DOCNAME).tar*
|
||||
|
||||
doc: all doc-clean
|
||||
cat ../src/lib/Edje.h >> ./edje.dox
|
||||
cat `find ../src/lib -name "*.c" -fprint /dev/stdout | grep -v edje_edit.c` >> edje.dox
|
||||
$(efl_doxygen)
|
||||
cp img/* html/
|
||||
rm -rf $(PACKAGE_DOCNAME).tar*
|
||||
|
|
|
@ -51,7 +51,7 @@
|
|||
<div class="submenu">
|
||||
<ul class="current">
|
||||
<li><a href="files.html">Files</a></li>
|
||||
<li><a href="edje_8dox.html">Edje API</a></li>
|
||||
<li><a href="edje_8h.html">Edje API</a></li>
|
||||
<li><a href="Edje__Edit_8h.html">Edje Edit API</a></li>
|
||||
<li><a href="edcref.html">EDC Reference</a></li>
|
||||
<li class="current"><a href="index.html">Main Page</a></li>
|
||||
|
|
|
@ -28,6 +28,15 @@
|
|||
\@endproperty
|
||||
*/
|
||||
|
||||
#include <string.h>
|
||||
#include <errno.h>
|
||||
#include <sys/stat.h>
|
||||
#include <fcntl.h>
|
||||
#include <sys/mman.h>
|
||||
#include <unistd.h>
|
||||
|
||||
#include "edje_cc.h"
|
||||
|
||||
/**
|
||||
* @page edcref Edje Data Collection reference
|
||||
* An Edje Data Collection, it's a plain text file (normally identified with the
|
||||
|
@ -41,15 +50,6 @@
|
|||
* <table class="edcref" border="0">
|
||||
*/
|
||||
|
||||
#include <string.h>
|
||||
#include <errno.h>
|
||||
#include <sys/stat.h>
|
||||
#include <fcntl.h>
|
||||
#include <sys/mman.h>
|
||||
#include <unistd.h>
|
||||
|
||||
#include "edje_cc.h"
|
||||
|
||||
static void st_images_image(void);
|
||||
|
||||
static void st_fonts_font(void);
|
||||
|
|
|
@ -29,6 +29,14 @@
|
|||
# endif
|
||||
#endif
|
||||
|
||||
/**
|
||||
* @file Edje.h
|
||||
* @brief Edje Graphical Design Library
|
||||
*
|
||||
* These routines are used for Edje.
|
||||
*/
|
||||
|
||||
|
||||
/* FIXDOC: Define these? */
|
||||
enum _Edje_Message_Type
|
||||
{
|
||||
|
|
|
@ -1612,7 +1612,7 @@ edje_edit_state_image_set(
|
|||
EAPI int ///< The ID of the givan image name
|
||||
edje_edit_image_id_get(
|
||||
Evas_Object *obj, ///< The edje object
|
||||
const char *image_name
|
||||
const char *image_name ///< The image name
|
||||
);
|
||||
|
||||
/**Get compression type for the given image.*/
|
||||
|
|
|
@ -25,9 +25,6 @@
|
|||
# include <config.h>
|
||||
#endif
|
||||
|
||||
#include <string.h>
|
||||
#include <sys/stat.h>
|
||||
|
||||
#ifdef HAVE_ALLOCA_H
|
||||
# include <alloca.h>
|
||||
#elif defined __GNUC__
|
||||
|
@ -45,8 +42,16 @@ extern "C"
|
|||
void *alloca (size_t);
|
||||
#endif
|
||||
|
||||
#include <string.h>
|
||||
#include <sys/stat.h>
|
||||
|
||||
#include "edje_private.h"
|
||||
|
||||
|
||||
/**
|
||||
* @cond
|
||||
*/
|
||||
|
||||
static Eina_Hash *_edje_file_hash = NULL;
|
||||
static int _edje_file_cache_size = 16;
|
||||
static Eina_List *_edje_file_cache = NULL;
|
||||
|
@ -476,8 +481,6 @@ _edje_file_cache_shutdown(void)
|
|||
* application code and the interface, while allowing extremely
|
||||
* flexible dynamic layouts and animations.
|
||||
*
|
||||
* For more information, you can look at the @ref tutorial_list_page.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@ -620,3 +623,8 @@ edje_collection_cache_flush(void)
|
|||
/* FIXME: freach in file hash too! */
|
||||
_edje_collection_cache_size = ps;
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
|
|
|
@ -22,8 +22,6 @@ Eina_Mempool *_edje_real_part_state_mp = NULL;
|
|||
* application code and the interface, while allowing extremely
|
||||
* flexible dynamic layouts and animations.
|
||||
*
|
||||
* For more information, you can look at the @ref tutorial_list_page.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@ -253,3 +251,8 @@ _edje_unref(Edje *ed)
|
|||
ed->references--;
|
||||
if (ed->references == 0) _edje_del(ed);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
|
|
|
@ -23,8 +23,6 @@ static Eina_List *tmp_msgq = NULL;
|
|||
* application code and the interface, while allowing extremely
|
||||
* flexible dynamic layouts and animations.
|
||||
*
|
||||
* For more information, you can look at the @ref tutorial_list_page.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@ -776,3 +774,8 @@ _edje_message_del(Edje *ed)
|
|||
if (ed->message.num <= 0) return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
|
|
|
@ -25,8 +25,6 @@ Eina_List *_edje_animators = NULL;
|
|||
* application code and the interface, while allowing extremely
|
||||
* flexible dynamic layouts and animations.
|
||||
*
|
||||
* For more information, you can look at the @ref tutorial_list_page.
|
||||
*
|
||||
* @{
|
||||
*/
|
||||
|
||||
|
@ -1232,3 +1230,8 @@ _edje_emit_cb(Edje *ed, const char *sig, const char *src)
|
|||
_edje_thaw(ed);
|
||||
_edje_unref(ed);
|
||||
}
|
||||
|
||||
/**
|
||||
*
|
||||
* @}
|
||||
*/
|
||||
|
|
|
@ -135,7 +135,9 @@ edje_thaw(void)
|
|||
/**
|
||||
* @brief Set the edje append fontset.
|
||||
*
|
||||
* This function set the edje append fontset.
|
||||
* @param fonts The fontset to append.
|
||||
*
|
||||
* This function sets the edje append fontset.
|
||||
*
|
||||
*/
|
||||
EAPI void
|
||||
|
@ -166,7 +168,7 @@ edje_fontset_append_get(void)
|
|||
/**
|
||||
* @brief Set edje's global scaling factor.
|
||||
*
|
||||
* @param The edje (global) scale factor. The defaul is 1.0.
|
||||
* @param scale The edje (global) scale factor. The defaul is 1.0.
|
||||
*
|
||||
* Edje allows one to build scalable interfaces. Scale factors, which
|
||||
* are set to neutral values by default (no scaling, actual sizes),
|
||||
|
@ -215,8 +217,8 @@ edje_scale_get(void)
|
|||
/**
|
||||
* @brief Set the edje object's scaling factor.
|
||||
*
|
||||
* @param The edje object's reference.
|
||||
* @param The edje object scale factor. The defaul is 1.0.
|
||||
* @param obj The edje object's reference.
|
||||
* @param scale The edje object scale factor. The defaul is 1.0.
|
||||
*
|
||||
* This function sets the individual scale factor of the @a obj edje
|
||||
* object. This property (or edje's global scale factor, when
|
||||
|
@ -243,7 +245,7 @@ edje_object_scale_set(Evas_Object *obj, double scale)
|
|||
/**
|
||||
* @brief Get the edje object's scaling factor.
|
||||
*
|
||||
* @param The edje object's reference.
|
||||
* @param obj The edje object's reference.
|
||||
*
|
||||
* This function returns the individual scale factor of the @a obj
|
||||
* edje object, which can be set by edje_object_scale_set().
|
||||
|
@ -792,6 +794,7 @@ edje_object_color_class_get(const Evas_Object *obj, const char *color_class, int
|
|||
/**
|
||||
* @brief Delete the object color class.
|
||||
*
|
||||
* @param obj The edje object's reference.
|
||||
* @param color_class The color class to be deleted.
|
||||
*
|
||||
* This function deletes any values at the object level for the
|
||||
|
@ -1443,7 +1446,7 @@ _edje_text_unescape(const char *text)
|
|||
*
|
||||
* @param obj A valid Evas Object handle
|
||||
* @param part The part name
|
||||
* @param text The text string
|
||||
* @param text_to_escape The text string
|
||||
*
|
||||
* This funciton will do escape for you if it is a TEXTBLOCK part,
|
||||
* that is, if text contain tags, these tags will not be
|
||||
|
@ -1715,11 +1718,12 @@ edje_object_part_text_cursor_geometry_get(const Evas_Object *obj, const char *pa
|
|||
}
|
||||
|
||||
/**
|
||||
* @brief Enables selection if the entyr is an EXPLICIT selection mode
|
||||
* @brief Enables selection if the entry is an EXPLICIT selection mode
|
||||
* type.
|
||||
*
|
||||
* @param obj A valid Evas_Object handle
|
||||
* @param part The part name
|
||||
* @param allow EINA_TRUE to enable, EINA_FALSE otherwise
|
||||
*/
|
||||
EAPI void
|
||||
edje_object_part_text_select_allow_set(const Evas_Object *obj, const char *part, Eina_Bool allow)
|
||||
|
@ -2938,7 +2942,7 @@ edje_object_part_box_append(Evas_Object *obj, const char *part, Evas_Object *chi
|
|||
}
|
||||
|
||||
/**
|
||||
* @briefPrepends an object to the box.
|
||||
* @brief Prepends an object to the box.
|
||||
*
|
||||
* @param obj A valid Evas_Object handle
|
||||
* @param part The part name
|
||||
|
@ -3294,7 +3298,7 @@ _edje_table_child_remove(Edje_Real_Part *rp, Evas_Object *child)
|
|||
*
|
||||
* @param obj A valid Evas_Object handle
|
||||
* @param part The part name
|
||||
* @param child The object to pack in
|
||||
* @param child_obj The object to pack in
|
||||
* @param col The column to place it in
|
||||
* @param row The row to place it in
|
||||
* @param colspan Columns the child will take
|
||||
|
@ -3326,7 +3330,7 @@ edje_object_part_table_pack(Evas_Object *obj, const char *part, Evas_Object *chi
|
|||
*
|
||||
* @param obj A valid Evas_Object handle
|
||||
* @param part The part name
|
||||
* @param child The object to pack in
|
||||
* @param child_obj The object to pack in
|
||||
*
|
||||
* @return 1: Successfully removed.\n
|
||||
* 0: An error occured.
|
||||
|
|
Loading…
Reference in New Issue