diff options
author | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 15:07:22 +0000 |
---|---|---|
committer | Daniel Baumann <daniel.baumann@progress-linux.org> | 2024-04-27 15:07:22 +0000 |
commit | f9d480cfe50ca1d7a0f0b5a2b8bb9932962bfbe7 (patch) | |
tree | ce9e8db2d4e8799780fa72ae8f1953039373e2ee /docs/reference | |
parent | Initial commit. (diff) | |
download | gnome-shell-f9d480cfe50ca1d7a0f0b5a2b8bb9932962bfbe7.tar.xz gnome-shell-f9d480cfe50ca1d7a0f0b5a2b8bb9932962bfbe7.zip |
Adding upstream version 3.38.6.upstream/3.38.6upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to '')
-rw-r--r-- | docs/reference/meson.build | 5 | ||||
-rw-r--r-- | docs/reference/shell/meson.build | 51 | ||||
-rw-r--r-- | docs/reference/shell/shell-docs.sgml | 69 | ||||
-rw-r--r-- | docs/reference/shell/version.xml.in | 1 | ||||
-rw-r--r-- | docs/reference/st/meson.build | 23 | ||||
-rw-r--r-- | docs/reference/st/st-docs.sgml | 69 | ||||
-rw-r--r-- | docs/reference/st/version.xml.in | 1 |
7 files changed, 219 insertions, 0 deletions
diff --git a/docs/reference/meson.build b/docs/reference/meson.build new file mode 100644 index 0000000..77d9fde --- /dev/null +++ b/docs/reference/meson.build @@ -0,0 +1,5 @@ +version_conf = configuration_data() +version_conf.set('VERSION', meson.project_version()) + +subdir('shell') +subdir('st') diff --git a/docs/reference/shell/meson.build b/docs/reference/shell/meson.build new file mode 100644 index 0000000..5936ea3 --- /dev/null +++ b/docs/reference/shell/meson.build @@ -0,0 +1,51 @@ +private_headers = [ + 'gactionmuxer.h', + 'gactionobservable.h', + 'gactionobserver.h', + 'shell-network-agent.h', +] + +exclude_directories = [ + 'calendar-server', + 'hotplug-sniffer', + 'st', + 'tray' +] + +ifaces = [ + ['org.gnome.Shell.Screenshot', 'org.gnome.Shell.Screenshot.xml'], + ['org.gnome.ShellSearchProvider', 'org.gnome.Shell.SearchProvider.xml'], + ['org.gnome.ShellSearchProvider2', 'org.gnome.Shell.SearchProvider2.xml'] +] +foreach iface : ifaces + custom_target(iface[0] + ' docs', + input: '../../../data/dbus-interfaces/@0@.xml'.format(iface[0]), + output: 'doc-gen-' + iface[1], + command: [ + 'gdbus-codegen', + '--interface-prefix=@0@.'.format(iface[0]), + '--generate-docbook', 'doc-gen', + '--output-directory', '@OUTDIR@', + '@INPUT@' + ], + build_by_default: true + ) +endforeach + +configure_file( + input: 'version.xml.in', + output: 'version.xml', + configuration: version_conf +) + +gnome.gtkdoc('shell', + main_sgml: 'shell-docs.sgml', + src_dir: [ + join_paths(meson.source_root(), 'src'), + join_paths(meson.build_root(), 'src') + ], + scan_args: [ + '--ignore-headers=' + ' '.join(private_headers + exclude_directories) + ], + install: true +) diff --git a/docs/reference/shell/shell-docs.sgml b/docs/reference/shell/shell-docs.sgml new file mode 100644 index 0000000..ebfd221 --- /dev/null +++ b/docs/reference/shell/shell-docs.sgml @@ -0,0 +1,69 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> + <!ENTITY version SYSTEM "version.xml"> +]> +<book id="index"> + <bookinfo> + <title>Shell Reference Manual</title> + <releaseinfo> + for Shell &version;. + <!--The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://[SERVER]/shell/index.html">http://[SERVER]/shell/</ulink>.--> + </releaseinfo> + </bookinfo> + + <chapter> + <title>Actors</title> + <xi:include href="xml/shell-stack.xml"/> + </chapter> + <chapter> + <title>Application tracking</title> + <xi:include href="xml/shell-app.xml"/> + <xi:include href="xml/shell-app-usage.xml"/> + <xi:include href="xml/shell-window-tracker.xml"/> + </chapter> + <chapter> + <title>Search</title> + <xi:include href="xml/shell-app-system.xml"/> + </chapter> + <chapter> + <title>Tray Icons</title> + <xi:include href="xml/shell-embedded-window.xml"/> + <xi:include href="xml/shell-gtk-embed.xml"/> + <xi:include href="xml/shell-tray-icon.xml"/> + <xi:include href="xml/shell-tray-manager.xml"/> + </chapter> + <chapter> + <title>Integration helpers and utilities</title> + <xi:include href="doc-gen-org.gnome.Shell.SearchProvider.xml"/> + <xi:include href="doc-gen-org.gnome.Shell.SearchProvider2.xml"/> + <xi:include href="xml/shell-global.xml"/> + <xi:include href="xml/shell-action-modes.xml"/> + <xi:include href="xml/shell-wm.xml"/> + <xi:include href="xml/shell-util.xml"/> + <xi:include href="xml/shell-mount-operation.xml"/> + <xi:include href="xml/shell-polkit-authentication-agent.xml"/> + </chapter> + <!-- FIXME: + Not generated at the moment, find out whether to blame gtk-doc or meson + --> + <!-- + <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> + </index> + <index id="deprecated-api-index" role="deprecated"> + <title>Index of deprecated API</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/docs/reference/shell/version.xml.in b/docs/reference/shell/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/docs/reference/shell/version.xml.in @@ -0,0 +1 @@ +@VERSION@ diff --git a/docs/reference/st/meson.build b/docs/reference/st/meson.build new file mode 100644 index 0000000..3e9e9ab --- /dev/null +++ b/docs/reference/st/meson.build @@ -0,0 +1,23 @@ +private_headers = [ + 'st-private.h', + 'st-theme-node-private.h' +] + +configure_file( + input: 'version.xml.in', + output: 'version.xml', + configuration: version_conf +) + +gnome.gtkdoc('st', + main_sgml: 'st-docs.sgml', + src_dir: [ + join_paths(meson.source_root(), 'src', 'st'), + join_paths(meson.build_root(), 'src', 'st') + ], + scan_args: [ + '--ignore-headers=' + ' '.join(private_headers), + '--rebuild-sections' + ], + install: true +) diff --git a/docs/reference/st/st-docs.sgml b/docs/reference/st/st-docs.sgml new file mode 100644 index 0000000..be4cec2 --- /dev/null +++ b/docs/reference/st/st-docs.sgml @@ -0,0 +1,69 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> + <!ENTITY version SYSTEM "version.xml"> +]> +<book id="index"> + <bookinfo> + <title>St Reference Manual</title> + <releaseinfo> + for St &version;. + <!--The latest version of this documentation can be found on-line at + <ulink role="online-location" url="http://[SERVER]/st/index.html">http://[SERVER]/st/</ulink>.--> + </releaseinfo> + </bookinfo> + + <part> + <title>API reference</title> + <chapter id="base"> + <title>Abstract classes and Interfaces</title> + <xi:include href="xml/st-widget.xml"/> + <xi:include href="xml/st-widget-accessible.xml"/> + <xi:include href="xml/st-scrollable.xml"/> + </chapter> + <chapter id="widgets"> + <title>Widgets</title> + <xi:include href="xml/st-button.xml"/> + <xi:include href="xml/st-drawing-area.xml"/> + <xi:include href="xml/st-entry.xml"/> + <xi:include href="xml/st-icon.xml"/> + <xi:include href="xml/st-label.xml"/> + </chapter> + <chapter id="containers"> + <title>Containers</title> + <xi:include href="xml/st-bin.xml"/> + <xi:include href="xml/st-box-layout.xml"/> + <xi:include href="xml/st-scroll-view.xml"/> + </chapter> + + <chapter id="styling"> + <title>Styling</title> + <xi:include href="xml/st-theme.xml"/> + <xi:include href="xml/st-theme-context.xml"/> + <xi:include href="xml/st-theme-node.xml"/> + <xi:include href="xml/st-theme-node-transition.xml"/> + <xi:include href="xml/st-texture-cache.xml"/> + </chapter> + </part> + <!-- FIXME: + Not generated at the moment, find out whether to blame gtk-doc or meson + --> + <!-- + <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> + </index> + <index id="deprecated-api-index" role="deprecated"> + <title>Index of deprecated API</title> + <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> +</book> diff --git a/docs/reference/st/version.xml.in b/docs/reference/st/version.xml.in new file mode 100644 index 0000000..d78bda9 --- /dev/null +++ b/docs/reference/st/version.xml.in @@ -0,0 +1 @@ +@VERSION@ |