Commit Graph

85 Commits

Author SHA1 Message Date
vitor.sousa 0902b6a6f8 eina_cxx: add documentation to the Eina C++ header files.
Summary:
Added documentation to almost all classes that are intended for direct use by the library users.
Marked classes/functions used by the library itself as @internal.
Modified the Doxyfile.in to enable the generation of documentation to the bindings.

Reviewers: felipealmeida, cedric, woohyun, smohanty, raster

CC: savio, cedric

Differential Revision: https://phab.enlightenment.org/D947

Signed-off-by: Cedric BAIL <c.bail@partner.samsung.com>
2014-06-04 22:34:47 +02:00
Jean-Philippe Andre 139f7bc178 Evas doc: Add example for padding_set (filters)
With preview and all.
2014-05-09 16:57:39 +09:00
Jean-Philippe Andre 8a1b335bb1 Evas doc: Move filters examples to Lua
Part 1: auto-generated examples with previews
2014-05-09 16:57:39 +09:00
Mike Blumenkrantz 0cc713b765 docs now have a slightly more english description and list libs alphabetically 2014-04-14 14:39:21 -04:00
Jeff Grimshaw a1791e5701 doc: remove deprecated setting SYMBOL_CACHE_SIZE
Summary:
The setting SYMBOL_CACHE_SIZE has been deprecated and will
generate a warning when Doxygen runs.  This change comments out that
configuration setting to prevent the warning.

Test Plan: make doc 2> doxyerr.log

CC: cedric

Differential Revision: https://phab.enlightenment.org/D599

Signed-off-by: Cedric BAIL <cedric.bail@samsung.com>
2014-03-05 14:16:29 +09:00
Jean-Philippe Andre f34305a7d6 Doc: Use transparent images for Doxygen
Set the proper transparent & alpha flags on the Ecore_Evas,
add a tranparent rectangle and boom, the images are all nice and
transparent. This will fix the bg color in the page evasfiltersref.
2014-02-24 11:04:28 +09:00
Carsten Haitzler f6ee3fc8b5 documentation style cleanup for release
this cleans up the doxygen generated docs to be acceptable for a
release - style is changed and unused images removed etc.
2014-02-21 22:26:26 +09:00
Cedric BAIL 5ea8c8cc4d autotools: detect cross compilation. 2014-02-20 20:23:24 +09:00
Cedric BAIL 6f85993602 doc: fix build on windows. 2014-02-20 20:23:24 +09:00
Jean-Philippe Andre f1e1e70650 Dox: Try to fix build for windows
Evil support was not included in the docs preview generator build.
Tested locally with Makefile & deps from the wiki (win64).
2014-02-19 14:24:30 +09:00
Jean-Philippe Andre 29a7fe464e Doc: Fix compilation warning in preview_text_filter.c
Init variable properly.
2014-02-14 13:06:05 +09:00
Jean-Philippe Andre 568c014dc9 Doc: Try to fix nightly builds
Nightly build failed with (make doc):
cd: ../../../src/lib/eo/.libs: No such file or directory
Looks like there's one too many ../

I guess the build dir is not the source dir on the build bots.
2014-02-14 10:10:37 +09:00
Carsten Haitzler 0ad92d81e2 fix DSO complaint on build ... build break by jpeg. 2014-02-13 20:04:29 +09:00
Carsten Haitzler 9232e2befa fix build break with preview_text_filter.c 2014-02-13 19:02:08 +09:00
Jean-Philippe Andre 511049e20d Evas filters: Improve doc automatization
Include example filter codes from src/examples in Doxygen.
Use these examples for the generation as well.
2014-02-13 17:37:33 +09:00
Jean-Philippe Andre 9f1ae254db Evas filters: Add image for the Syntax example
And change it a bit so the glow is nicer :)
2014-02-13 17:37:33 +09:00
Jean-Philippe Andre 8665a3d574 Doc: Add filter examples from the doc
The filter code is a copy and paste from the doc.
Maybe the code should be in an include file, so we're sure the
preview and the documentation code are the same?
2014-02-13 17:37:33 +09:00
Jean-Philippe Andre a9b82a7928 Doc: Add makefile for text filter previews
Build utility tool based on the local hidden .libs
2014-02-13 17:36:23 +09:00
Jean-Philippe Andre cd926cc946 Evas filters: Add a small utility to take some screenshots
Let's add some real screenshots to the documentation!
Yay! Fancy effects inlined in the Doxygen! Well... soon :)
2014-02-13 17:29:32 +09:00
Jean-Philippe Andre 0a97a74319 Doxygen: Reduce line gap in code fragments
Code should look compact, why use small fonts otherwise?
Reduce the gap between code lines (stored as separate <div>)
to 70%. This looks about right.
2014-02-13 11:24:48 +09:00
Jean-Philippe Andre 642f2ecca9 Doxygen: Use larger fonts
Yes, I know. Someone hates large fonts.
But the ones currently used are so SMALL!
Also, this will just revert back to what's defined in e.css,
because body and list font size aren't even consistent.

