Commit Graph

162 Commits

Author SHA1 Message Date
Xavi Artigas aa7ec61664 docfx: Hide *Concrete classes from docs
Ref T7702
2019-03-14 19:15:28 +01:00
Xavi Artigas 8fc4e94877 docfx: Exclude *NativeInherit classes from docs
These classes need to be public so new user-created classes can inherit
from them, but they have the same content as the regular classes.
Therefore there is no need to pollute the documentation with duplicated
elements.
2019-03-01 17:01:59 +01:00
Xavi Artigas 133b659b73 docs: Add custom DocFX templates
Summary:
These templates add the following features:
- Collapsible sections for simpler reading
- Full class names in ancestors list
  (Could not make it work for descendants)
- Removed duplicated Implements section
- Removed huge Inherited Members section
- Extended maximum number of hierarchy levels from 5 to 10
  (because our hierarchy is really that big)

Test Plan:
Follow the doc/docfx README to generate the HTML pages and enjoy the improved
and slightly-more-usable docs.

Reviewers: lauromoura, bu5hm4n, zmike, cedric

Reviewed By: lauromoura

Subscribers: #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D7832
2019-02-11 14:18:12 +01:00
Xavi Artigas c55299ca51 docs: Fix assorted typos in legacy documentation
Samsung reported a long list of typos in our legacy docs, this fixes them.
2019-01-28 13:14:20 +01:00
Xavi Artigas a50edaf17b eina: refactor eina_value_*_new.
Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es>
Differential Revision: https://phab.enlightenment.org/D7701
2019-01-23 10:54:13 -08:00
Xavi Artigas 06604d5d25 eina: refactor eina_value_*_init.
Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es>
Differential Revision: https://phab.enlightenment.org/D7700
2019-01-23 10:54:11 -08:00
Xavi Artigas de608bb203 eina: refactor eina_value_*_get.
Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es>
Differential Revision: https://phab.enlightenment.org/D7699
2019-01-23 10:54:09 -08:00
Cedric BAIL 1150cce0bf eina: add Eina_Value helper that convert efficiently to a target native C type.
Reviewed-by: SangHyeon Jade Lee <sh10233.lee@samsung.com>
Differential Revision: https://phab.enlightenment.org/D7650
2019-01-23 10:54:05 -08:00
Xavi Artigas 2d8f3fba46 doc: Add support for DocFX (C# doc generator)
Summary: Usage instructions in the README file.

Test Plan:
Follow the README to produce the documentation pages.
Point your browser to docfx/_site/index.html to see the results.

Reviewers: lauromoura, bu5hm4n, cedric, myoungwoon, zmike

Reviewed By: lauromoura, bu5hm4n

Subscribers: #reviewers, #committers

Tags: #efl

Maniphest Tasks: T7424

Differential Revision: https://phab.enlightenment.org/D7502
2019-01-07 17:07:42 +01:00
Bowon Ryu 1bce388ec9 docs: fix the incorrect group name of segment control
Summary:
Now the links in docs are connected normally.
related commit: https://phab.enlightenment.org/D7087

Test Plan: N/A

Reviewers: Jaehyun_Cho

Reviewed By: Jaehyun_Cho

Subscribers: cedric, #reviewers, #committers

Tags: #efl

Differential Revision: https://phab.enlightenment.org/D7125
2018-10-02 19:51:41 +09:00
Andy Williams 5937b1a3de docs: link to the module list in legacy docs
This should improve visibility of stuff that is not specifically
mentioned on the home page
2017-12-15 17:22:31 +00:00
Andy Williams 6df492b6b7 docs: Don't ignore eo.legacy.h files in doxygen 2017-12-14 14:28:19 +00:00
Andy Williams 6f38e42f8e docs: Remove the Efl namespace from our legacy docs
This means removing bindings from the output too
as they are making the transition over.
2017-12-13 18:10:57 +00:00
Andy Williams ebff6b42ef docs: Updated legacy API introduction 2017-12-13 18:10:57 +00:00
Andy Williams 7b5551c548 docs: Attach the google analytics code to our docs pages too 2017-12-08 11:00:50 +00:00
Andy Williams 2dd1e59a4c docs: be better at a responsive layout when embedded 2017-11-06 18:43:06 +00:00
Andy Williams 7f48764d17 A more readable layout for doxygen landing page
Also moved out the C++ reference as that should be separate.
(C++ link now on the main /docs page)
2017-11-03 18:17:53 +00:00
Andy Williams 3989f11f11 Update my name in more places 2017-11-02 10:34:05 +00:00
Andy Williams 55b8608728 Update auto API doc styling to match main website
Not perfect, but it's a good start
2017-11-02 10:31:03 +00:00
Thiep Ha 4642fe2f64 doc: enable elementary_examples building
The elementary examples were built before, but not now.
I guess it was missed when we merged elementary to efl source tree.
This enables it and fixes some references.
2017-10-24 15:46:30 +09:00
Hermet Park 1104ff3789 update author(hermet) email. 2017-10-14 23:03:51 +08:00
Jeeyong Um 7a3bed83ee docs: Fix broken edje tutorial (swallow 2) 2017-05-08 16:58:56 +09:00
Marcel Hollerbach 2c16e58613 docs: remove wrong line-height
there was a 'line-height: 0%;' that resulted in unreadable edc code in
the Edje Data Collection reference documentation page.

Thank you Jeremy Suntheimer for spotting that!

fix T5438
2017-04-30 09:49:02 +02:00
Bruno Dilly adb95630ef eina: remove tests, examples and docs for eina_model
Summary:
Since eina_model was dropped some years ago.
Also a few other points where related stuff is just commented out.

Reviewers: iscaro, barbieri

Reviewed By: barbieri

Subscribers: cedric, jpeg

Differential Revision: https://phab.enlightenment.org/D4442
2016-11-30 18:37:34 -02:00
Jee-Yong Um 0f97d45dac fix doxygen warnings
Summary:
fix warnings while generating documents
- end of file while inside a group (eina_util.h)
- missing title after \defgroup
- ignoring title "Ecore_Con_Lib_Group" that does not match old title

Reviewers: Hermet

Subscribers: cedric, jpeg

Differential Revision: https://phab.enlightenment.org/D4420
2016-11-22 11:47:04 +09:00
Stefan Schmidt dbf9d1d4a9 doc: put shot.sh into dist to allow make doc run from tarball
This was missing in the release tarballs before breaking a make doc run from
them.

@fix
2016-08-17 16:43:26 +02:00
Felipe Magno de Almeida 386548ba8d docs: Fix rename from eo_add to efl_add 2016-08-15 15:15:11 -03:00
Amitesh Singh be47c4b9c0 elm: rename Elm.Nstate to Efl.Ui.Nstate 2016-05-10 12:41:03 +05:30
Stefan Schmidt c60b2500c7 docs: add nstate widget to elm widget list index 2016-04-13 17:01:23 +02:00
Stefan Schmidt a1663b1710 docs: make elementary docs available form main doc page
While elm docs have been merged in they never have been accessible from the
main page of our docs. Fix this by including elm_intro.h and referencing it
from the main page. While we are at it rename it to the scheme we used in EFL.

Another missing piece was the index with all widget references. Never brought
over form the elm legacy tree. Putting this in and we are now at least able to
navigate to all elm widget pages.
2016-04-13 17:01:23 +02:00
Stefan Schmidt 74a046fee5 docs: generate nstate widget preview for documentation
The preview example code was already there but not hooked up in our preview
screenshot magic.
2016-04-13 17:01:23 +02:00
Amitesh Singh 4cd002fc7d doc: fix typo in 410cdd1501 2016-04-08 10:14:35 +05:30
Amitesh Singh 410cdd1501 doc: add widget_preview_nstate.c to noinst_PROGRAMS 2016-04-08 09:48:47 +05:30
Amitesh Singh 4cf98237ee doc: add elm nstate preview 2016-04-08 09:20:24 +05:30
Jean-Philippe Andre 81c1b8b530 doc: Remove widget_preview_nstate.c
These is no such file.
Hopefully this will fix make dist.
2016-04-08 11:25:14 +09:00
Amitesh Singh 56ab435998 elm_nstate: introduce nstate widget and inherit check from it
Test Plan:
elementary_test -to "nstate"

@feature

Reviewers: yashu21985, tasn, Hermet, seoz, smohanty, felipealmeida, JackDanielZ, jypark, woohyun, herdsman, raster, cedric, jpeg

Subscribers: saurabhbunty, seoz

Differential Revision: https://phab.enlightenment.org/D3786
2016-04-07 19:05:57 +09:00
Cedric BAIL 128ec4c10a elementary: fix documentation generation. 2016-03-29 15:57:13 -07:00
Cedric BAIL b6a81b6e7b elementary: start bringing back documentation support.
I didn't know preview generation was so slow and done completely serialy.
There is potential improvement here. Still need to kind of merge the
documentation into something readable.
2016-03-28 16:56:31 -07:00
Cedric BAIL b0df722819 elementary: initial compilation of the library only. 2016-03-24 11:23:10 -07:00
Cedric BAIL c2a1c49ab2 elementary: move all legacy files to their expected new location. 2016-03-23 13:24:41 -07:00
Jean-Philippe Andre 021c74d770 Doc: Fix compilation after massive eo_do patch 2016-03-03 20:21:17 +09:00
Hermet Park b757b30bae rename an author. 2015-12-24 09:22:00 +09:00
Stefan Schmidt ce93ef0378 docs: Build documentation also for code that is still in BETA.
Doxygen uses its on preprocessor and this one missed the
EFL_BETA_API_SUPPORT=1 define so none our our BETA api hidden behind
it was build for our documentation.

ref T2541
2015-08-11 14:04:51 +02:00
Yomi c1f9152f10 eio: grammar and typo fixes in docs.
Summary:
Fix a sentence.

Changes:

     src/examples/eio/eio_file_ls.c

Reviewers: cedric

Subscribers: cedric

Differential Revision: https://phab.enlightenment.org/D2894
2015-08-03 11:59:03 +02:00
Jean-Philippe Andre b8a2a9b3c0 Evas filters: Fix make doc, check when EFL is not installed
Thanks @aerodynamik for even giving the proper environment
variable to set :)

