From: Jérôme Pinot <ngc891@gmail.com>
authorraster <raster@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Thu, 29 Mar 2012 11:35:34 +0000 (11:35 +0000)
committerraster <raster@7cbeb6ba-43b4-40fd-8cce-4c39aea84d33>
Thu, 29 Mar 2012 11:35:34 +0000 (11:35 +0000)
Subject: [E-devel] [patch] eina doxygen doc

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

git-svn-id: svn+ssh://svn.enlightenment.org/var/svn/e/trunk/eina@69746 7cbeb6ba-43b4-40fd-8cce-4c39aea84d33

AUTHORS
src/include/eina_clist.h
src/include/eina_inarray.h
src/include/eina_inlist.h
src/include/eina_simple_xml_parser.h
src/include/eina_tiler.h
src/include/eina_value.h

diff --git a/AUTHORS b/AUTHORS
index 6091910..8b4b115 100644 (file)
--- a/AUTHORS
+++ b/AUTHORS
@@ -23,3 +23,4 @@ Sung W. Park <sungwoo@gmail.com>
 Guillaume Friloux <guillaume.friloux@asp64.com>
 Jonas M. Gastal <jgastal@profusion.mobi>
 Raphael Kubo da Costa <rakuco@freebsd.org>
+Jérôme Pinot <ngc891@gmail.com>
index 096a4b7..1a2d959 100644 (file)
@@ -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 079f1e3..7d0902c 100644 (file)
  * @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 cfb3159..d22328a 100644 (file)
  * 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
index 78660ef..e6571b0 100644 (file)
@@ -119,15 +119,15 @@ struct _Eina_Simple_XML_Node_Data
 
 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 5272099..d7e1bc8 100644 (file)
@@ -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 341781f..d55135d 100644 (file)
  *
  * 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: