Hi,

Here is a patch that fix several links in the eina doxygen doc. Most of
the problems come from unescaped special characters.

Following is the build log diff. Patch is attached.


--- /tmp/eina.log       2012-03-29 14:43:55.741564765 +0900
+++ /tmp/eina2.log      2012-03-29 17:16:02.521686541 +0900
@@ -941,11 +946,7 @@
 Parsing code for file eina_private.h...
 Parsing code for file eina_quadtree.c...
 Parsing code for file eina_quadtree.h...
-Parsing code /tmp/eina/src/include/eina_inarray.h:132: warning: unable to 
resolve reference to `eina_inarray_example_01:' for \ref command
-/tmp/eina/src/include/eina_tiler.h:31: warning: Unsupported xml/html tag 
<width> found
-/tmp/eina/src/include/eina_tiler.h:31: warning: Unsupported xml/html tag <x> 
found
-/tmp/eina/src/include/eina_tiler.h:31: warning: Unsupported xml/html tag <y> 
found
-for file eina_rbtree.c...
+Parsing code for file eina_rbtree.c...
 Parsing code for file eina_rbtree.h...
 Parsing code for file eina_rectangle.c...
 Parsing code for file eina_rectangle.h...
@@ -1034,8 +1035,7 @@
 Generating docs for page eina_stringshare_example_01...
 Generating docs for page eina_tiler_example_01...
 Generating docs for page eina_value_example_01_page...
-Generating docs for page eina_value_/tmp/eina/src/include/eina_value.h:212: 
warning: unable to resolve reference to `https:' for \ref command
-/tmp/eina/src/include/eina_xattr.h:42: warning: Member Eina_Xattr (typedef) of 
group Eina_Tools_Group is not documented.
+Generating docs for page eina_value_/tmp/eina/src/include/eina_xattr.h:42: 
warning: Member Eina_Xattr (typedef) of group Eina_Tools_Group is not 
documented.
 /tmp/eina/src/include/eina_clist.h:315: warning: Member 
EINA_CLIST_FOR_EACH_SAFE(cursor, cursor2, list) (define) of group 
Eina_CList_Group is not documented.
 /tmp/eina/src/include/eina_clist.h:321: warning: Member 
EINA_CLIST_FOR_EACH_ENTRY(elem, list, type, field) (define) of group 
Eina_CList_Group is not documented.
 /tmp/eina/src/include/eina_clist.h:329: warning: Member 
EINA_CLIST_FOR_EACH_ENTRY_SAFE(cursor, cursor2, list, type, field) (define) of 
group Eina_CList_Group is not documented.
@@ -1045,7 +1045,6 @@
 /tmp/eina/src/include/eina_clist.h:353: warning: Member 
EINA_CLIST_FOR_EACH_ENTRY_SAFE_REV(cursor, cursor2, list, type, field) (define) 
of group Eina_CList_Group is not documented.
 /tmp/eina/src/include/eina_clist.h:357: warning: Member EINA_CLIST_INIT(list) 