Also, display the page titles like titles: big fat blue letters.
2014-02-13 11:24:48 +09:00
Jean-Philippe Andre 0471c9a835 Doxygen: Align param names vertically to the top
If a param description is long and spans on multiple lines,
then the param name should be aligned to the first description
line. Otherwise the layout becomes confusing.

Align [in] and [out] vertically like params.
2014-02-13 11:24:47 +09:00
Daniel Juyung Seo 23a36b642b efl: fixed documentation typos. 2014-01-29 00:19:41 +09:00
Jihoon Kim 3ebc18731f Use key instead of keyname for considering setxkbmap 2014-01-04 13:25:21 +09:00
Carsten Haitzler 82841fefe3 fix seb "fix" commit that causes lots of segvs.
this fixes 04e0a6d95e which introduced
copy & paste segv's by properly terminating the right buffer.
2013-12-09 18:39:07 +09:00
Sebastian Dransfeld 1d1feea572 eldbus: Check return value of _type_size
_type_size could return 0, which would fail in the modulo call next.
Check for 0, and return.

Fixes CID 1039436
2013-12-07 21:11:32 +01:00
Carsten Haitzler 8b0955c8d0 doc build - finally fix images.mk to stop changing order every make
sort changes output based on locale. even between C and en_US etc.
letalone all the other interesting ones. this causes the sorted order
to keep changing of the images. this forces locale to C to make it
always the same order.
2013-12-06 09:02:18 +09:00
Carsten Haitzler a1b57d3536 yet another useless images.mk change... 2013-12-04 20:25:57 +09:00
Carsten Haitzler b546fb6113 update images.mk 2013-11-29 19:09:17 +09:00
Jerome Pinot 09e0f78bee doc: add missing images
The edje-nested.{png,eps} files were missing in the doc tree. I
regenerated them using the sample code from tutorial_edje_nested.html
2013-11-28 22:23:32 +09:00
Stefan Schmidt e02d94bb80 doc: Use correct line break to fix build
Escaping the backslash we want to use for a line break is a really bad idea.
Introduced in f126afbba2 to support a crippled
echo without new line option.

The linebreak was not detected and thus the first image name used as a target.
Broke our nightly efl build with make distcheck and made me really unhappy to
while searching for the cause.
2013-11-18 15:35:12 +01:00
Carsten Haitzler 03969c9822 doc - update images.mk 2013-11-16 09:46:19 +09:00
Jean Guyomarc'h f126afbba2 Fix build issues on Mac OS X due to sh differences.
Summary:
  * efl.m4: add support for xterm-256color and fix display for the bsd echo. Fix autotools issue (present on Ubuntu also, but better handled).
  * doc/Makefile.am: bsd echo may not handle -n option in sh

Reviewers: cedric

CC: cedric, seoz

Differential Revision: https://phab.enlightenment.org/D329
2013-11-16 09:43:23 +09:00
Carsten Haitzler de639509a7 update images.mk 2013-06-09 16:20:06 +09:00
Carsten Haitzler fa41dbd861 update pkgbuild 2013-06-07 19:13:47 +09:00
Carsten Haitzler 9713353e6c update images.mk? 2013-06-06 10:38:46 +09:00
Carsten Haitzler bec4be64a1 efl: actually test and make pkgbuild work. 2013-06-05 20:08:58 +09:00
Daniel Zaoui f6a37f88d2 Eo: Add reference functions for objects data
We want to introduce a new mechanism concerning the data of the Eo
objects.
The goal is to improve the memory management by defragmenting the memory
banks used by the Eo objects. The first phase has been done by raster
and consists in allocating the objects into a separate memory region
that the one used by malloc. So now, we know where our objects are
located.
Now, moving objects means moving data of objects. The issue we have here
is that a lot of data pointers are stored into data of other objects,
e.g Evas Object data into lists for rendering...
We need a way to reference the data and eo_data_get doesn't provide us
that. So we need to improve the API for data extraction by requesting
from the developer if the data will be stored or not. Five functions are
supplied:
- eo_data_scope_get: no referencing, the data pointer is no more used after
exiting the function.
- eo_data_ref: reference the data of the object. It means that while the
data is referenced, the object cannot be moved.
- eo_data_xref: reference the data of the object but for debug purpose,
we associate the objects that references. Same behavior as eo_data_ref
for non-debug.
- eo_data_unref: unreference the data of an object.
- eo_data_xunref: unreference the data of an object previously
referenced by another object.

