Commit Graph

208 Commits

Author SHA1 Message Date
Andy Williams 46fbbef13a docs: Group our API landing page by namespace 2017-12-22 17:30:52 +00:00
Andy Williams 99f9789902 docs: Output correct signature for class method first parameter 2017-12-20 15:00:18 +00:00
Andy Williams 4202dca002 docs: Note class scope for method listings 2017-12-20 14:33:54 +00:00
Andy Williams 2a0e077416 docs: Correct sig for eolian lua calls 2017-12-20 14:31:56 +00:00
Daniel Kolesa 18e18ca74c eolian: remove remaining global state (+ modify APIs accordingly) 2017-12-15 17:11:11 +01:00
Daniel Kolesa 011bbfdc93 Revert "docs: remove resolved FIXMEs"
This reverts commit b8b183bfcb.

The FIXMEs are not resolved, just worked around.
2017-12-14 15:53:27 +01:00
Andy Williams ed307bda40 docs: Move inherited items to tables
Lots of refactoring required to make sense of the generator
2017-12-13 18:10:57 +00:00
Andy Williams f8889239b6 docs: Sort the data before rendering
Better on memory and saves on intermediate buffers
2017-12-13 18:10:57 +00:00
Andy Williams e747e1ec2a docs: Don't display any inheritance info if we do not inherit 2017-12-13 10:08:21 +00:00
Andy Williams d5d130085a docs: Remove the somewhat unreadable graphs from web output 2017-12-13 10:08:21 +00:00
Andy Williams b3f575fd43 docs: Fix description position for property pages 2017-12-12 17:52:46 +00:00
Andy Williams 92c9ec33e7 docs: Save a few kB by stripping spaces from newlines 2017-12-12 16:54:15 +00:00
Andy Williams 86b37828d9 docs: Group our inherited members and events by class
That's the closest class that extends, not the originating class.
Also realised that "inherited from" is not needed this deep,
so keep it succinct.
2017-12-12 16:35:20 +00:00
Andy Williams 33a4050048 docs: Keep description at the top and code snippets at the bottom 2017-12-12 16:35:20 +00:00
Andy Williams 7fa99824a0 docs: Reverse the described relationships in our API docs site
This means that "<ns><method> [Overridden from <parentns>]" is
preferred to "<parentns><method> [Overridden in <ns>]".
This also means that "Overriden here" becomes
"Overridden from <parentns>"
2017-12-12 16:35:20 +00:00
Andy Williams dc13197895 docs: Strip duplicate inherited events 2017-12-11 22:30:25 +00:00
Andy Williams 5ce17ae60a docs: We no longer have class type in URLs 2017-12-11 17:25:50 +00:00
Andy Williams 87900f49b0 docs: Include Eina in the allowable Unified API namespaces 2017-12-11 17:25:28 +00:00
Andy Williams 6757fd504e docs: Remove the details for inherited members and events
Also fix the headings so "Members" and "Events" is always visible
as it makes for a better Table of Contents.

