gplugin/gplugin

Add the basic structure to the docs
feature/gtk-doc
2017-07-31, Gary Kramlich
30f9ec0c2972
Parents 21e520cc55ac
Children 6fde5782dcac
Add the basic structure to the docs
3 files changed, 35 insertions(+), 5 deletions(-)
  • +1 -1
    gplugin/gplugin-plugin-info.c
  • +29 -3
    gplugin/reference/gplugin-docs.xml
  • +5 -1
    gplugin/reference/meson.build
    • --- a/gplugin/gplugin-plugin-info.c Mon Jul 31 20:56:39 2017 -0500
    +++ b/gplugin/gplugin-plugin-info.c Mon Jul 31 21:45:35 2017 -0500
    @@ -468,7 +468,7 @@
    * The id of the plugin.
    *
    * While not required, the recommended convention is to use the following
    - * format: <application or library>/<name of the plugin>.
    + * format: &lt;application or library&gt;/&lt;name of the plugin&gt;.
    *
    * For example, the python loader in GPlugin has an id of
    * "gplugin/python-plugin-loader".
    --- a/gplugin/reference/gplugin-docs.xml Mon Jul 31 20:56:39 2017 -0500
    +++ b/gplugin/reference/gplugin-docs.xml Mon Jul 31 21:45:35 2017 -0500
    @@ -11,15 +11,41 @@
    <abstract>
    <title>GPlugin &version;</title>
    <para>
    - GPlugin is a GObject based library that implements a reusable plugin system
    -that supports loading plugins in other languages via loaders. GPlugin also
    -implements dependencies among the plugins.
    + GPlugin is a GObject based library that implements a reusable plugin system that
    + supports loading plugins in other languages
    + via loaders. GPlugin also implements
    + dependencies among the plugins.
    </para>
    </abstract>
    </bookinfo>
    + <part id="object-hierarchy">
    + <title>Object Hierarchy</title>
    +
    + <xi:include href="xml/tree_index.sgml"/>
    + </part>
    +
    <part id="API">
    <title>API Reference</title>
    +
    + <chapter id="coreapi">
    + <title>Core API</title>
    + <xi:include href="xml/gplugin-core.xml"/>
    + <xi:include href="xml/gplugin-loader.xml"/>
    + <xi:include href="xml/gplugin-manager.xml"/>
    + <xi:include href="xml/gplugin-options.xml"/>
    + <xi:include href="xml/gplugin-plugin-info.xml"/>
    + <xi:include href="xml/gplugin-plugin.xml"/>
    + <xi:include href="xml/gplugin-version.xml"/>
    + </chapter>
    +
    + <chapter id="nativeapi">
    + <title>Native API</title>
    +
    + <xi:include href="xml/gplugin-native.xml"/>
    + <xi:include href="xml/gplugin-native-plugin.xml"/>
    + <xi:include href="xml/gplugin-native-loader.xml"/>
    + </chapter>
    </part>
    <index id="api-index-full">
    --- a/gplugin/reference/meson.build Mon Jul 31 20:56:39 2017 -0500
    +++ b/gplugin/reference/meson.build Mon Jul 31 21:45:35 2017 -0500
    @@ -1,7 +1,11 @@
    DOC_MODULE = 'gplugin'
    # Header files or dirs to ignore when scanning. Use base file/dir names
    -ignore_hfiles = ['dynamic-test.h']
    +ignore_hfiles = [
    + 'gplugin-private.h',
    + 'gplugin-native-private.h',
    + 'dynamic-test.h',
    +]
    ignore_hfiles += GPLUGIN_PRIVATE_HEADERS
    # Extra options to supply to gtkdoc-scan.