mainnika
/
weston
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
7130 Commits
1 Branch
0 Tags
13 MiB
Tag: Branch: Tree: e57d8ae818
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'e57d8ae818'
${ noResults }
weston/doc/sphinx/toc/libweston/compositor.rst

15 lines
423 B
Raw Normal View History Unescape

build: Add sphinx/breathe support for generating documentation This is adds basic configuration files for doxygen and for breathe, which is a doxygen-to-sphinx bridge that can document C symbols. Breathe is configured with default project 'weston' and implicitly adds :members: and :undoc-members: to breathe configuration options. This allows a shorter way to call breathe directives without the need specify the project and also to display implicitly all the members, documented or not. A 'docs' run_target to force the docs to be re-built has been added. Initially (the first time the build system is ran) the documentation will automatically be built, but later re-builds will require the use of the 'docs' target. This avoid further delays in building weston but in the same time allows the possiblity to update/improve the documentation bits to those who want that. Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
5 years ago
Compositor
==========
:type:`weston_compositor` represents the core object of the library, which
aggregates all the other objects and maintains their state. You can create it
compositor: Destroy the compositor before the log scope Destroying the compositor after destroying the log scope will not print out the messages in the tear down/clean-up phase of the compositor, so add a new tear_down function which allows keeping a valid reference to the compositor. This way we can destroy the compositor before destroying the scope and keep the debug messages. While at it remove the log context destroy part from the clean-up of the compositor and make it stand on its own. Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
5 years ago
using :func:`weston_compositor_create`, while for releasing all the resources
libweston: fold weston_compositor_tear_down() into weston_compositor_destroy() The only reason why we have both weston_compositor_tear_down() and weston_compositor_destroy() is that the only we had to destroy the log context was keeping weston_compositor alive and calling weston_log_ctx_compositor_destroy(). After commit "weston-log: replace weston_log_ctx_compositor_destroy() by weston_log_ctx_destroy()", it's not necessary to keep a zombie weston_compositor just to be able to call weston_log_ctx_compositor_destroy(). Fold weston_compositor_tear_down() into weston_compositor_destroy(), as this split is useless now. Signed-off-by: Leandro Ribeiro <leandrohr@riseup.net>
5 years ago
associated with it and then destroy it, you should use
:func:`weston_compositor_destroy`.
doc/sphinx: Add 'weston_compositor', 'weston_output' and 'weston_head' API Demonstrates how to call/use the 'doxygen*' breathe directives. Make use of previous patches that tag symbols using 'ingroup' doxygen command. Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
5 years ago
Compositor API
--------------
.. doxygengroup:: compositor
:content-only: