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
devs/xartigas/eolian_mono_list_formatting
Wonki Kim 3 years ago committed by Xavi Artigas
parent cbd02d3d51
commit a8d7816782
  1. 10
      doc/ecore_examples.dox
  2. 1
      doc/efl_copy.sh
  3. 11
      doc/meson.build
  4. 6
      src/lib/ecore_con/Ecore_Con.h
  5. 4
      src/lib/eina/eina_hash.h
  6. 8
      src/lib/eina/eina_inlist.h
  7. 40
      src/lib/eina/eina_list.h
  8. 10
      src/lib/evas/Evas_Common.h

@ -813,12 +813,9 @@
*
* This example will start a server and start accepting connections from clients, as
* demonstrated in the following diagram:
* @htmlonly
* <img src="ecore_con-client-server-example.png" style="max-width: 400px"/>
* <a href="ecore_con-client-server-example.png">Full size</a>
* @endhtmlonly
*
* @image rtf ecore_con-client-server-example.png
* @image html ecore_con-client-server-example.png
* @image latex ecore_con-client-server-example.eps width=\textwidth
*
* @note This example contains a serious security flaw: it doesn't check for the
@ -877,12 +874,9 @@
*
* This example will connect to the server and start comunicating with it, as
* demonstrated in the following diagram:
* @htmlonly
* <img src="ecore_con-client-server-example2.png" style="max-width: 400px"/>
* <a href="ecore_con-client-server-example2.png">Full size</a>
* @endhtmlonly
*
* @image rtf ecore_con-client-server-example2.png
* @image html ecore_con-client-server-example2.png
* @image latex ecore_con-client-server-example2.eps width=\textwidth
*
* @note This example contains a serious security flaw: it doesn't check for the