Layout could be improved, just playing with the minimal
information presentation for now.
2017-12-11 16:50:47 +00:00
Andy Williams 5b6d3bb538 docs: Compact and lay out the header of API docs
Add an inheritance summary (following the primary class heirarchy).
Move the full heirarchy to a folded section.
Put the description at the top where it belongs.
2017-12-11 16:50:47 +00:00
Andy Williams 0c744c6c1c docs: Filter the public API to just Efl.* 2017-12-11 16:50:47 +00:00
Andy Williams b8b183bfcb docs: remove resolved FIXMEs 2017-12-08 18:23:06 +00:00
Andy Williams 42368d16e8 docs: Complete removal of object type from API URLs
We still have the subtypes for now, that is less
likely to cause user confusion as they are unlikely to browse
method names in the address bar.
2017-12-08 18:16:51 +00:00
Andy Williams 3cccf56795 docs: Strip class type from URLs, avoid user confusion 2017-12-08 16:39:05 +00:00
Andy Williams da29942989 docs: Don't confuse with dokuwiki user namespace 2017-12-08 16:39:05 +00:00
Andy Williams 8093546521 docs: Use more meaningful titles for when we only inherit 2017-12-08 16:39:05 +00:00
Daniel Kolesa 324e3dedea docs: always pass eos unit in gendoc 2017-12-08 13:18:38 +01:00
Andy Williams dc821546ad gendoc: Allow script to be run from other directories 2017-12-08 11:00:50 +00:00
Andy Williams 6cdcaf846b gendoc: Update to latest eolian syntax 2017-12-08 11:00:50 +00:00
Daniel Kolesa 8a1f93f698 eolian: pass state where necessary
This modifies the API so that global state removal is made
possible. It's still used internally for now but externally
the state is contained.
2017-12-05 16:41:42 +01:00
Daniel Kolesa 40214e16c7 elua: correctly wrap gettext funcs
Now, we cannot directly register funcs defined by a different
signature than the lua standard (int (*)(lua_State *)) so we
have to correctly wrap those with proper conversions etc.
2017-11-24 10:55:46 +01:00
Andy Williams 93995b0093 docgen: Correct title plugin usage 2017-11-22 09:59:52 +00:00
Daniel Kolesa a5d77546a8 docgen: better space out includes 2017-11-02 14:36:00 +01:00
Daniel Kolesa e46d6d41d2 docgen: fix generation and generate notes correctly 2017-11-02 14:29:20 +01:00
Andy Williams a7bb770e69 Generate docs into /develop/api/*
Also move root doc to start.txt for a better entry point
2017-10-25 18:17:25 +01:00
Daniel Kolesa 4f8a9b50f4 eolian: make inherits_get return a list of classes, not strings
Most of the time you need to retrieve the class from the string
anyway, so remove this relic of old Eolian and gain some small
performance benefits and extra convenience.

Subtly breaks API but everything should be updated.
2017-10-25 16:25:41 +02:00
Andy Williams 549f167002 Docs location moved 2017-10-21 16:39:07 +01:00
Daniel Kolesa c48cde4aed docs: move write_include out of the writer backend
This is a large chunk shared between backends.
2017-10-20 14:29:04 +02:00
Daniel Kolesa dbf48bf9f5 docs: prepare for markdown gendoc backend 2017-10-20 14:17:10 +02:00
Daniel Kolesa 1577c576e6 eolian: remove static_array and terminated_array
These types are of questionable value and the API was not entirely
thought out - remove for now, and if a legitimate use is found
later, they may be readded (with a better API), but typically it
seems best to redesign the bad APIs around safe containers...
2017-09-22 18:01:15 +02:00
Daniel Kolesa 4bae2a7385 eolian: merge REGULAR and COMPLEX types 2017-09-22 17:46:02 +02:00
Daniel Kolesa 60d6aeeb2d elua: update for new eolian ownership system 2017-09-15 17:52:38 +02:00
Daniel Kolesa e55ab81835 eolian: always implicitly validate database and remove its API 2017-09-13 23:58:47 +02:00
Daniel Kolesa 8b5d555cf5 elua: update eolian bindings and make docgen work again 2017-08-30 19:46:41 +02:00
Daniel Kolesa 10fd3c32e8 eolian: remove c_only
Unused and of questionable value.
2017-08-30 19:46:41 +02:00
Daniel Kolesa e38418dd9d elua: update eolian bindings with c type serialization change 2017-08-10 12:19:59 +02:00
Daniel Kolesa a72cac2223 docgen: stub out units so the generator works again 2017-05-30 17:15:54 +02:00
Daniel Kolesa bf2ac6c937 elua: update for unit api usage 2017-05-30 17:15:53 +02:00
Daniel Kolesa 7da0549970 eolian: make eolian_file_parse return unit 2017-05-30 17:15:53 +02:00
Daniel Kolesa bf7b3e5dfc docgen: include C usage snippet on event pages 2017-03-07 17:15:24 +01:00