diff options
Diffstat (limited to 'docs/libnm-glib')
| -rw-r--r-- | docs/libnm-glib/Makefile.am | 22 | ||||
| -rw-r--r-- | docs/libnm-glib/Makefile.in | 28 | ||||
| -rw-r--r-- | docs/libnm-glib/html/NMClient.html | 2 | ||||
| -rw-r--r-- | docs/libnm-glib/html/NMDHCP4Config.html | 2 | ||||
| -rw-r--r-- | docs/libnm-glib/html/NMDHCP6Config.html | 2 | ||||
| -rw-r--r-- | docs/libnm-glib/html/NMSecretAgent.html | 131 | ||||
| -rw-r--r-- | docs/libnm-glib/html/index.html | 2 | ||||
| -rw-r--r-- | docs/libnm-glib/meson.build | 39 | ||||
| -rw-r--r-- | docs/libnm-glib/version.xml | 2 |
9 files changed, 63 insertions, 167 deletions
diff --git a/docs/libnm-glib/Makefile.am b/docs/libnm-glib/Makefile.am index b975f1b2..dab2e3f7 100644 --- a/docs/libnm-glib/Makefile.am +++ b/docs/libnm-glib/Makefile.am @@ -15,9 +15,6 @@ DOC_SOURCE_DIR=$(top_srcdir)/libnm-glib # Extra options to supply to gtkdoc-scan. SCAN_OPTIONS= -# Extra options to supply to gtkdoc-scangobj. -SCANGOBJ_OPTIONS=--type-init-func 'g_type_init();' - # Extra options to supply to gtkdoc-mkdb. MKDB_OPTIONS=--sgml-mode --output-format=xml @@ -52,19 +49,18 @@ extra_files = libnm-glib.png # CFLAGS and LDFLAGS for compiling scan program. Only needed # if $(DOC_MODULE).types is non-empty. -GTKDOC_CFLAGS = \ - -I$(top_srcdir)/shared \ +GTKDOC_CFLAGS = \ + -I$(top_srcdir)/shared \ -I$(top_builddir)/shared \ - -I$(top_srcdir)/libnm-util \ - -I$(top_builddir)/libnm-util \ - -I$(top_srcdir)/libnm-glib \ - -I$(top_builddir)/libnm-glib \ - -DNM_VERSION_MAX_ALLOWED=NM_VERSION_NEXT_STABLE \ + -I$(top_srcdir)/libnm-util \ + -I$(top_builddir)/libnm-util \ + -I$(top_srcdir)/libnm-glib \ + -I$(top_builddir)/libnm-glib \ -DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \ - $(GLIB_CFLAGS) \ + $(GLIB_CFLAGS) \ $(DBUS_CFLAGS) -GTKDOC_LIBS = \ +GTKDOC_LIBS = \ $(top_builddir)/libnm-glib/libnm-glib.la \ $(GLIB_LIBS) @@ -72,7 +68,7 @@ GTKDOC_LIBS = \ # include common portion ... include $(top_srcdir)/gtk-doc.make -EXTRA_DIST += version.xml.in +EXTRA_DIST += version.xml.in meson.build CLEANFILES += \ libnm-glib-sections.txt \ diff --git a/docs/libnm-glib/Makefile.in b/docs/libnm-glib/Makefile.in index 1e6f0c58..16a2ee36 100644 --- a/docs/libnm-glib/Makefile.in +++ b/docs/libnm-glib/Makefile.in @@ -209,7 +209,7 @@ GENHTML = @GENHTML@ GETTEXT_MACRO_VERSION = @GETTEXT_MACRO_VERSION@ GETTEXT_PACKAGE = @GETTEXT_PACKAGE@ GLIB_CFLAGS = @GLIB_CFLAGS@ -GLIB_GENMARSHAL = @GLIB_GENMARSHAL@ +GLIB_COMPILE_RESOURCES = @GLIB_COMPILE_RESOURCES@ GLIB_LIBS = @GLIB_LIBS@ GLIB_MAKEFILE = @GLIB_MAKEFILE@ GLIB_MKENUMS = @GLIB_MKENUMS@ @@ -263,14 +263,13 @@ LIBICONV = @LIBICONV@ LIBINTL = @LIBINTL@ LIBNDP_CFLAGS = @LIBNDP_CFLAGS@ LIBNDP_LIBS = @LIBNDP_LIBS@ -LIBNL_CFLAGS = @LIBNL_CFLAGS@ -LIBNL_LIBS = @LIBNL_LIBS@ LIBOBJS = @LIBOBJS@ LIBPSL_CFLAGS = @LIBPSL_CFLAGS@ LIBPSL_LIBS = @LIBPSL_LIBS@ LIBS = @LIBS@ LIBSYSTEMD_CFLAGS = @LIBSYSTEMD_CFLAGS@ LIBSYSTEMD_LIBS = @LIBSYSTEMD_LIBS@ +LIBSYSTEMD_NM_CFLAGS = @LIBSYSTEMD_NM_CFLAGS@ LIBTEAMDCTL_CFLAGS = @LIBTEAMDCTL_CFLAGS@ LIBTEAMDCTL_LIBS = @LIBTEAMDCTL_LIBS@ LIBTOOL = @LIBTOOL@ @@ -341,8 +340,11 @@ QT_LIBS = @QT_LIBS@ RANLIB = @RANLIB@ READELF = @READELF@ READLINE_LIBS = @READLINE_LIBS@ -SANITIZERS = @SANITIZERS@ SANITIZER_ENV = @SANITIZER_ENV@ +SANITIZER_EXEC_CFLAGS = @SANITIZER_EXEC_CFLAGS@ +SANITIZER_EXEC_LDFLAGS = @SANITIZER_EXEC_LDFLAGS@ +SANITIZER_LIB_CFLAGS = @SANITIZER_LIB_CFLAGS@ +SANITIZER_LIB_LDFLAGS = @SANITIZER_LIB_LDFLAGS@ SED = @SED@ SELINUX_CFLAGS = @SELINUX_CFLAGS@ SELINUX_LIBS = @SELINUX_LIBS@ @@ -462,9 +464,6 @@ DOC_SOURCE_DIR = $(top_srcdir)/libnm-glib # Extra options to supply to gtkdoc-scan. SCAN_OPTIONS = -# Extra options to supply to gtkdoc-scangobj. -SCANGOBJ_OPTIONS = --type-init-func 'g_type_init();' - # Extra options to supply to gtkdoc-mkdb. MKDB_OPTIONS = --sgml-mode --output-format=xml @@ -500,15 +499,14 @@ extra_files = libnm-glib.png # CFLAGS and LDFLAGS for compiling scan program. Only needed # if $(DOC_MODULE).types is non-empty. GTKDOC_CFLAGS = \ - -I$(top_srcdir)/shared \ + -I$(top_srcdir)/shared \ -I$(top_builddir)/shared \ - -I$(top_srcdir)/libnm-util \ - -I$(top_builddir)/libnm-util \ - -I$(top_srcdir)/libnm-glib \ - -I$(top_builddir)/libnm-glib \ - -DNM_VERSION_MAX_ALLOWED=NM_VERSION_NEXT_STABLE \ + -I$(top_srcdir)/libnm-util \ + -I$(top_builddir)/libnm-util \ + -I$(top_srcdir)/libnm-glib \ + -I$(top_builddir)/libnm-glib \ -DNM_VERSION_MIN_REQUIRED=NM_VERSION_0_9_8 \ - $(GLIB_CFLAGS) \ + $(GLIB_CFLAGS) \ $(DBUS_CFLAGS) GTKDOC_LIBS = \ @@ -538,7 +536,7 @@ SETUP_FILES = \ # include common portion ... -EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) version.xml.in +EXTRA_DIST = $(HTML_IMAGES) $(SETUP_FILES) version.xml.in meson.build DOC_STAMPS = setup-build.stamp scan-build.stamp sgml-build.stamp \ html-build.stamp pdf-build.stamp \ sgml.stamp html.stamp pdf.stamp diff --git a/docs/libnm-glib/html/NMClient.html b/docs/libnm-glib/html/NMClient.html index 47a706c1..09fbe7ff 100644 --- a/docs/libnm-glib/html/NMClient.html +++ b/docs/libnm-glib/html/NMClient.html @@ -2235,8 +2235,6 @@ likely to become the new <a class="link" href="NMClient.html#NMClient--primary-c <div class="refsect2"> <a name="NMClient--active-connections"></a><h3>The <code class="literal">“active-connections”</code> property</h3> <pre class="programlisting"> “active-connections” <span class="type">NMObjectArray</span> *</pre> -<p>The active connections. -Type: GLib.PtrArray</p> <p>Flags: Read</p> </div> <hr> diff --git a/docs/libnm-glib/html/NMDHCP4Config.html b/docs/libnm-glib/html/NMDHCP4Config.html index c2fc38ed..f4c7211c 100644 --- a/docs/libnm-glib/html/NMDHCP4Config.html +++ b/docs/libnm-glib/html/NMDHCP4Config.html @@ -219,8 +219,6 @@ configuration, and must not be modified.</p> <div class="refsect2"> <a name="NMDHCP4Config--options"></a><h3>The <code class="literal">“options”</code> property</h3> <pre class="programlisting"> “options” <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *</pre> -<p>The <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> containing options of the configuration.</p> -<p>Type: GLib.HashTable(utf8,GObject.Value)</p> <p>Flags: Read</p> </div> </div> diff --git a/docs/libnm-glib/html/NMDHCP6Config.html b/docs/libnm-glib/html/NMDHCP6Config.html index ca5ca04d..a5d05b9d 100644 --- a/docs/libnm-glib/html/NMDHCP6Config.html +++ b/docs/libnm-glib/html/NMDHCP6Config.html @@ -219,8 +219,6 @@ configuration, and must not be modified.</p> <div class="refsect2"> <a name="NMDHCP6Config--options"></a><h3>The <code class="literal">“options”</code> property</h3> <pre class="programlisting"> “options” <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> *</pre> -<p>The <a href="../glib/glib-Hash-Tables.html#GHashTable"><span class="type">GHashTable</span></a> containing options of the configuration.</p> -<p>Type: GLib.HashTable(utf8,GObject.Value)</p> <p>Flags: Read</p> </div> </div> diff --git a/docs/libnm-glib/html/NMSecretAgent.html b/docs/libnm-glib/html/NMSecretAgent.html index d7617dd9..e7491ef0 100644 --- a/docs/libnm-glib/html/NMSecretAgent.html +++ b/docs/libnm-glib/html/NMSecretAgent.html @@ -532,63 +532,6 @@ nm_secret_agent_get_secrets (<em class="parameter"><code><a class="link" href="N <em class="parameter"><code><a class="link" href="NMSecretAgent.html#NMSecretAgentGetSecretsFlags" title="enum NMSecretAgentGetSecretsFlags"><span class="type">NMSecretAgentGetSecretsFlags</span></a> flags</code></em>, <em class="parameter"><code><a class="link" href="NMSecretAgent.html#NMSecretAgentGetSecretsFunc" title="NMSecretAgentGetSecretsFunc ()"><span class="type">NMSecretAgentGetSecretsFunc</span></a> callback</code></em>, <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> -<p>Asyncronously retrieve secrets belonging to <em class="parameter"><code>connection</code></em> - for the -setting <em class="parameter"><code>setting_name</code></em> -. <em class="parameter"><code>flags</code></em> - indicate specific behavior that the secret -agent should use when performing the request, for example returning only -existing secrets without user interaction, or requesting entirely new -secrets from the user.</p> -<p>Virtual: get_secrets</p> -<div class="refsect3"> -<a name="nm-secret-agent-get-secrets.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>self</p></td> -<td class="parameter_description"><p>a <a class="link" href="NMSecretAgent.html" title="NMSecretAgent"><span class="type">NMSecretAgent</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>the <a href="../libnm-util/NMConnection.html#NMConnection-struct"><span class="type">NMConnection</span></a> for which we're asked secrets</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>setting_name</p></td> -<td class="parameter_description"><p>the name of the secret setting</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>hints</p></td> -<td class="parameter_description"><p>hints to the agent. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="Parameter points to an array of items."><span class="acronym">array</span></acronym> zero-terminated=1]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>flags</p></td> -<td class="parameter_description"><p>flags that modify the behavior of the request</p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>a callback, to be invoked when the operation is done. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>caller-specific data to be passed to <em class="parameter"><code>callback</code></em> -. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> </div> <hr> <div class="refsect2"> @@ -598,43 +541,6 @@ nm_secret_agent_save_secrets (<em class="parameter"><code><a class="link" href=" <em class="parameter"><code><a href="../libnm-util/NMConnection.html#NMConnection-struct"><span class="type">NMConnection</span></a> *connection</code></em>, <em class="parameter"><code><a class="link" href="NMSecretAgent.html#NMSecretAgentSaveSecretsFunc" title="NMSecretAgentSaveSecretsFunc ()"><span class="type">NMSecretAgentSaveSecretsFunc</span></a> callback</code></em>, <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> -<p>Asyncronously ensure that all secrets inside <em class="parameter"><code>connection</code></em> - -are stored to disk.</p> -<p>Virtual: save_secrets</p> -<div class="refsect3"> -<a name="nm-secret-agent-save-secrets.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>self</p></td> -<td class="parameter_description"><p>a <a class="link" href="NMSecretAgent.html" title="NMSecretAgent"><span class="type">NMSecretAgent</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>a <a href="../libnm-util/NMConnection.html#NMConnection-struct"><span class="type">NMConnection</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>a callback, to be invoked when the operation is done. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>caller-specific data to be passed to <em class="parameter"><code>callback</code></em> -. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> </div> <hr> <div class="refsect2"> @@ -644,43 +550,6 @@ nm_secret_agent_delete_secrets (<em class="parameter"><code><a class="link" href <em class="parameter"><code><a href="../libnm-util/NMConnection.html#NMConnection-struct"><span class="type">NMConnection</span></a> *connection</code></em>, <em class="parameter"><code><a class="link" href="NMSecretAgent.html#NMSecretAgentDeleteSecretsFunc" title="NMSecretAgentDeleteSecretsFunc ()"><span class="type">NMSecretAgentDeleteSecretsFunc</span></a> callback</code></em>, <em class="parameter"><code><a href="../glib/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data</code></em>);</pre> -<p>Asynchronously ask the agent to delete all saved secrets belonging to -<em class="parameter"><code>connection</code></em> -.</p> -<p>Virtual: delete_secrets</p> -<div class="refsect3"> -<a name="nm-secret-agent-delete-secrets.parameters"></a><h4>Parameters</h4> -<div class="informaltable"><table class="informaltable" width="100%" border="0"> -<colgroup> -<col width="150px" class="parameters_name"> -<col class="parameters_description"> -<col width="200px" class="parameters_annotations"> -</colgroup> -<tbody> -<tr> -<td class="parameter_name"><p>self</p></td> -<td class="parameter_description"><p>a <a class="link" href="NMSecretAgent.html" title="NMSecretAgent"><span class="type">NMSecretAgent</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>connection</p></td> -<td class="parameter_description"><p>a <a href="../libnm-util/NMConnection.html#NMConnection-struct"><span class="type">NMConnection</span></a></p></td> -<td class="parameter_annotations"> </td> -</tr> -<tr> -<td class="parameter_name"><p>callback</p></td> -<td class="parameter_description"><p>a callback, to be invoked when the operation is done. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="The callback is valid until first called."><span class="acronym">scope async</span></acronym>]</span></td> -</tr> -<tr> -<td class="parameter_name"><p>user_data</p></td> -<td class="parameter_description"><p>caller-specific data to be passed to <em class="parameter"><code>callback</code></em> -. </p></td> -<td class="parameter_annotations"><span class="annotation">[<acronym title="This parameter is a 'user_data', for callbacks; many bindings can pass NULL here."><span class="acronym">closure</span></acronym>]</span></td> -</tr> -</tbody> -</table></div> -</div> </div> </div> <div class="refsect1"> diff --git a/docs/libnm-glib/html/index.html b/docs/libnm-glib/html/index.html index fba741ff..850a9ff9 100644 --- a/docs/libnm-glib/html/index.html +++ b/docs/libnm-glib/html/index.html @@ -15,7 +15,7 @@ <div> <div><table class="navigation" id="top" width="100%" cellpadding="2" cellspacing="0"><tr><th valign="middle"><p class="title">libnm-glib Reference Manual</p></th></tr></table></div> <div><p class="releaseinfo"> - for libnm-glib 1.10.6 + for libnm-glib 1.11.3 The latest version of this documentation can be found on-line at <a class="ulink" href="https://developer.gnome.org/libnm-glib/stable/" target="_top">https://developer.gnome.org/libnm-glib/stable/</a>. diff --git a/docs/libnm-glib/meson.build b/docs/libnm-glib/meson.build new file mode 100644 index 00000000..b760ce00 --- /dev/null +++ b/docs/libnm-glib/meson.build @@ -0,0 +1,39 @@ +doc_module = libnm_glib_name + +private_headers = [ + 'common.h', + 'nm-dbus-helpers-private.h', + 'nm-device-private.h', + 'nm-object-cache.h', + 'nm-object-private.h', + 'nm-remote-connection-private.h', + 'nm-types-private.h', + 'nm-secret-agent-glue.h', + 'nm-vpn-plugin-glue.h' +] + +configure_file( + input: version_xml + '.in', + output: version_xml, + configuration: version_conf +) + +gnome.gtkdoc( + doc_module, + main_xml: doc_module + '-docs.xml', + src_dir: join_paths(meson.source_root(), 'libnm-glib'), + dependencies: [ + libnm_glib_dep, + libnm_glib_vpn_dep + ], + scan_args: [ + '--rebuild-types', + '--rebuild-sections', + '--ignore-headers=' + ' '.join(private_headers), + ], + scanobjs_args: '--type-init-func="g_type_init();"', + fixxref_args: '--html-dir=' + join_paths(nm_prefix, gnome.gtkdoc_html_dir(doc_module)), + gobject_typesfile: doc_module + '.types', + html_assets: doc_module + '.png', + install: true +) diff --git a/docs/libnm-glib/version.xml b/docs/libnm-glib/version.xml index 7b4d9a4f..0a5af26d 100644 --- a/docs/libnm-glib/version.xml +++ b/docs/libnm-glib/version.xml @@ -1 +1 @@ -1.10.6 +1.11.3 |