summaryrefslogtreecommitdiff
path: root/doc
Commit message (Collapse)AuthorAgeFilesLines
* Fix typos - (Part #2)Elyes HAOUAS2020-07-061-1/+1
| | | | | | | Fix some typos Reviewed-by: Stefan Schmidt <stefan@datenfreihafen.org> Differential Revision: https://phab.enlightenment.org/D12016
* Fix typosElyes HAOUAS2020-06-251-2/+2
| | | | | | | Fix some typos Reviewed-by: Stefan Schmidt <stefan@datenfreihafen.org> Differential Revision: https://phab.enlightenment.org/D12015
* Use extern after EAPIVincent Torri2020-06-101-2/+2
| | | | | Reviewed-by: Stefan Schmidt <stefan@datenfreihafen.org> Differential Revision: https://phab.enlightenment.org/D11961
* doxygen docs: Add tests folder to EXAMPLE_PATHXavi Artigas2020-04-291-1/+2
| | | | | One Emotion example is located in src/tests instead of src/examples so look for examples in that folder too.
* doxygen docs: Fix broken links in main pageXavi Artigas2020-04-291-10/+1
|
* doxygen docs: Add missing Elementary groupXavi Artigas2020-04-271-0/+6
| | | | | | | | Elementary has a main page (elementary_main) like other libs (Ecore, Evas...) but it was missing a doxygen group like the other libs. This group is not terribly useful but it is manually referenced from dozens of places, resulting in lots of warnings. I thought this solution is simpler than removing all the manual references.
* doxygen docs: Fix illegal referencesXavi Artigas2020-03-121-2/+2
| | | | Mostly typos and unescaped # signs
* doxygen docs: Do not parse file Eo.hXavi Artigas2020-03-121-1/+2
| | | | | | Doxygen is used to build Legacy documentation, which is unrelated to Eo.h This fixes quite a few "explicit link request could not be resolved" problems produced by Eo.h which was missing the rest of the Unified Efl headers.
* doxygen docs: remove doubly-defined @examplesXavi Artigas2020-03-091-37/+0
| | | | | | This index page only contains references (@ref), the actual examples (@example) are defined elsewhere and the double definition was throwing warnings.
* doxygen docs: fix multiple defined @section'sXavi Artigas2020-03-031-24/+24
| | | | | | Section names must be globally unique. We rarely reference sections so we don't actually need to use @section and a simple header suffices.
* doxygen: remove deprecated (and unused) configurationXavi Artigas2020-02-281-12/+0
|
* docs: fix to make docs contain proper imagesWonki Kim2019-12-103-19/+3
| | | | | | | | | | | | | | | | 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
* elocation: remove beta libraryStefan Schmidt2019-12-093-228/+0
| | | | | | | | | | | This has never been fully finished or really used. The GeoClue project dbus API moved on to a newer version as well. We still have it marked as beta so we should take the chance and get rid of it to cleanup our tree a little bit. Reviewed-by: Chris Michael <cp.michael@samsung.com> Reviewed-by: Vincent Torri <vincent.torri@gmail.com> Differential Revision: https://phab.enlightenment.org/D10788
* esacpe: remove library from treeStefan Schmidt2019-12-041-6/+0
| | | | | | | | | | | This has not been used for a while and is not even buildable after our switch to meson. It was a niche to start with given that it needed the PS3 OS to run on. I asked for any remaining users at EDD and on the list but heard nothing. Time to remove. Signed-off-by: Stefan Schmidt <s.schmidt@samsung.com> Reviewed-by: Cedric BAIL <cedric.bail@free.fr> Differential Revision: https://phab.enlightenment.org/D10778
* docs: Copy all images to output folderXavi Artigas2019-11-192-1/+10
| | | | | | | | | | | | | | | | | | | | | | | | | | | Summary: Doxygen only copies to the output folder ("html") images included through the \image tag. However, we have several images included using \htmlonly blocks with <img> tags inside, which also need copying. Old makefiles included code to manually copy all pngs, and this patch does the same for meson. I apologize for needing an external script just to run "cp -rf", it looks like meson does not allow wildcards passed to "cp". Files not in the output folder won't be included in the tarball and won't be distributed. Test Plan: Generated documentation now includes images for pages like: `group__Eina__List__Group.html#details` Reviewers: bu5hm4n, lauromoura Reviewed By: bu5hm4n Subscribers: cedric, #reviewers, #committers, myoungwoon Tags: #efl Differential Revision: https://phab.enlightenment.org/D10690
* docs: Typos in ninja doc screen outputXavi Artigas2019-11-181-1/+1
|
* doc: improve colorselector previewMike Blumenkrantz2019-10-031-0/+1
| | | | | | | | | | | | | | | | | | | | | | Summary: this has always been broken, it was just never noticed because colorselector was broken @fix ref T8304 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: segfaultxavi, cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T8304 Differential Revision: https://phab.enlightenment.org/D10278
* meson: pass correct PACKAGE_DATA_DIRMarcel Hollerbach2019-10-021-1/+1
| | | | | | | | | | | | | | | | | | | | Summary: PACKAGE_DATA_DIR was set to the build dir instead to the elementary specific data dir. ref T8304 Reviewers: segfaultxavi Reviewed By: segfaultxavi Subscribers: segfaultxavi, cedric, #reviewers, #committers Tags: #efl Maniphest Tasks: T8304 Differential Revision: https://phab.enlightenment.org/D10275
* docs: enable compression for tar file and avoid file name clashStefan Schmidt2019-10-021-2/+2
| | | | | | | | | | | | | | | | | | | Summary: While the target name implies a compression we only ever put this all into a tar archive so far. Using xz compression as we do with our source archives. Also adjust the file naming to avoid clashing with the source tarballs. We used -doc with autotools before, so this is really more of a catchup. Reviewers: bu5hm4n, segfaultxavi Reviewed By: segfaultxavi Subscribers: ProhtMeyhet, cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D10266
* docs: do not crash gengrid widget previewMarcel Hollerbach2019-10-011-1/+1
| | | | | | | item class is not initialized to 0. This can crash gengrid later on. Reviewed-by: Stefan Schmidt <stefan@datenfreihafen.org> Differential Revision: https://phab.enlightenment.org/D10261
* Use EFL version for doc tarball, not meson versionRoss Vandegrift2019-09-231-2/+2
| | | | | Reviewed-by: Marcel Hollerbach <mail@marcel-hollerbach.de> Differential Revision: https://phab.enlightenment.org/D10070
* docs: remove nstate previewMike Blumenkrantz2019-09-093-15/+0
| | | | | | | | | | | | | | Summary: this widget no longer exists Reviewers: q66 Reviewed By: q66 Subscribers: cedric, #reviewers, #committers Tags: #efl_docs Differential Revision: https://phab.enlightenment.org/D9875
* evas_filter_parser: add a workaround for in-tree runsDaniel Kolesa2019-09-091-1/+5
| | | | | | Without this, the prefix would get pointed to something like /path/to/efl/build/share/evas, which is not a valid path when building. That would cause the docs build to fail.
* mono-docs: Update DocFX version and use online symbol lookupXavi Artigas2019-08-292-1/+2
| | | | | | | Version 2.45 of DocFX seems much much faster than previous 2.40, but could just be a matter of stale caches. Anyway, no breakages have been detected. Using an online symbol resolution server (https://xref.docs.microsoft.com) adds some more links for .NET symbols (and no noticeable slowdown).
* DocFX: Update README with Deployment instructionsXavi Artigas2019-07-311-0/+18
| | | | The deployment process is currently manual so we better write it down.
* docfx: Missing template fileXavi Artigas2019-07-291-0/+15
| | | | | | Otherwise, <remarks> section DIV at the namespace level is always shown, even if empty. And we do not want that now that the DIV has a background color.
* mono-docs: More tweaks to the docs blacklistXavi Artigas2019-07-251-1/+1
|
* build - remove old .mk files that were for autofoo not mesonCarsten Haitzler (Rasterman)2019-07-241-2/+0
|
* mono-docs: Filter out some more unwanted constructorsXavi Artigas2019-07-241-0/+6
| | | | These should not be used by users, so take them out of the DocFX docs.
* mono-docs: Indicate when a class is BETAXavi Artigas2019-07-233-8/+12
| | | | | | | | | | | | | | | | | | Summary: The mono generator adds a <remarks> section to all BETA classes with an explanatory text. These tags are understood by DocFX and Monodevelop. On top of this, this commit modifies the DocFX template to give the Remarks section a more prominent place in the page. Test Plan: Render docs, Beta classes should have a big blue box with a remark about the class being Beta and dangerous. Reviewers: lauromoura, vitor.sousa Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D9381
* docfx: Remove collapsible sectionsXavi Artigas2019-07-052-13/+3
| | | | They didn't render correctly in all cases.
* meson - docs - convert - we aren't using it so don't require itCarsten Haitzler (Rasterman)2019-06-201-1/+2
| | | | | | | | comment it out and move it closer to the block that needs it to make it obvious ... we don't need it. i'm all-in-all not that into the eps conversion thing for docs there too... :(
* autotools: REMOVAL!Marcel Hollerbach2019-06-183-532/+0
| | | | | | | | | | | Get your seatbelt fastend! It is happening! AUTOTOOLS IS GONE NOW! All praise to meson! This time the final version, ci has been adjusted, and now does not try anymore to build a removed buildsystem. However, the scripts in there need cleaning up. Differential Revision: https://phab.enlightenment.org/D9027
* Revert "autotools: REMOVAL!"Marcel Hollerbach2019-06-183-0/+532
| | | | | | This reverts commit e8c69667b01e2795c1e4ead0536652f935ffa674. git push on a wrong branch, sorry. This will land today, but not now.
* autotools: REMOVAL!Marcel Hollerbach2019-06-183-532/+0
| | | | | | | Get your seatbelt fastend! It is happening! AUTOTOOLS IS GONE NOW! All praise to meson! Differential Revision: https://phab.enlightenment.org/D9027
* docfx: Only add media files in use to the final docsXavi Artigas2019-06-111-2/+4
| | | | | | The setup script copied ALL media files, but only the C# tutorials and guides. A lot of space can be saved in the generated _site folder if only the media files relevant to C# are copied.
* docfx: Use the public repo url for www-contentXavi Artigas2019-05-161-1/+1
| | | | Otherwise, you need to have credentials, etc.
* docfx: Filter out *Concrete classes (again)Xavi Artigas2019-05-031-0/+2
| | | | As the C# API settles down, some classes go in and out of public space.
* meson: add docsMarcel Hollerbach2019-04-303-2/+206
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Summary: this here brings one new top level target which is doc. It is not build by default, and does rerun everything on every call. ninja doc will create previews and run the doxygen command. After this is done, a tarbal of the html & man will be created, latex is not added for now, due to the unability to compile the resulting .tex files. Nothing of the documentation is installed for now, if this would be enabled, then every single ninja install would regenerate the whole documentation again, which is quite a lot, and quite a pain (and sometimes crashes) While porting this over, i encountered a problem with *convert* the bug report is linked in the comment. fix T7781 Depends on D8690 Reviewers: zmike, segfaultxavi, cedric Reviewed By: segfaultxavi Subscribers: #reviewers, #committers Tags: #efl Maniphest Tasks: T7781 Differential Revision: https://phab.enlightenment.org/D8561
* README, doc : Fix typoJunsuChoi2019-04-251-1/+1
| | | | | | | | | | | | Reviewers: Hermet, kimcinoo, segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D8710
* docs: Fix genlist widget preview generationXavi Artigas2019-04-245-5/+5
| | | | | | | | | | | | | | | | | | | Summary: This was making "ninja doc" segfault for me. If these function tables are not initialized they contain garbage, which leads to the worst kind of undefined behavior. Test Plan: Apply D8561 and try `ninja doc`. It was dumping core for me, and it does not do it anymore after this patch. Reviewers: bu5hm4n, zmike, cedric Reviewed By: bu5hm4n Subscribers: #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D8697
* mono-docs: Update DocFX blacklistXavi Artigas2019-04-231-1/+1
| | | | NativeInherit sibling classes have been replaced by NativeMethods internal classes.
* mono-docs: Use full name in page titleXavi Artigas2019-04-232-2/+43
| | | | | | | | Reference page titles are now "Class Efl.Ui.Win" instead of "Class Win". And also remove Namespace and Assembly sections. Namespace is redundant since we use fully-qualified names everywhere. Assembly is useless since we build the docs from the source so this entry is always "temp.dll".
* mono-docs: Use full name in list of derived classesXavi Artigas2019-04-232-1/+15
| | | | | | | | | | | | | In the EFL API we have several objects with the same name in different namespaces. Thus it is important to use fully-qualified names throughout the docs, to avoid confusion. However, the default DocFX templates prefer using only simple class names. The default templates have already been modified to use full names everywhere except in the list of derived classes in the hierarchy section, where a DocFX bug was hit. This commit is a workaround to that bug (see https://github.com/dotnet/docfx/issues/3769#issuecomment-485616064 ) so full names (with links) are used in the whole hierarchy.
* mono-docs: No need no blacklist *Concrete classes anymoreXavi Artigas2019-04-151-2/+0
|
* docs: Exclude *.NativeStruct from DocFX pagesXavi Artigas2019-04-041-2/+4
| | | | | These are for internal use only. Also, make filtering rules a bit more robust.
* docfx: Hide *Concrete classes from docsXavi Artigas2019-03-141-0/+2
| | | | Ref T7702
* docfx: Exclude *NativeInherit classes from docsXavi Artigas2019-03-011-0/+2
| | | | | | | 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.
* docs: Add custom DocFX templatesXavi Artigas2019-02-114-1/+1339
| | | | | | | | | | | | | | | | | | | | | | | | | | 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
* docs: Fix assorted typos in legacy documentationXavi Artigas2019-01-284-61/+61
| | | | Samsung reported a long list of typos in our legacy docs, this fixes them.
View Lorry Controller Status