summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorWonki Kim <wonki_.kim@samsung.com>2019-12-10 12:37:49 +0100
committerXavi Artigas <xavierartigas@yahoo.es>2019-12-10 12:53:39 +0100
commita8d7816782a1f48c12f2387a85168175f5baf7e2 (patch)
tree6f1c3ac1fcafe6690679488d6957b40b44b1c3dc
parentcbd02d3d51c6cbb6c118467088c6cd40f8114820 (diff)
docs: fix to make docs contain proper images
Summary: links to images that this patch is modifying would be included in doxy docs without pre or post process something in meson definition, if we applied this patch. Reviewers: segfaultxavi, bu5hm4n Reviewed By: segfaultxavi Subscribers: bu5hm4n, cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10821
-rw-r--r--doc/ecore_examples.dox10
-rwxr-xr-xdoc/efl_copy.sh1
-rw-r--r--doc/meson.build11
-rw-r--r--src/lib/ecore_con/Ecore_Con.h6
-rw-r--r--src/lib/eina/eina_hash.h4
-rw-r--r--src/lib/eina/eina_inlist.h8
-rw-r--r--src/lib/eina/eina_list.h40
-rw-r--r--src/lib/evas/Evas_Common.h10
8 files changed, 17 insertions, 73 deletions
diff --git a/doc/ecore_examples.dox b/doc/ecore_examples.dox
index 6454277..c02de6f 100644
--- a/doc/ecore_examples.dox
+++ b/doc/ecore_examples.dox
@@ -813,12 +813,9 @@
813 * 813 *
814 * This example will start a server and start accepting connections from clients, as 814 * This example will start a server and start accepting connections from clients, as
815 * demonstrated in the following diagram: 815 * demonstrated in the following diagram:
816 * @htmlonly
817 * <img src="ecore_con-client-server-example.png" style="max-width: 400px"/>
818 * <a href="ecore_con-client-server-example.png">Full size</a>
819 * @endhtmlonly
820 * 816 *
821 * @image rtf ecore_con-client-server-example.png 817 * @image rtf ecore_con-client-server-example.png
818 * @image html ecore_con-client-server-example.png
822 * @image latex ecore_con-client-server-example.eps width=\textwidth 819 * @image latex ecore_con-client-server-example.eps width=\textwidth
823 * 820 *
824 * @note This example contains a serious security flaw: it doesn't check for the 821 * @note This example contains a serious security flaw: it doesn't check for the
@@ -877,12 +874,9 @@
877 * 874 *
878 * This example will connect to the server and start comunicating with it, as 875 * This example will connect to the server and start comunicating with it, as
879 * demonstrated in the following diagram: 876 * demonstrated in the following diagram:
880 * @htmlonly
881 * <img src="ecore_con-client-server-example2.png" style="max-width: 400px"/>
882 * <a href="ecore_con-client-server-example2.png">Full size</a>
883 * @endhtmlonly
884 * 877 *
885 * @image rtf ecore_con-client-server-example2.png 878 * @image rtf ecore_con-client-server-example2.png
879 * @image html ecore_con-client-server-example2.png
886 * @image latex ecore_con-client-server-example2.eps width=\textwidth 880 * @image latex ecore_con-client-server-example2.eps width=\textwidth
887 * 881 *
888 * @note This example contains a serious security flaw: it doesn't check for the 882 * @note This example contains a serious security flaw: it doesn't check for the
diff --git a/doc/efl_copy.sh b/doc/efl_copy.sh
deleted file mode 100755
index af975fb..0000000
--- a/doc/efl_copy.sh
+++ /dev/null
@@ -1 +0,0 @@
1cp $@
diff --git a/doc/meson.build b/doc/meson.build
index 18b9aee..5ad3898 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -104,8 +104,6 @@ widget_preview_eps = custom_target('widget_preview_prefs_epc',
104 104
105shot_sh = find_program('shot.sh') 105shot_sh = find_program('shot.sh')
106tar = find_program('tar') 106tar = find_program('tar')
107efl_copy = find_program('efl_copy.sh')
108
109foreach text_filter_property : text_filter_properties 107foreach text_filter_property : text_filter_properties
110 text = text_filter_property[0] 108 text = text_filter_property[0]
111 font = text_filter_property[1] 109 font = text_filter_property[1]
@@ -182,17 +180,10 @@ doc_target += custom_target('doxygen',
182 build_by_default: false 180 build_by_default: false
183) 181)
184 182
185# This is not pretty but meson does not seem to allow wildcards in plain cp commands
186copy_images = custom_target('documentation images',
187 command: [efl_copy, '-rf', join_paths(meson.current_source_dir(), 'img', '*.png'), 'html'],
188 output: ['empty_img_copy'],
189 build_by_default: false
190)
191
192compress_target = custom_target('package_doc_tar', 183compress_target = custom_target('package_doc_tar',
193 command: [tar, '-C', meson.build_root(), '--xz', '-cf', 'efl-'+meson.project_version()+'-doc.tar.xz', 'html', 'man'], 184 command: [tar, '-C', meson.build_root(), '--xz', '-cf', 'efl-'+meson.project_version()+'-doc.tar.xz', 'html', 'man'],
194 output: 'efl-'+meson.project_version()+'-doc.tar.xz', 185 output: 'efl-'+meson.project_version()+'-doc.tar.xz',
195 depends: [doc_target, copy_images], 186 depends: [doc_target],
196 build_by_default: false 187 build_by_default: false
197) 188)
198 189
diff --git a/src/lib/ecore_con/Ecore_Con.h b/src/lib/ecore_con/Ecore_Con.h
index f919158..d8b9583 100644
--- a/src/lib/ecore_con/Ecore_Con.h
+++ b/src/lib/ecore_con/Ecore_Con.h
@@ -1126,12 +1126,8 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
1126 * server to client and client to server, can be represented in the following 1126 * server to client and client to server, can be represented in the following
1127 * sequence diagram: 1127 * sequence diagram:
1128 * 1128 *
1129 * @htmlonly
1130 * <img src="ecore_con-client-server.png" style="max-width: 400px"/>
1131 * <a href="ecore_con-client-server.png">Full size</a>
1132 * @endhtmlonly
1133 *
1134 * @image rtf ecore_con-client-server.png 1129 * @image rtf ecore_con-client-server.png
1130 * @image html ecore_con-client-server.png
1135 * @image latex ecore_con-client-server.eps width=\\textwidth 1131 * @image latex ecore_con-client-server.eps width=\\textwidth
1136 * 1132 *
1137 * Please notice the important difference between these two codes: the first is 1133 * Please notice the important difference between these two codes: the first is
diff --git a/src/lib/eina/eina_hash.h b/src/lib/eina/eina_hash.h
index cda625b..e7a1229 100644
--- a/src/lib/eina/eina_hash.h
+++ b/src/lib/eina/eina_hash.h
@@ -184,10 +184,8 @@
184 * (argument of @ref eina_hash_new too). The following picture illustrates the 184 * (argument of @ref eina_hash_new too). The following picture illustrates the
185 * basic idea: 185 * basic idea:
186 * 186 *
187 * @htmlonly
188 * <img src="01_hash-table.png" width="500" />
189 * @endhtmlonly
190 * @image latex 01_hash-table.eps 187 * @image latex 01_hash-table.eps
188 * @image html 01_hash-table.png
191 * 189 *
192 * Adding an element to the hash table involves the following steps: 190 * Adding an element to the hash table involves the following steps:
193 * @li calculate the hash for that key (using the specified hash function); 191 * @li calculate the hash for that key (using the specified hash function);
diff --git a/src/lib/eina/eina_inlist.h b/src/lib/eina/eina_inlist.h
index 0d20286..5adc310 100644
--- a/src/lib/eina/eina_inlist.h
+++ b/src/lib/eina/eina_inlist.h
@@ -153,10 +153,8 @@
153 * The two lists, sharing some elements, can be represented by the following 153 * The two lists, sharing some elements, can be represented by the following
154 * picture: 154 * picture:
155 * 155 *
156 * @htmlonly
157 * <img src="eina_inlist-node_eg2-list-inlist.png" style="max-width: 100%;"/>
158 * @endhtmlonly
159 * @image rtf eina_inlist-node_eg2-list-inlist.png 156 * @image rtf eina_inlist-node_eg2-list-inlist.png
157 * @image html eina_inlist-node_eg2-list-inlist.png
160 * @image latex eina_inlist-node_eg2-list-inlist.eps "" width=\textwidth 158 * @image latex eina_inlist-node_eg2-list-inlist.eps "" width=\textwidth
161 * 159 *
162 * Accessing both lists is done normally, as if they didn't have any elements in 160 * Accessing both lists is done normally, as if they didn't have any elements in
@@ -229,10 +227,8 @@
229 * 227 *
230 * And the resulting lists will be as follow: 228 * And the resulting lists will be as follow:
231 * 229 *
232 * @htmlonly
233 * <img src="eina_inlist-node_eg3-two-inlists.png" style="max-width: 100%;"/>
234 * @endhtmlonly
235 * @image rtf eina_inlist-node_eg3-two-inlists.png 230 * @image rtf eina_inlist-node_eg3-two-inlists.png
231 * @image html eina_inlist-node_eg3-two-inlists.png
236 * @image latex eina_inlist-node_eg3-two-inlists.eps "" width=\textwidth 232 * @image latex eina_inlist-node_eg3-two-inlists.eps "" width=\textwidth
237 * 233 *
238 * For the first list, we can use the macro @ref EINA_INLIST_FOREACH to iterate 234 * For the first list, we can use the macro @ref EINA_INLIST_FOREACH to iterate
diff --git a/src/lib/eina/eina_list.h b/src/lib/eina/eina_list.h
index 86892d1..569f84d 100644
--- a/src/lib/eina/eina_list.h
+++ b/src/lib/eina/eina_list.h
@@ -49,11 +49,8 @@
49 * @until eina_init 49 * @until eina_init
50 * Here we add a sequence of elements to our list. By using append we add 50 * Here we add a sequence of elements to our list. By using append we add
51 * elements to the end of the list, so the list will look like this:@n 51 * elements to the end of the list, so the list will look like this:@n
52 * @htmlonly
53 * <img src="eina_list_example_01_a.png" style="max-width: 100%;" />
54 * <a href="eina_list_example_01_a.png">Full-size</a>
55 * @endhtmlonly
56 * @image rtf eina_list_example_01_a.png 52 * @image rtf eina_list_example_01_a.png
53 * @image html eina_list_example_01_a.png
57 * @image latex eina_list_example_01_a.eps "" width=\textwidth 54 * @image latex eina_list_example_01_a.eps "" width=\textwidth
58 * @until roslin 55 * @until roslin
59 * There are a couple of interesting things happening here, first is that we are 56 * There are a couple of interesting things happening here, first is that we are
@@ -82,11 +79,8 @@
82 * far: 79 * far:
83 * @until lampkin 80 * @until lampkin
84 * With this additions our list now looks like this:@n 81 * With this additions our list now looks like this:@n
85 * @htmlonly
86 * <img src="eina_list_example_01_b.png" style="max-width: 100%;" />
87 * <a href="eina_list_example_01_b.png">Full-size</a>
88 * @endhtmlonly
89 * @image rtf eina_list_example_01_b.png 82 * @image rtf eina_list_example_01_b.png
83 * @image html eina_list_example_01_b.png
90 * @image latex eina_list_example_01_b.eps "" width=\textwidth 84 * @image latex eina_list_example_01_b.eps "" width=\textwidth
91 * 85 *
92 * Once done using the list it needs to be freed, and since we are done with 86 * Once done using the list it needs to be freed, and since we are done with
@@ -255,11 +249,8 @@
255 * @ref Eina_List nodes keep references to the previous node, the next node, its 249 * @ref Eina_List nodes keep references to the previous node, the next node, its
256 * data and to an accounting structure. 250 * data and to an accounting structure.
257 * 251 *
258 * @htmlonly
259 * <img src="eina_list.png" style="max-width: 100%;" />
260 * <a href="eina_list.png">Full-size</a>
261 * @endhtmlonly
262 * @image rtf eina_list.png 252 * @image rtf eina_list.png
253 * @image html eina_list.png
263 * @image latex eina_list.eps width=5cm 254 * @image latex eina_list.eps width=5cm
264 * 255 *
265 * @ref Eina_List_Accounting is used to improve the performance of some 256 * @ref Eina_List_Accounting is used to improve the performance of some
@@ -1388,11 +1379,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1388 * 1379 *
1389 * The following diagram illustrates this macro iterating over a list of four 1380 * The following diagram illustrates this macro iterating over a list of four
1390 * elements("one", "two", "three" and "four"): 1381 * elements("one", "two", "three" and "four"):
1391 * @htmlonly
1392 * <img src="eina-list-foreach.png" style="max-width: 100%;" />
1393 * <a href="eina-list-foreach.png">Full-size</a>
1394 * @endhtmlonly
1395 * @image latex eina-list-foreach.eps "" width=\textwidth 1382 * @image latex eina-list-foreach.eps "" width=\textwidth
1383 * @image html eina-list-foreach.png
1396 * 1384 *
1397 * It can be used to free list data, as in the following example: 1385 * It can be used to free list data, as in the following example:
1398 * 1386 *
@@ -1450,11 +1438,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1450 * 1438 *
1451 * The following diagram illustrates this macro iterating over a list of four 1439 * The following diagram illustrates this macro iterating over a list of four
1452 * elements("one", "two", "three" and "four"): 1440 * elements("one", "two", "three" and "four"):
1453 * @htmlonly
1454 * <img src="eina-list-reverse-foreach.png" style="max-width: 100%;" />
1455 * <a href="eina-list-reverse-foreach.png">Full-size</a>
1456 * @endhtmlonly
1457 * @image latex eina-list-reverse-foreach.eps "" width=\textwidth 1441 * @image latex eina-list-reverse-foreach.eps "" width=\textwidth
1442 * @image html eina-list-reverse-foreach.png
1458 * 1443 *
1459 * It can be used to free list data, as in the following example: 1444 * It can be used to free list data, as in the following example:
1460 * 1445 *
@@ -1513,11 +1498,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1513 * 1498 *
1514 * The following diagram illustrates this macro iterating over a list of four 1499 * The following diagram illustrates this macro iterating over a list of four
1515 * elements ("one", "two", "three" and "four"): 1500 * elements ("one", "two", "three" and "four"):
1516 * @htmlonly
1517 * <img src="eina-list-foreach-safe.png" style="max-width: 100%;" />
1518 * <a href="eina-list-foreach-safe.png">Full-size</a>
1519 * @endhtmlonly
1520 * @image latex eina-list-foreach-safe.eps "" width=\textwidth 1501 * @image latex eina-list-foreach-safe.eps "" width=\textwidth
1502 * @image html eina-list-foreach-safe.png
1521 * 1503 *
1522 * This macro can be used to free list nodes, as in the following example: 1504 * This macro can be used to free list nodes, as in the following example:
1523 * 1505 *
@@ -1574,11 +1556,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1574 * 1556 *
1575 * The following diagram illustrates this macro iterating over a list of four 1557 * The following diagram illustrates this macro iterating over a list of four
1576 * elements ("one", "two", "three" and "four"): 1558 * elements ("one", "two", "three" and "four"):
1577 * @htmlonly
1578 * <img src="eina-list-reverse-foreach-safe.png" style="max-width: 100%;" />
1579 * <a href="eina-list-reverse-foreach-safe.png">Full-size</a>
1580 * @endhtmlonly
1581 * @image latex eina-list-reverse-foreach-safe.eps "" width=\textwidth 1559 * @image latex eina-list-reverse-foreach-safe.eps "" width=\textwidth
1560 * @image html eina-list-reverse-foreach-safe.png
1582 * 1561 *
1583 * This macro can be used to free list nodes, as in the following example: 1562 * This macro can be used to free list nodes, as in the following example:
1584 * 1563 *
@@ -1627,11 +1606,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
1627 * 1606 *
1628 * The following diagram illustrates this macro iterating over a list of four 1607 * The following diagram illustrates this macro iterating over a list of four
1629 * elements ("one", "two", "three" and "four"): 1608 * elements ("one", "two", "three" and "four"):
1630 * @htmlonly
1631 * <img src="eina-list-free.png" style="max-width: 100%;" />
1632 * <a href="eina-list-free.png">Full-size</a>
1633 * @endhtmlonly
1634 * @image latex eina-list-free.eps "" width=\textwidth 1609 * @image latex eina-list-free.eps "" width=\textwidth
1610 * @image html eina-list-free.png
1635 * 1611 *
1636 * If you do not need to release node data, it is easier to call #eina_list_free(). 1612 * If you do not need to release node data, it is easier to call #eina_list_free().
1637 * 1613 *
diff --git a/src/lib/evas/Evas_Common.h b/src/lib/evas/Evas_Common.h
index d75cc1a..7c5efc3 100644
--- a/src/lib/evas/Evas_Common.h
+++ b/src/lib/evas/Evas_Common.h
@@ -1629,17 +1629,11 @@ EAPI const Evas_Device *evas_device_emulation_source_get(const Evas_Device *dev)
1629 * treated specially on resizing scales, by keeping their aspect. This 1629 * treated specially on resizing scales, by keeping their aspect. This
1630 * makes setting frames around other objects on UIs easy. 1630 * makes setting frames around other objects on UIs easy.
1631 * See the following figures for a visual explanation:\n 1631 * See the following figures for a visual explanation:\n
1632 * @htmlonly
1633 * <img src="image-borders.png" style="max-width: 100%;" />
1634 * <a href="image-borders.png">Full-size</a>
1635 * @endhtmlonly
1636 * @image rtf image-borders.png 1632 * @image rtf image-borders.png
1633 * @image html image-borders.png
1637 * @image latex image-borders.eps width=\textwidth 1634 * @image latex image-borders.eps width=\textwidth
1638 * @htmlonly
1639 * <img src="border-effect.png" style="max-width: 100%;" />
1640 * <a href="border-effect.png">Full-size</a>
1641 * @endhtmlonly
1642 * @image rtf border-effect.png 1635 * @image rtf border-effect.png
1636 * @image html border-effect.png
1643 * @image latex border-effect.eps width=\textwidth 1637 * @image latex border-effect.eps width=\textwidth
1644 * 1638 *
1645 * @section Evas_Object_Image_Manipulation Manipulating pixels 1639 * @section Evas_Object_Image_Manipulation Manipulating pixels