summaryrefslogtreecommitdiff
path: root/doc (unfollow)
AgeCommit message (Collapse)Author
2019-09-23Use EFL version for doc tarball, not meson versionRoss Vandegrift
Reviewed-by: Marcel Hollerbach <mail@marcel-hollerbach.de> Differential Revision: https://phab.enlightenment.org/D10070
2019-09-09docs: remove nstate previewMike Blumenkrantz
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
2019-09-09evas_filter_parser: add a workaround for in-tree runsDaniel Kolesa
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.
2019-08-29mono-docs: Update DocFX version and use online symbol lookupXavi Artigas
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).
2019-07-31DocFX: Update README with Deployment instructionsXavi Artigas
The deployment process is currently manual so we better write it down.
2019-07-29docfx: Missing template fileXavi Artigas
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.
2019-07-25mono-docs: More tweaks to the docs blacklistXavi Artigas
2019-07-24build - remove old .mk files that were for autofoo not mesonCarsten Haitzler (Rasterman)
2019-07-24mono-docs: Filter out some more unwanted constructorsXavi Artigas
These should not be used by users, so take them out of the DocFX docs.
2019-07-23mono-docs: Indicate when a class is BETAXavi Artigas
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
2019-07-05docfx: Remove collapsible sectionsXavi Artigas
They didn't render correctly in all cases.
2019-06-20meson - docs - convert - we aren't using it so don't require itCarsten Haitzler (Rasterman)
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... :(
2019-06-18autotools: REMOVAL!Marcel Hollerbach
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
2019-06-18Revert "autotools: REMOVAL!"Marcel Hollerbach
This reverts commit e8c69667b01e2795c1e4ead0536652f935ffa674. git push on a wrong branch, sorry. This will land today, but not now.
2019-06-18autotools: REMOVAL!Marcel Hollerbach
Get your seatbelt fastend! It is happening! AUTOTOOLS IS GONE NOW! All praise to meson! Differential Revision: https://phab.enlightenment.org/D9027
2019-06-11docfx: Only add media files in use to the final docsXavi Artigas
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.
2019-05-16docfx: Use the public repo url for www-contentXavi Artigas
Otherwise, you need to have credentials, etc.
2019-05-03docfx: Filter out *Concrete classes (again)Xavi Artigas
As the C# API settles down, some classes go in and out of public space.
2019-04-30meson: add docsMarcel Hollerbach
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
2019-04-25README, doc : Fix typoJunsuChoi
Reviewers: Hermet, kimcinoo, segfaultxavi Reviewed By: segfaultxavi Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D8710
2019-04-24docs: Fix genlist widget preview generationXavi Artigas
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
2019-04-23mono-docs: Update DocFX blacklistXavi Artigas
NativeInherit sibling classes have been replaced by NativeMethods internal classes.
2019-04-23mono-docs: Use full name in page titleXavi Artigas
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".
2019-04-23mono-docs: Use full name in list of derived classesXavi Artigas
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.
2019-04-15mono-docs: No need no blacklist *Concrete classes anymoreXavi Artigas
2019-04-04docs: Exclude *.NativeStruct from DocFX pagesXavi Artigas
These are for internal use only. Also, make filtering rules a bit more robust.
2019-03-14docfx: Hide *Concrete classes from docsXavi Artigas
Ref T7702
2019-03-01docfx: Exclude *NativeInherit classes from docsXavi Artigas
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-02-11docs: Add custom DocFX templatesXavi Artigas
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-01-28docs: Fix assorted typos in legacy documentationXavi Artigas
Samsung reported a long list of typos in our legacy docs, this fixes them.
2019-01-23eina: refactor eina_value_*_new.Xavi Artigas
Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es> Differential Revision: https://phab.enlightenment.org/D7701
2019-01-23eina: refactor eina_value_*_init.Xavi Artigas
Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es> Differential Revision: https://phab.enlightenment.org/D7700
2019-01-23eina: refactor eina_value_*_get.Xavi Artigas
Reviewed-by: Xavi Artigas <xavierartigas@yahoo.es> Differential Revision: https://phab.enlightenment.org/D7699
2019-01-23eina: add Eina_Value helper that convert efficiently to a target native C type.Cedric BAIL
Reviewed-by: SangHyeon Jade Lee <sh10233.lee@samsung.com> Differential Revision: https://phab.enlightenment.org/D7650
2019-01-07doc: Add support for DocFX (C# doc generator)Xavi Artigas
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
2018-10-02docs: fix the incorrect group name of segment controlBowon Ryu
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
2017-12-15docs: link to the module list in legacy docsAndy Williams
This should improve visibility of stuff that is not specifically mentioned on the home page
2017-12-14docs: Don't ignore eo.legacy.h files in doxygenAndy Williams
2017-12-13docs: Remove the Efl namespace from our legacy docsAndy Williams
This means removing bindings from the output too as they are making the transition over.
2017-12-13docs: Updated legacy API introductionAndy Williams
2017-12-08docs: Attach the google analytics code to our docs pages tooAndy Williams
2017-11-06docs: be better at a responsive layout when embeddedAndy Williams
2017-11-03A more readable layout for doxygen landing pageAndy Williams
Also moved out the C++ reference as that should be separate. (C++ link now on the main /docs page)
2017-11-02Update my name in more placesAndy Williams
2017-11-02Update auto API doc styling to match main websiteAndy Williams
Not perfect, but it's a good start
2017-10-24doc: enable elementary_examples buildingThiep Ha
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-14update author(hermet) email.Hermet Park
2017-05-08docs: Fix broken edje tutorial (swallow 2)Jeeyong Um
2017-04-30docs: remove wrong line-heightMarcel Hollerbach
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
2016-11-30eina: remove tests, examples and docs for eina_modelBruno Dilly
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