[jsonrpc-glib] doc: update Jsonrpc-GLib documentation
- From: Christian Hergert <chergert src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [jsonrpc-glib] doc: update Jsonrpc-GLib documentation
- Date: Sun, 11 Jun 2017 05:34:59 +0000 (UTC)
commit d95c37bc8e43aff23c6f31cb4be37f1bf2a9439b
Author: Christian Hergert <chergert redhat com>
Date: Sat Jun 10 22:34:21 2017 -0700
doc: update Jsonrpc-GLib documentation
doc/jsonrpc-glib-docs.sgml | 44 ++++++++++++++++++++++++++++++++++++++----
src/jsonrpc-output-stream.c | 4 +-
src/jsonrpc-server.c | 10 +++++++++
tests/test-client.c | 1 -
4 files changed, 51 insertions(+), 8 deletions(-)
---
diff --git a/doc/jsonrpc-glib-docs.sgml b/doc/jsonrpc-glib-docs.sgml
index c3e85e7..d553a6a 100644
--- a/doc/jsonrpc-glib-docs.sgml
+++ b/doc/jsonrpc-glib-docs.sgml
@@ -10,19 +10,53 @@
<bookinfo>
<title>&package_name; Reference Manual</title>
<releaseinfo>
- for &package_string;.
- The latest version of this documentation can be found on-line at
- <ulink role="online-location"
url="http://library.gnome.org/&package_name;/index.html">http://library.gnome.org/&package_name;/</ulink>.
+ <para>This document is the API reference for for &package_name; &package_version;.</para>
+ <para>
+ The latest version of this API reference is also available
+ <ulink role="online-location" url="https://developer.gnome.org/jsonrpc/">online</ulink>.
+ </para>
+ <para>
+ If you find any issues in this API reference, please report it
+ using <ulink type="http" url="&package_bugreport;">the online
+ bug reporting tool</ulink> at bugzilla.gnome.org.
+ </para>
</releaseinfo>
+
+ <copyright>
+ <year>2016-2017</year>
+ <holder>Christian Hergert</holder>
+ </copyright>
+
+ <legalnotice>
+ <para>
+ Permission is granted to copy, distribute and/or modify this
+ document under the terms of the <citetitle>GNU Free
+ Documentation License</citetitle>, Version 1.1 or any later
+ version published by the Free Software Foundation with no
+ Invariant Sections, no Front-Cover Texts, and no Back-Cover
+ Texts. You may obtain a copy of the <citetitle>GNU Free
+ Documentation License</citetitle> from the Free Software
+ Foundation by visiting <ulink type="http"
+ url="http://www.fsf.org">their Web site</ulink> or by writing
+ to:
+
+ <address>
+ The Free Software Foundation, Inc.,
+ <street>59 Temple Place</street> - Suite 330,
+ <city>Boston</city>, <state>MA</state> <postcode>02111-1307</postcode>,
+ <country>USA</country>
+ </address>
+ </para>
+ </legalnotice>
</bookinfo>
<chapter>
<title>Jsonrpc-GLib API Reference</title>
<xi:include href="xml/jsonrpc-client.xml"/>
- <xi:include href="xml/jsonrpc-input-stream.xml"/>
+ <xi:include href="xml/jsonrpc-server.xml"/>
<xi:include href="xml/jsonrpc-message.xml"/>
+ <xi:include href="xml/jsonrpc-input-stream.xml"/>
<xi:include href="xml/jsonrpc-output-stream.xml"/>
- <xi:include href="xml/jsonrpc-server.xml"/>
</chapter>
<chapter id="object-tree">
diff --git a/src/jsonrpc-output-stream.c b/src/jsonrpc-output-stream.c
index c970dc9..e63719b 100644
--- a/src/jsonrpc-output-stream.c
+++ b/src/jsonrpc-output-stream.c
@@ -25,8 +25,8 @@
/**
* SECTION:jsonrpc-output-stream
- * @title: #JsonrpcOutputStream
- * @short_description: A JSONRPC output stream
+ * @title: JsonrpcOutputStream
+ * @short_description: A JSON-RPC output stream
*
* The #JsonrpcOutputStream is resonsible for serializing messages onto
* the underlying stream.
diff --git a/src/jsonrpc-server.c b/src/jsonrpc-server.c
index eaf69c8..f8697e0 100644
--- a/src/jsonrpc-server.c
+++ b/src/jsonrpc-server.c
@@ -22,6 +22,16 @@
#include "jsonrpc-output-stream.h"
#include "jsonrpc-server.h"
+/**
+ * SECTION:jsonrpc-server
+ * @title: JsonrpcServer
+ * @short_description: A server for JSON-RPC communication
+ *
+ * The #JsonrpcServer class can help you implement a JSON-RPC server. You can
+ * accept connections and then communicate with clients using the
+ * #JsonrpcClient API.
+ */
+
typedef struct
{
GHashTable *clients;
diff --git a/tests/test-client.c b/tests/test-client.c
index f4a056d..7673a1f 100644
--- a/tests/test-client.c
+++ b/tests/test-client.c
@@ -29,7 +29,6 @@ call_cb (GObject *object,
JsonrpcClient *client = (JsonrpcClient *)object;
g_autoptr(GError) error = NULL;
g_autoptr(GVariant) return_value = NULL;
- g_autofree gchar *str = NULL;
g_assert (JSONRPC_IS_CLIENT (client));
g_assert (G_IS_ASYNC_RESULT (result));
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]