Fixes T2614
2015-07-29 20:22:35 +09:00
Jean-Philippe Andre 6f846d89cd Doc: Try to fix build on Ubuntu
The error message was:
/usr/bin/ld: preview_text_filter.o: undefined reference to symbol 'efl_gfx_filter_program_set'
//home/batden/Enlightenment20/efl/src/lib/efl/.libs/libefl.so.1: error adding symbols: DSO missing from command line
2015-06-25 17:50:12 +09:00
Jean-Philippe Andre 0446619355 Evas filters: Mark API as @beta
Until we're happy with it, keep the API as beta.

The EDC support should not change, and the Lua either, but the
API could potentially still change to accomodate for new needs
(vector graphics, anyone?). If we're happy with the current
interface, then we can remove the @beta flags.
2015-06-25 14:36:10 +09:00
Jean-Philippe Andre 84e3dd5c34 Evas filters: Add name to the filters
Deep down internally there was already a name, but no API could
really set it properly.
Here Edje will set the name of the filter based on the part name
or the data item name if relevant.
2015-06-25 14:36:09 +09:00
Jean-Philippe Andre 64fd278c62 Evas filters: EO-ify the filters API
This creates the new interface
 Efl.Gfx.Filter

And the implementation is a mixin (evas_filter_mixin.c):
 Evas.Filter

All the filter rendering code has now been moved to this
new file. TODO: Merge image filtering.
2015-06-25 14:36:09 +09:00
Stefan Schmidt eef094c661 docs: Fix access to main elocation page from front page 2015-05-07 11:15:12 +02:00