Edje : Small fixes for edje doxygen doc

Patch by Jérôme Pinot

git-svn-id: http://svn.enlightenment.org/svn/e/trunk/edje@69815 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in
index 927413d..5cd36f2 100644 (file)
--- a/doc/Doxyfile.in
+++ b/doc/Doxyfile.in
@@ -586,7 +586,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = @srcdir@/edje.dox @srcdir@/examples.dox @top_srcdir@/src/bin/edje_cc_handlers.c @top_srcdir@/src/lib
+INPUT                  = @srcdir@/examples.dox @top_srcdir@/src/bin/edje_cc_handlers.c @top_srcdir@/src/lib
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

diff --git a/doc/examples.dox b/doc/examples.dox
index 867d956..e4ff5e1 100644 (file)
--- a/doc/examples.dox
+++ b/doc/examples.dox
@@ -700,7 +700,7 @@
  * @until }
  * @until }
  *
- * The @c #define's on the beginning will serve as message
+ * The @c \#define's on the beginning will serve as message
  * identifiers, for our accorded message interface between the code
  * and the this theme file.
  *
@@ -978,5 +978,5 @@
  *
  * The full source code follows:
  * @include edje-multisense.c
- * @include sound.edc
+ * @include multisense.edc
  */

diff --git a/src/bin/edje_cc_handlers.c b/src/bin/edje_cc_handlers.c
index 14ac0b7..7cebdf3 100644 (file)
--- a/src/bin/edje_cc_handlers.c
+++ b/src/bin/edje_cc_handlers.c
@@ -2757,7 +2757,7 @@ st_collections_group_orientation(void)
         This block is used to trigger some signal when the Edje object is resized.
     @endblock
 
-    @edcref
+    @page edcref
     @property
         vertical
     @parameters

diff --git a/src/lib/Edje.h b/src/lib/Edje.h
index e04931f..ba3ab96 100644 (file)
--- a/src/lib/Edje.h
+++ b/src/lib/Edje.h
@@ -1119,7 +1119,7 @@ EAPI double       edje_object_scale_get           (const Evas_Object *obj);
  * @brief Set the RTL orientation for this object.
  *
  * @param obj A handle to an Edje object.
- * @rtl new value of flag EINA_TRUE/EINA_FALSE
+ * @param rtl new value of flag EINA_TRUE/EINA_FALSE
  * @since 1.1.0
  */
 EAPI void         edje_object_mirrored_set        (Evas_Object *obj, Eina_Bool rtl);
@@ -2142,7 +2142,6 @@ EAPI void         edje_object_size_min_calc           (Evas_Object *obj, Evas_Co
  * object's area, <b>occupied by all parts in the object</b>
  *
  * @param obj A handle to an Edje object
- * @param part The Edje part's name
  * @param x A pointer to a variable where to store the parts region's
  * x coordinate
  * @param y A pointer to a variable where to store the parts region's
@@ -2517,6 +2516,7 @@ EAPI void             edje_object_part_text_cursor_geometry_get     (const Evas_
  *
  * @param obj A valid Evas_Object handle
  * @param part The part name
+ * @param text The text string
  * @since 1.2.0
  */
 EAPI void             edje_object_part_text_user_insert        (const Evas_Object *obj, const char *part, const char *text);
@@ -2623,7 +2623,7 @@ EAPI void             edje_object_part_text_cursor_end_set              (Evas_Ob
  *
  * @param obj A valid Evas_Object handle
  * @param part The part name
- * @param sry the cursor to copy from
+ * @param src the cursor to copy from
  * @param dst the cursor to copy to
  */
 EAPI void             edje_object_part_text_cursor_copy                 (Evas_Object *obj, const char *part, Edje_Cursor src, Edje_Cursor dst);
@@ -2675,7 +2675,7 @@ EAPI Eina_Bool        edje_object_part_text_cursor_is_format_get        (const E
 
 /**
  * @brief Return true if the cursor points to a visible format
- * For example \t, \n, item and etc.
+ * For example \\t, \\n, item and etc.
  * @see  evas_textblock_cursor_format_is_visible_get
  *
  * @param obj A valid Evas_Object handle
@@ -4014,7 +4014,7 @@ EAPI const Edje_External_Param_Info *edje_external_param_info_get   (const char
     * results are undefined) and the "z0" z value. This allows for some "depth"
     * control and @p foc must be greater than 0.
     *
-    * @param m map to change.
+    * @param ps The perspective object
     * @param px The perspective distance X coordinate
     * @param py The perspective distance Y coordinate
     * @param z0 The "0" z plane value

diff --git a/src/lib/edje_cache.c b/src/lib/edje_cache.c
index 02d16b5..477e6ec 100644 (file)
--- a/src/lib/edje_cache.c
+++ b/src/lib/edje_cache.c
@@ -1,10 +1,6 @@
 #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;
@@ -488,11 +484,6 @@ _edje_file_cache_shutdown(void)
 }
 
 
-
-/**
- * @endcond
- */
-
 /*============================================================================*
  *                                 Global                                     *
  *============================================================================*/