Add gtk-doc documentation
- Aug 22, 2022
-
-
Detlev Casanova authoredSigned-off-by:
Detlev Casanova <detlev.casanova@collabora.com> -
Detlev Casanova authored
The auto-generated sgml file has a role attribute for the api-index entries. gtkdoc-mkhtml does not understand the role attribute and skips the generation of the api-index HTML files, which creates invalid links in the final documentation. Signed-off-by:Detlev Casanova <detlev.casanova@collabora.com> -
Detlev Casanova authored
Only recent versions of devhelp support loading documentation from the `/usr/share/doc` folder. To ensure loading the documentation in devhelp, move it to `/usr/share/gtk-doc/html/` Signed-off-by:Detlev Casanova <detlev.casanova@collabora.com>
-
- Aug 11, 2022
-
-
Detlev Casanova authored
Signed-off-by:Detlev Casanova <detlev.casanova@collabora.com> -
Detlev Casanova authored
This is necessary to allow the gtk-doc check to not fail. The gtk-doc check is run at the check step to verify that everything is documented. This is useful to avoid forgetting documentation when modifying the code. Signed-off-by:Detlev Casanova <detlev.casanova@collabora.com> -
Detlev Casanova authored
The documentation is parsed from the source files and converted to HTML by gtk-doc. Signed-off-by:Detlev Casanova <detlev.casanova@collabora.com> -
Detlev Casanova authored
gtk-doc won't let multiple docbook files be added to the main sgml file. Merge them for simpler use. Signed-off-by:Detlev Casanova <detlev.casanova@collabora.com> -
Detlev Casanova authored
This is necessary to allow the gtk-doc check to not fail. The gtk-doc check is run at the check step to verify that everything is documented. This is useful to avoid forgetting documentation when modifying the code. Signed-off-by:Detlev Casanova <detlev.casanova@collabora.com>
-
- Aug 10, 2022
-
-
Detlev Casanova authored
The documentation is parsed from the source files and converted to HTML by gtk-doc. Signed-off-by:Detlev Casanova <detlev.casanova@collabora.com>
-