[mutter/wip/nielsdg/reenable-gtk-doc: 3/3] wip



commit f612b4cfbd8c21a938a1a5212564244c4518ea27
Author: Niels De Graef <nielsdegraef gmail com>
Date:   Thu Jan 17 17:33:24 2019 +0100

    wip

 doc/meson.build                    | 82 ++++++++++++++++++++++++++++++++++++--
 doc/mutter-docs.sgml               | 36 ++++++++++++++---
 src/backends/meta-cursor-tracker.c |  2 +-
 3 files changed, 109 insertions(+), 11 deletions(-)
---
diff --git a/doc/meson.build b/doc/meson.build
index 5cb4499d5..a8b92b55a 100644
--- a/doc/meson.build
+++ b/doc/meson.build
@@ -1,7 +1,9 @@
+# manpage
 subdir('man')
-subdir('xml')
 
 # Reference manual
+subdir('xml')
+
 version_conf = configuration_data()
 version_conf.set('VERSION', meson.project_version())
 version_xml = configure_file(
@@ -10,11 +12,83 @@ version_xml = configure_file(
   configuration: version_conf
 )
 
+reference_ignored_headers = [
+  'bell.h',
+  'boxes-private.h',
+  'compositor-private.h',
+  'core.h',
+  'constraints.h',
+  'display-private.h',
+  'frame.h',
+  'frames.h',
+  'group-private.h',
+  'keybindings-private.h',
+  'main.h',
+  'meta-backend-private.h',
+  'meta-background-private.h',
+  'meta-barrier-private.h',
+  'meta-dnd-actor-private.h',
+  'meta-dnd-private.h',
+  'meta-feedback-actor-private.h',
+  'meta-gesture-tracker-private.h',
+  'meta-idle-monitor-private.h',
+  'meta-input-mapper-private.h',
+  'meta-input-settings-private.h',
+  'meta-monitor-manager-private.h',
+  'meta-remote-access-controller-private.h',
+  'meta-settings-private.h',
+  'meta-shaped-texture-private.h',
+  'meta-stage-private.h',
+  'meta-wayland-private.h',
+  'meta-window-actor-private.h',
+  'meta-window-group-private.h',
+  'meta-xwayland-private.h',
+  'meta-xwayland-selection-private.h',
+  'theme-private.h',
+  'util-private.h',
+  'window-private.h',
+  'window-x11-private.h',
+  'workspace-private.h',
+  # Test headers
+  'meta-backend-test.h',
+  'meta-monitor-manager-test.h',
+  'meta-wayland-egl-stream.h',
+  'meta-wayland-inhibit-shortcuts.h',
+  'meta-wayland-text-input.h',
+  'meta-xwayland-grab-keyboard.h',
+]
+
+# Make sure we ignore the wayland headers
+if have_wayland
+  foreach proto : wayland_protocols
+    protocol_name = proto[0]
+    protocol_type = proto[1]
+    if protocol_type == 'stable'
+      output_base = protocol_name
+    elif protocol_type == 'private'
+      output_base = protocol_name
+    elif protocol_type == 'third-party'
+      output_base = protocol_name
+    else
+      protocol_version = proto[2]
+      output_base = '@0@-@1@-@2@'.format(protocol_name,
+                                         protocol_type,
+                                         protocol_version)
+    endif
+
+    proto_header = '@0@-server-protocol.h'.format(output_base)
+    reference_ignored_headers += proto_header
+  endforeach
+endif
+
+
 gnome.gtkdoc(meson.project_name(),
   main_sgml: 'mutter-docs.sgml',
-  # gobject_typesfile: 'mutter.types',
-  # scan_args: '--rebuild-types',
-  # c_args: mutter_c_args,
+  scan_args: [
+    '--ignore-headers=' + ' '.join(reference_ignored_headers),
+    '--rebuild-types',
+  ],
   dependencies: [libmutter_dep, mutter_deps ],
   src_dir: include_directories('../src'),
+  install: true,
 )
diff --git a/doc/mutter-docs.sgml b/doc/mutter-docs.sgml
index 61fe48e36..0fefb386e 100644
--- a/doc/mutter-docs.sgml
+++ b/doc/mutter-docs.sgml
@@ -22,8 +22,16 @@
     <xi:include href="xml/meta-clutter-backend-native.xml"/>
     <xi:include href="xml/meta-renderer.xml"/>
     <xi:include href="xml/meta-stage.xml"/>
-    <xi:include href="xml/meta-cursor-tracker.xml"/>
+  </chapter>
+
+  <chapter>
+    <title>Clutter actors</title>
+    <xi:include href="xml/meta-window-actor.xml"/>
+    <xi:include href="xml/meta-window-group.xml"/>
+    <xi:include href="xml/meta-background-actor.xml"/>
+    <xi:include href="xml/meta-background-group.xml"/>
     <xi:include href="xml/meta-surface-actor.xml"/>
+    <xi:include href="xml/meta-shaped-texture.xml"/>
   </chapter>
 
   <chapter>
@@ -32,6 +40,14 @@
     <xi:include href="xml/meta-plugin-manager.xml"/>
   </chapter>
 
+  <chapter>
+    <title>Cursor management</title>
+    <xi:include href="xml/meta-cursor-tracker.xml"/>
+    <xi:include href="xml/meta-cursor.xml"/>
+    <xi:include href="xml/meta-cursor-renderer.xml"/>
+    <xi:include href="xml/meta-pointer-constraint.xml"/>
+  </chapter>
+
   <chapter>
     <title>Monitor management</title>
     <xi:include href="xml/meta-monitor-manager.xml"/>
@@ -46,6 +62,7 @@
     <title>X11</title>
     <xi:include href="xml/meta-backend-x11.xml"/>
     <xi:include href="xml/meta-monitor-manager-xrandr.xml"/>
+    <xi:include href="xml/meta-window-actor-x11.xml"/>
     <xi:include href="xml/meta-surface-actor-x11.xml"/>
   </chapter>
 
@@ -54,6 +71,7 @@
     <xi:include href="xml/meta-backend-native.xml"/>
     <xi:include href="xml/meta-monitor-manager-kms.xml"/>
     <xi:include href="xml/meta-renderer-native.xml"/>
+    <xi:include href="xml/meta-window-actor-wayland.xml"/>
     <xi:include href="xml/meta-surface-actor-wayland.xml"/>
   </chapter>
 
@@ -61,19 +79,25 @@
     <title>Screencast</title>
     <xi:include href="xml/meta-screen-cast.xml"/>
     <xi:include href="xml/meta-screen-cast-session.xml"/>
-    <xi:include href="xml/meta-screen-cast-stream.xml"/>
     <xi:include href="xml/meta-screen-cast-window.xml"/>
+    <xi:include href="xml/meta-screen-cast-stream.xml"/>
+    <xi:include href="xml/meta-screen-cast-window-stream.xml"/>
+    <xi:include href="xml/meta-screen-cast-monitor-stream.xml"/>
+    <xi:include href="xml/meta-screen-cast-stream-src.xml"/>
+    <xi:include href="xml/meta-screen-cast-window-stream-src.xml"/>
+    <xi:include href="xml/meta-screen-cast-monitor-stream-src.xml"/>
   </chapter>
 
   <chapter>
     <title>Remote desktop</title>
     <xi:include href="xml/meta-remote-desktop.xml"/>
+    <xi:include href="xml/meta-dbus-remote-desktop.xml"/>
   </chapter>
 
-  <!-- <chapter id="object-tree"> -->
-  <!--   <title>Object Hierarchy</title> -->
-  <!--   <xi:include href="xml/tree_index.sgml"/> -->
-  <!-- </chapter> -->
+  <chapter id="object-tree">
+    <title>Object Hierarchy</title>
+    <xi:include href="xml/tree_index.sgml"/>
+  </chapter>
   <index id="api-index-full">
     <title>API Index</title>
     <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
diff --git a/src/backends/meta-cursor-tracker.c b/src/backends/meta-cursor-tracker.c
index 1a3501935..2ebff2149 100644
--- a/src/backends/meta-cursor-tracker.c
+++ b/src/backends/meta-cursor-tracker.c
@@ -20,7 +20,7 @@
  */
 
 /**
- * SECTION:cursor-tracker
+ * SECTION:meta-cursor-tracker
  * @title: MetaCursorTracker
  * @short_description: Mutter cursor tracking helper. Originally only
  *                     tracking the cursor image, now more of a "core


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]