system/weston
system/weston
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/wayland/weston synced 2024-07-05 17:29:06 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc/sphinx: Add doxygen aliases for easier rst embedding

Browse Source 
With these aliases we can use rST directives inside comment blocks. This
adds also a doxygen command '\rststar' where ignores the asterisk --
typical to multi-line comment blocks.

While at it, add a simple example on how to use them.

Signed-off-by: Marius Vlad <marius.vlad@collabora.com>
This commit is contained in:
Marius Vlad 2019-06-06 23:10:49 +03:00 committed by Pekka Paalanen
parent 3d620bc04d
commit ae26341037
2 changed files with 16 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/sphinx/doxygen.ini.in
View File

@ -238,7 +238,10 @@ TAB_SIZE = 8
# "Side Effects:". You can put \n's in the value part of an alias to insert
# newlines.
ALIASES =
ALIASES = "rst=\verbatim embed:rst"
ALIASES += "endrst=\endverbatim"
ALIASES += "rststar=\verbatim embed:rst:leading-asterisk"
ALIASES += "endrststar=\endverbatim"
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"

20
include/libweston/libweston.h
View File

@ -955,15 +955,19 @@ enum weston_capability {
* likely want to subclass this in order to handle backend specific
* data.
*
* NOTE: Alternate designs were proposed (Feb 2016) for using opaque
* structures[1] and for section+key/value getter/setters[2]. The rationale
* for selecting the transparent structure design is based on several
* assumptions[3] which may require re-evaluating the design choice if they
* fail to hold.
* \rststar
* .. note:
*
* 1: https://lists.freedesktop.org/archives/wayland-devel/2016-February/026989.html
* 2: https://lists.freedesktop.org/archives/wayland-devel/2016-February/026929.html
* 3: https://lists.freedesktop.org/archives/wayland-devel/2016-February/027228.html
* Alternate designs were proposed (Feb 2016) for using opaque structures[1]
* and for section+key/value getter/setters[2]. The rationale for selecting
* the transparent structure design is based on several assumptions[3] which
* may require re-evaluating the design choice if they fail to hold.
*
* 1. https://lists.freedesktop.org/archives/wayland-devel/2016-February/026989.html
* 2. https://lists.freedesktop.org/archives/wayland-devel/2016-February/026929.html
* 3. https://lists.freedesktop.org/archives/wayland-devel/2016-February/027228.html
*
* \endrststar
*/
struct weston_backend_config {
/** Major version for the backend-specific config struct