(define) of group Eina_CList_Group is not documented.
 /tmp/eina/src/include/eina_clist.h:362: warning: Member EINA_CLIST_ENTRY(elem, 
type, field) (define) of group Eina_CList_Group is not documented.
-/tmp/eina/src/include/eina_clist.h:39: warning: unable to resolve reference to 
`Eina_Inlist:' for \ref command
 <EINA_CLIST_FOR_EACH_SAFE>:1: warning: parameters of member 
EINA_CLIST_FOR_EACH_SAFE are not (all) documented
 <EINA_CLIST_FOR_EACH_ENTRY>:1: warning: parameters of member 
EINA_CLIST_FOR_EACH_ENTRY are not (all) documented
 <EINA_CLIST_FOR_EACH_ENTRY_SAFE>:1: warning: parameters of member 
EINA_CLIST_FOR_EACH_ENTRY_SAFE are not (all) documented
@@ -1209,9 +1208,6 @@
 /tmp/eina/src/include/eina_simple_xml_parser.h:135: warning: Member 
Eina_Simple_XML_Attribute_Cb)(void *data, const char *key, const char *value) 
(typedef) of group Eina_Simple_XML_Group is not documented.
 /tmp/eina/src/include/eina_simple_xml_parser.h:86: warning: Member 
_Eina_Simple_XML_Node_Type (enumeration) of group Eina_Simple_XML_Group is not 
documented.
 /tmp/eina/src/include/eina_simple_xml_parser.h:121: warning: Member 
_Eina_Simple_XML_Type (enumeration) of group Eina_Simple_XML_Group is not 
documented.
-/tmp/eina/src/include/eina_simple_xml_parser.h:122: warning: Unsupported 
xml/html tag <tag> found
-/tmp/eina/src/include/eina_simple_xml_parser.h:123: warning: Unsupported 
xml/html tag <tag> found
-/tmp/eina/src/include/eina_simple_xml_parser.h:124: warning: Unsupported 
xml/html tag </tag> found
 <_Eina_Simple_XML_Type>:1: warning: parameters of member _Eina_Simple_XML_Type 
are not (all) documented
 /tmp/eina/src/include/eina_tiler.h:175: warning: Member Eina_Tile_Grid_Slicer 
(typedef) of group Eina_Tiler_Group is not documented.
 /tmp/eina/src/include/eina_tiler.h:208: warning: return type of member 
eina_tiler_rect_add is not documented


-- 
Jérôme Pinot
http://ngc891.blogdns.net/
Index: eina/src/include/eina_inarray.h
===================================================================
--- eina/src/include/eina_inarray.h     (revision 69721)
+++ eina/src/include/eina_inarray.h     (working copy)
@@ -130,7 +130,7 @@
  * @skip int
  * @until eina_init
  *
- * We then create the array much like we did on @ref eina_inarray_example_01:
+ * We then create the array much like we did on @ref eina_inarray_example_01 :
  * @until inarray_new
  *
  * The point were this example significantly differs from the first eina inline
Index: eina/src/include/eina_tiler.h
===================================================================
--- eina/src/include/eina_tiler.h       (revision 69721)
+++ eina/src/include/eina_tiler.h       (working copy)
@@ -29,7 +29,7 @@
  *
  * This is an example that illustrates how Eina_Tiler works for a given set of
  * rectangles. The rectangles must be given in the command line in the form:
- * <width>x<height>+<x offset>+<y offset>
+ * \<width\>x\<height\>+\<x offset\>+\<y offset\>
  * The example will show two panels, the first(input) will show the given
  * rectangles(in different colors) and in the seconds(output) it will show the
  * rectangles given by the tiler. The rectangles will be added one by one every
Index: eina/src/include/eina_simple_xml_parser.h
===================================================================
--- eina/src/include/eina_simple_xml_parser.h   (revision 69721)
+++ eina/src/include/eina_simple_xml_parser.h   (working copy)
@@ -119,15 +119,15 @@
 
 typedef enum _Eina_Simple_XML_Type
 {
-  EINA_SIMPLE_XML_OPEN = 0, /*!< <tag attribute="value"> */
-  EINA_SIMPLE_XML_OPEN_EMPTY, /*!< <tag attribute="value" /> */
-  EINA_SIMPLE_XML_CLOSE, /*!< </tag> */
+  EINA_SIMPLE_XML_OPEN = 0, /*!< \<tag attribute="value"\> */
+  EINA_SIMPLE_XML_OPEN_EMPTY, /*!< \<tag attribute="value" /\> */
+  EINA_SIMPLE_XML_CLOSE, /*!< \</tag\> */
   EINA_SIMPLE_XML_DATA, /*!< tag text data */
-  EINA_SIMPLE_XML_CDATA, /*!< <![CDATA[something]]> */
+  EINA_SIMPLE_XML_CDATA, /*!< \<![CDATA[something]]\> */
   EINA_SIMPLE_XML_ERROR, /*!< error contents */
-  EINA_SIMPLE_XML_PROCESSING, /*!< <?xml ... ?> <?php .. ?> */
-  EINA_SIMPLE_XML_DOCTYPE, /*!< <!DOCTYPE html */
-  EINA_SIMPLE_XML_COMMENT, /*!< <!-- something --> */
+  EINA_SIMPLE_XML_PROCESSING, /*!< \<?xml ... ?\> \<?php .. ?\> */
+  EINA_SIMPLE_XML_DOCTYPE, /*!< \<!DOCTYPE html */
+  EINA_SIMPLE_XML_COMMENT, /*!< \<!-- something --\> */
   EINA_SIMPLE_XML_IGNORED /*!< whatever is ignored by parser, like whitespace 
*/
 } Eina_Simple_XML_Type;
 
Index: eina/src/include/eina_value.h
===================================================================
--- eina/src/include/eina_value.h       (revision 69721)
+++ eina/src/include/eina_value.h       (working copy)
@@ -210,9 +210,9 @@
  *
  * Next we have setting, this however requires not one but rather two 
functions,
  * the reason for this is because to be able to receive arguments of any type
- * eina value uses @ref https://wikipedia.org/wiki/Variadic_functions "variadic
- * functions", so we need a function to get the argument from a va_list and
- * another to actually to the setting.
+ * eina value uses <a href="https://wikipedia.org/wiki/Variadic_functions";>
+ * variadic functions</a>, so we need a function to get the argument from a 
+ * va_list and another to actually to the setting.
  *
  * Lets first look at the pset function which sets the received value to a
  * pointer:
Index: eina/src/include/eina_clist.h
===================================================================
--- eina/src/include/eina_clist.h       (revision 69721)
+++ eina/src/include/eina_clist.h       (working copy)
@@ -43,7 +43,7 @@
  *
  * Elements of this list are members of the structs stored in the list
  *
- * Advantages over @ref Eina_List and @ref Eina_Inlist:
+ * Advantages over @ref Eina_List and @ref Eina_Inlist :
  *  - uses less memory (two machine words per item)
  *  - allows removing items without knowing which list they're in using O(1) 
time
  *  - no need to keep updating the head pointer as the list is changed
Index: eina/src/include/eina_inlist.h
===================================================================
--- eina/src/include/eina_inlist.h      (revision 69721)
+++ eina/src/include/eina_inlist.h      (working copy)
@@ -358,14 +358,14 @@
  * It may be the case that someone needs to have some inlist nodes added to a
  * @ref Eina_List too. If this happens, the inlist nodes can be added to the
  * @ref Eina_List without any problems. This example demonstrates this case:
- * @ref inlist_02_example_page
+ * @ref eina_inlist_02_example_page
  *
  * It's also possible to have some data that is part of two different inlists.
  * If this is the case, then it won't be possible to use the convenience macros
  * to both of the lists. It will be necessary to create a new set of macros 
that
  * will allow access to the second list node info. An example for this usage 
can
  * be found here:
- * @ref inlist_03_example_page
+ * @ref eina_inlist_03_example_page
  *
  * List of examples:
  * @li @ref eina_inlist_01_example_page

Attachment: signature.asc
Description: Digital signature

------------------------------------------------------------------------------
This SF email is sponsosred by:
Try Windows Azure free for 90 days Click Here 
http://p.sf.net/sfu/sfd2d-msazure
_______________________________________________
enlightenment-devel mailing list
enlightenment-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/enlightenment-devel

Reply via email to