Codebase list xapp / 47d64df
Add support for building gtk-doc Also add annotations for XAppMonitorBlanker JosephMcc 7 years ago
9 changed file(s) with 158 addition(s) and 1 deletion(s). Raw diff Collapse all Expand all
+1
-1
Makefile.am less more
0 SUBDIRS = libxapp po schemas files
0 SUBDIRS = libxapp po schemas files docs
11
22 ACLOCAL_AMFLAGS = -I m4 ${ACLOCAL_FLAGS}
33
+9
-0
configure.ac less more
2626
2727 AC_PROG_CC
2828 PKG_PROG_PKG_CONFIG
29
30 GTK_DOC_CHECK([1.0],[--flavour=no-tmpl])
2931
3032 GNOME_COMPILE_WARNINGS([maximum])
3133 GNOME_MAINTAINER_MODE_DEFINES
6567 AC_SUBST(XLIB_CFLAGS)
6668 AC_SUBST(XLIB_LIBS)
6769
70 AC_ARG_ENABLE([gtk-doc],
71 AC_HELP_STRING([--enable-gtk-doc],
72 [use gtk-doc to build documentation [[default=yes]]]),,
73 enable_gtk_doc=yes)
74
6875 dnl pkg-config dependency checks
6976
7077 PKG_CHECK_MODULES(XAPP, gdk-pixbuf-2.0 >= $GDK_PIXBUF_REQUIRED
8996
9097 AC_CONFIG_FILES([
9198 Makefile
99 docs/Makefile
100 docs/reference/Makefile
92101 libxapp/Makefile
93102 libxapp/xapp.pc
94103 libxapp/xapp-uninstalled.pc
+7
-0
debian/control less more
6868 Depends: libxapp1 (= ${binary:Version}), ${misc:Depends}
6969 Description: XApp library - debug symbols
7070 This package contains the symbols files needed to debug the XApp library.
71
72 Package: xapps-doc
73 Section: doc
74 Architecture: all
75 Depends: ${misc:Depends}, devhelp
76 Description: Libxapp documentation
77 This package contains documentation for xapp library
+6
-0
debian/rules less more
1010 override_dh_gnome_clean:
1111 dh_gnome_clean --no-control
1212
13 override_dh_autoreconf:
14 dh_autoreconf --as-needed ./autogen.sh
15
16 override_dh_auto_configure:
17 dh_auto_configure -- --enable-gtk-doc
18
1319 override_dh_strip:
1420 dh_strip --dbg-package=libxapp-dbg
1521
+1
-0
debian/xapps-doc.install less more
0 /usr/share/gtk-doc⏎
+3
-0
docs/Makefile.am less more
0 SUBDIRS = reference
1
2 -include $(top_srcdir)/git.mk⏎
+51
-0
docs/reference/Makefile.am less more
0 ## Process this file with automake to produce Makefile.in
1
2 # see /gtk-doc/examples/Makefile.am
3
4 # We require automake 1.6 at least.
5 AUTOMAKE_OPTIONS = 1.6
6
7 # The name of the module, e.g. 'glib'.
8 DOC_MODULE = xapp
9
10 # The top-level XML file (SGML in the past).
11 DOC_MAIN_SGML_FILE = xapp-docs.xml
12
13 # The directory containing the source code. Relative to $(srcdir).
14 DOC_SOURCE_DIR = $(top_srcdir)/libxapp
15
16 # Extra options to supply to gtkdoc-scan.
17 # e.g. SCAN_OPTIONS = --deprecated-guards="GTK_DISABLE_DEPRECATED"
18 SCAN_OPTIONS = --rebuild-types
19
20 # Extra options to supply to gtkdoc-mkdb.
21 MKDB_OPTIONS = --xml-mode --output-format=xml
22
23 # Used for dependencies. The docs will be rebuilt if any of these change.
24 HFILE_GLOB = $(top_srcdir)/libxapp/*.h
25 CFILE_GLOB = $(top_srcdir)/libxapp/*.c
26
27 # Header files to ignore when scanning (These are internal to xed).
28 IGNORE_HFILES =
29
30 # Images to copy into HTML directory.
31 HTML_IMAGES =
32
33 # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
34 content_files =
35
36 # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
37 # Only needed if you are using gtkdoc-scangobj to dynamically query widget
38 # signals and properties.
39 GTKDOC_CFLAGS =
40
41 GTKDOC_LIBS = \
42 $(top_builddir)/libxapp/libxapp.la \
43 $(XAPP_LIBS)
44
45 MAINTAINERCLEANFILES = xapp.types
46
47 # This includes the standard gtk-doc make rules, copied by gtkdocize.
48 include $(top_srcdir)/gtk-doc.make
49
50 -include $(top_srcdir)/git.mk⏎
+36
-0
docs/reference/xapp-docs.xml less more
0 <?xml version="1.0"?>
1 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
2 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"
3 [
4 <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'">
5 <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">
6 %gtkdocentities;
7 ]>
8 <book id="index">
9 <bookinfo>
10 <title>Xapp Reference Manual</title>
11 <releaseinfo>
12 for &package_string;.
13 </releaseinfo>
14 </bookinfo>
15
16 <chapter>
17 <title>API reference</title>
18 <xi:include href="xml/xapp-kbd-layout-controller.xml"/>
19 <xi:include href="xml/xapp-monitor-blanker.xml"/>
20
21 </chapter>
22 <chapter id="object-tree">
23 <title>Object Hierarchy</title>
24 <xi:include href="xml/tree_index.sgml"/>
25 </chapter>
26 <index id="api-index-full">
27 <title>API Index</title>
28 <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>
29 </index>
30 <index id="deprecated-api-index" role="deprecated">
31 <title>Index of deprecated API</title>
32 <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>
33 </index>
34 <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
35 </book>
+44
-0
libxapp/xapp-monitor-blanker.c less more
1010 #include <glib/gi18n-lib.h>
1111
1212 #include "xapp-monitor-blanker.h"
13
14 /**
15 * SECTION:xapp-monitor-blanker
16 * @Short_description: Blank and unblank unused monitors
17 * @Title: XAppMonitorBlanker
18 *
19 * The XAppMonitorBlanker widget that creates one or more
20 * POPUP type GtkWindows that are used to blank unused
21 * monitors in multiple monitor setups.
22 */
1323
1424 struct _XAppMonitorBlankerPrivate
1525 {
5666 g_type_class_add_private (gobject_class, sizeof (XAppMonitorBlankerPrivate));
5767 }
5868
69 /**
70 * xapp_monitor_blanker_new:
71 *
72 * Creates a new #XAppMonitorBlanker.
73 *
74 * Returns: a newly created #XAppMonitorBlanker
75 */
76
5977 XAppMonitorBlanker *
6078 xapp_monitor_blanker_new (void)
6179 {
91109 return window;
92110 }
93111
112 /**
113 * xapp_monitor_blanker_blank_other_monitors:
114 * @self: a #XAppMonitorBlanker
115 * @window: a #GtkWindow
116 *
117 * Blanks monitors besides the one where the @window is.
118 */
119
94120 void
95121 xapp_monitor_blanker_blank_other_monitors (XAppMonitorBlanker *self,
96122 GtkWindow *window)
125151 self->priv->blanked = TRUE;
126152 }
127153
154 /**
155 * xapp_monitor_blanker_unblank_monitors:
156 * @self: a #XAppMonitorBlanker
157 *
158 * Unblanks monitors that were blanked by
159 * xapp_monitor_blanker_blank_other_monitors();
160 */
161
128162 void
129163 xapp_monitor_blanker_unblank_monitors (XAppMonitorBlanker *self)
130164 {
147181 self->priv->blanked = FALSE;
148182 }
149183
184 /**
185 * xapp_monitor_blanker_are_monitors_blanked:
186 * @self: a #XAppMonitorBlanker
187 *
188 * Returns whether monitors are currently blanked.
189 * See xapp_monitor_blanker_blank_other_monitors().
190 *
191 * Returns: %TRUE if monitors are blanked.
192 */
193
150194 gboolean
151195 xapp_monitor_blanker_are_monitors_blanked (XAppMonitorBlanker *self)
152196 {