KApiDox
Description of the metainfo.yml syntax
The name is the folder name. The fancyname is the project name used in CMake.
Each group must contain one and only one library with the group_info
block. If more are defined, the behavior is unknown.
Be sure to to set public_lib
to true, or the library will be ignored. Most of the other keys are optionals. See below for a simplier example.
All possible keys.
2 fancyname: The FancyName # optional, else replaced by the `project()` value of the `CMakeLists.txt`
8 logo: relative/path/to/logo.png # Used only if not part of a group, defaults to logo.png if present
26 license: LGPL-2.1-only OR LGPL-3.0-only # optional, SPDX expression that states outbound license of library
30 mailinglist: mylib-dev # optional, overwrite group field, if both not defined, default to kde-devel
54 description: Tier 1 frameworks depend only on Qt (and possibly a small number of other third-party libraries), so can easily be used by an Qt-based project.
Simple example 1
In this case, the library is not part of a group, and the source is in src
. If there is no logo, a default one is used.
Simple example 2
In this case, the libraries X and Y are part of the same group XY
, and the source is in src
.
libX
libY
This file is part of the KDE documentation.
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Apr 20 2021 22:53:44 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
Documentation copyright © 1996-2021 The KDE developers.
Generated on Tue Apr 20 2021 22:53:44 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.