@ -104,8 +104,6 @@ widget_preview_eps = custom_target('widget_preview_prefs_epc',
shot_sh = find_program('shot.sh')
tar = find_program('tar')
efl_copy = find_program('efl_copy.sh')
foreach text_filter_property : text_filter_properties
text = text_filter_property[0]
font = text_filter_property[1]
@ -182,17 +180,10 @@ doc_target += custom_target('doxygen',
build_by_default: false
)
# This is not pretty but meson does not seem to allow wildcards in plain cp commands
copy_images = custom_target('documentation images',
command: [efl_copy, '-rf', join_paths(meson.current_source_dir(), 'img', '*.png'), 'html'],
output: ['empty_img_copy'],
build_by_default: false
)
compress_target = custom_target('package_doc_tar',
command: [tar, '-C', meson.build_root(), '--xz', '-cf', 'efl-'+meson.project_version()+'-doc.tar.xz', 'html', 'man'],
output: 'efl-'+meson.project_version()+'-doc.tar.xz',
depends: [doc_target, copy_images],
depends: [doc_target],
build_by_default: false
)

@ -1126,12 +1126,8 @@ EAPI void ecore_con_socks_apply_always(Ecore_Con_Socks *ecs);
* server to client and client to server, can be represented in the following
* sequence diagram:
*
* @htmlonly
* <img src="ecore_con-client-server.png" style="max-width: 400px"/>
* <a href="ecore_con-client-server.png">Full size</a>
* @endhtmlonly
*
* @image rtf ecore_con-client-server.png
* @image html ecore_con-client-server.png
* @image latex ecore_con-client-server.eps width=\\textwidth
*
* Please notice the important difference between these two codes: the first is

@ -184,10 +184,8 @@
* (argument of @ref eina_hash_new too). The following picture illustrates the
* basic idea:
*
* @htmlonly
* <img src="01_hash-table.png" width="500" />
* @endhtmlonly
* @image latex 01_hash-table.eps
* @image html 01_hash-table.png
*
* Adding an element to the hash table involves the following steps:
* @li calculate the hash for that key (using the specified hash function);

@ -153,10 +153,8 @@
* The two lists, sharing some elements, can be represented by the following
* picture:
*
* @htmlonly
* <img src="eina_inlist-node_eg2-list-inlist.png" style="max-width: 100%;"/>
* @endhtmlonly
* @image rtf eina_inlist-node_eg2-list-inlist.png
* @image html eina_inlist-node_eg2-list-inlist.png
* @image latex eina_inlist-node_eg2-list-inlist.eps "" width=\textwidth
*
* Accessing both lists is done normally, as if they didn't have any elements in
@ -229,10 +227,8 @@
*
* And the resulting lists will be as follow:
*
* @htmlonly
* <img src="eina_inlist-node_eg3-two-inlists.png" style="max-width: 100%;"/>
* @endhtmlonly
* @image rtf eina_inlist-node_eg3-two-inlists.png
* @image html eina_inlist-node_eg3-two-inlists.png
* @image latex eina_inlist-node_eg3-two-inlists.eps "" width=\textwidth
*
* For the first list, we can use the macro @ref EINA_INLIST_FOREACH to iterate

@ -49,11 +49,8 @@
* @until eina_init
* Here we add a sequence of elements to our list. By using append we add
* elements to the end of the list, so the list will look like this:@n
* @htmlonly
* <img src="eina_list_example_01_a.png" style="max-width: 100%;" />
* <a href="eina_list_example_01_a.png">Full-size</a>
* @endhtmlonly
* @image rtf eina_list_example_01_a.png
* @image html eina_list_example_01_a.png
* @image latex eina_list_example_01_a.eps "" width=\textwidth
* @until roslin
* There are a couple of interesting things happening here, first is that we are
@ -82,11 +79,8 @@
* far:
* @until lampkin
* With this additions our list now looks like this:@n
* @htmlonly
* <img src="eina_list_example_01_b.png" style="max-width: 100%;" />
* <a href="eina_list_example_01_b.png">Full-size</a>
* @endhtmlonly
* @image rtf eina_list_example_01_b.png
* @image html eina_list_example_01_b.png
* @image latex eina_list_example_01_b.eps "" width=\textwidth
*
* Once done using the list it needs to be freed, and since we are done with
@ -255,11 +249,8 @@
* @ref Eina_List nodes keep references to the previous node, the next node, its
* data and to an accounting structure.
*
* @htmlonly
* <img src="eina_list.png" style="max-width: 100%;" />
* <a href="eina_list.png">Full-size</a>
* @endhtmlonly
* @image rtf eina_list.png
* @image html eina_list.png
* @image latex eina_list.eps width=5cm
*
* @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)
*
* The following diagram illustrates this macro iterating over a list of four
* elements("one", "two", "three" and "four"):
* @htmlonly
* <img src="eina-list-foreach.png" style="max-width: 100%;" />
* <a href="eina-list-foreach.png">Full-size</a>
* @endhtmlonly
* @image latex eina-list-foreach.eps "" width=\textwidth
* @image html eina-list-foreach.png
*
* It can be used to free list data, as in the following example:
*
@ -1450,11 +1438,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
*
* The following diagram illustrates this macro iterating over a list of four
* elements("one", "two", "three" and "four"):
* @htmlonly
* <img src="eina-list-reverse-foreach.png" style="max-width: 100%;" />
* <a href="eina-list-reverse-foreach.png">Full-size</a>
* @endhtmlonly
* @image latex eina-list-reverse-foreach.eps "" width=\textwidth
* @image html eina-list-reverse-foreach.png
*
* It can be used to free list data, as in the following example:
*
@ -1513,11 +1498,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
*
* The following diagram illustrates this macro iterating over a list of four
* elements ("one", "two", "three" and "four"):
* @htmlonly
* <img src="eina-list-foreach-safe.png" style="max-width: 100%;" />
* <a href="eina-list-foreach-safe.png">Full-size</a>
* @endhtmlonly
* @image latex eina-list-foreach-safe.eps "" width=\textwidth
* @image html eina-list-foreach-safe.png
*
* This macro can be used to free list nodes, as in the following example:
*
@ -1574,11 +1556,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
*
* The following diagram illustrates this macro iterating over a list of four
* elements ("one", "two", "three" and "four"):
* @htmlonly
* <img src="eina-list-reverse-foreach-safe.png" style="max-width: 100%;" />
* <a href="eina-list-reverse-foreach-safe.png">Full-size</a>
* @endhtmlonly
* @image latex eina-list-reverse-foreach-safe.eps "" width=\textwidth
* @image html eina-list-reverse-foreach-safe.png
*
* This macro can be used to free list nodes, as in the following example:
*
@ -1627,11 +1606,8 @@ EAPI int eina_list_data_idx(const Eina_List *list, void *data)
*
* The following diagram illustrates this macro iterating over a list of four
* elements ("one", "two", "three" and "four"):
* @htmlonly
* <img src="eina-list-free.png" style="max-width: 100%;" />
* <a href="eina-list-free.png">Full-size</a>
* @endhtmlonly
* @image latex eina-list-free.eps "" width=\textwidth
* @image html eina-list-free.png
*
* If you do not need to release node data, it is easier to call #eina_list_free().
*

@ -1629,17 +1629,11 @@ EAPI const Evas_Device *evas_device_emulation_source_get(const Evas_Device *dev)
* treated specially on resizing scales, by keeping their aspect. This
* makes setting frames around other objects on UIs easy.
* See the following figures for a visual explanation:\n
* @htmlonly
* <img src="image-borders.png" style="max-width: 100%;" />
* <a href="image-borders.png">Full-size</a>
* @endhtmlonly
* @image rtf image-borders.png
* @image html image-borders.png
* @image latex image-borders.eps width=\textwidth
* @htmlonly
* <img src="border-effect.png" style="max-width: 100%;" />
* <a href="border-effect.png">Full-size</a>
* @endhtmlonly
* @image rtf border-effect.png
* @image html border-effect.png
* @image latex border-effect.eps width=\textwidth
*
* @section Evas_Object_Image_Manipulation Manipulating pixels

Loading…
Cancel
Save