I deprecated the eo_data_get function. Most of the time,
eo_data_scope_get needs to be used.

In the next patches, I changed the eo_data_get to the corresponding
functions, according to the usage of the data pointer.

The next step is to find all the places in the code where the data is
stored but not yet referenced. This will be done by:
- requesting from every object to unreference all data to other objects.
- moving all the objects from one region to another
- requesting from every object to rerefenrence the data.
- debugging by hunting the segmentation faults and other weird
creatures.
2013-05-01 10:37:08 +03:00
Lucas De Marchi 4e3804041f Rename edbus->eldbus
git grep -l edbus2 | while read f; do sed -i 's/edbus2/eldbus/g' "$f"; done
find . -name '*edbus2*' -exec rename edbus2 eldbus {} \;

git grep -l "EDBUS" | while read f; do sed -i 's/EDBUS/ELDBUS/g' "$f"; done
git grep -l "EDBus" | while read f; do sed -i 's/EDBus/Eldbus/g' "$f"; done
git grep -l "edbus (v2)" | while read f; do sed -i 's/edbus (v2)/eldbus/g' "$f"; done
git grep -l "Edbus" | while read f; do sed -i 's/Edbus/Eldbus/g' "$f"; done
git grep -l "edbus" | while read f; do sed -i 's/edbus/eldbus/g' "$f"; done

find . -name '*edbus*' -exec rename edbus eldbus {} \;
find . -name '*EDBus*' -exec rename EDBus Eldbus {} \;
2013-04-23 12:36:29 -03:00
Carsten Haitzler 284e6c963d oops get images.mk generation right. missing | 2013-03-26 09:42:31 +09:00
Carsten Haitzler fb1b5ff11b filter ~ from images.mk and restore it to not have ~ files. 2013-03-26 09:39:50 +09:00
Carsten Haitzler 3a569fb461 update doc styling to match e.org 2013-03-25 22:36:57 +09:00
Stefan Schmidt cc17d592b2 efl/doc: Remove all .svn entries from the generated file.
This is now longer needed now that we switched to git. And it should
also silent all the file modified problems.

The next time this file is listed as modified you should either have
done it yourself or added an image in the efl docs img folder.
2013-02-15 10:34:25 +00:00
Tom Hacohen 44a2996f65 Efl: revert committing that damned images.mk.
SVN revision: 83448
2013-01-29 16:50:54 +00:00
Tom Hacohen 70156285b0 Eo dbg: Use eina_value as the debug info type.
SVN revision: 83443
2013-01-29 16:36:01 +00:00
Carsten Haitzler 29ebec4bfb MINOR feature... not worth changelogging - add send event flag to
ecore-x-hide event.



SVN revision: 83418
2013-01-29 08:23:40 +00:00
Stefan Schmidt ef8e803d75 efl/doc/images.mk: Lets not have all kind of images from .svn in here.
This breaks out of tree builds (buildbot) as well as setups without .svn
dirs (git-svn). The newly generated list should include all files but
drops all the entries from .svn.

SVN revision: 83302
2013-01-24 14:41:33 +00:00
Stefan Schmidt b209454381 Revert changes to the generated images.mk file
SVN revision: 83148
2013-01-23 10:19:47 +00:00
Stefan Schmidt 4cc93b9f2c efl/ecore_x: Fix leak of data.
If we fail we still have the malloced data. Free it in this case. Bot
commit for devilhors.

SVN revision: 83135
2013-01-23 09:51:47 +00:00
Carsten Haitzler f19ff1481a at least for me.. somehting keeps changing imnages.mk .. because it
has to olittle stuff in it... i am not sure this shoul dbe in svn?



SVN revision: 83111
2013-01-22 23:41:50 +00:00