Commit 45d56850 authored by Jens Georg's avatar Jens Georg

all: Documentation update

parent 32ac7bf7
......@@ -198,6 +198,16 @@
<xi:include href="xml/api-index-0.20.12.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-1-0" role="1.1.0">
<title>Index of new symbols in 1.1.0</title>
<xi:include href="xml/api-index-1.1.0.xml"><xi:fallback /></xi:include>
</index>
<index id="api-index-1-1-1" role="1.1.1">
<title>Index of new symbols in 1.1.1</title>
<xi:include href="xml/api-index-1.1.1.xml"><xi:fallback /></xi:include>
</index>
<xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>
</book>
......@@ -187,6 +187,7 @@ gupnp_context_host_path_for_agent
gupnp_context_unhost_path
gupnp_context_get_acl
gupnp_context_set_acl
gupnp_context_rewrite_uri
<SUBSECTION Standard>
GUPnPContextClass
GUPNP_CONTEXT
......@@ -205,11 +206,14 @@ GUPnPContextPrivate
<TITLE>GUPnPContextManager</TITLE>
GUPnPContextManager
gupnp_context_manager_create
gupnp_context_manager_create_full
gupnp_context_manager_rescan_control_points
gupnp_context_manager_manage_control_point
gupnp_context_manager_manage_root_device
gupnp_context_manager_get_port
gupnp_context_manager_get_white_list
gupnp_context_manager_get_socket_family
gupnp_context_manager_get_uda_version
<SUBSECTION Standard>
GUPnPContextManagerClass
GUPNP_CONTEXT_MANAGER
......@@ -340,6 +344,7 @@ GUPnPResourceFactoryPrivate
GUPnPXMLDoc
gupnp_xml_doc_new
gupnp_xml_doc_new_from_path
gupnp_xml_doc_get_doc
<SUBSECTION Standard>
GUPnPXMLDocClass
GUPNP_XML_DOC
......
......@@ -34,7 +34,7 @@
the <literal>BinaryLight1</literal> device type, but if none of the
existing device types are suitable a custom device type can be created.
</para>
<programlisting><xi:include href="../../examples/BinaryLight1.xml" parse="text"><xi:fallback /></xi:include></programlisting>
<programlisting><xi:include href="../examples/BinaryLight1.xml" parse="text"><xi:fallback /></xi:include></programlisting>
<para>
The <sgmltag>specVersion</sgmltag> tag defines what version of the UPnP
Device Architecture the document conforms to. At the time of writing the
......@@ -82,7 +82,7 @@
from the specification. This is the <literal>SwitchPower1</literal>
service description file:
</para>
<programlisting><xi:include href="../../examples/SwitchPower1.xml" parse="text"><xi:fallback /></xi:include></programlisting>
<programlisting><xi:include href="../examples/SwitchPower1.xml" parse="text"><xi:fallback /></xi:include></programlisting>
<para>
Again, the <sgmltag>specVersion</sgmltag> tag defines the UPnP version
that is being used. The rest of the document consists of an
......
......@@ -615,7 +615,7 @@ gupnp_context_manager_class_init (GUPnPContextManagerClass *klass)
* NetworkManager - on its availability during runtime. If it is not available,
* the implementation falls back to the basic Unix context manager instead.
*
* Equivalent to calling #gupnp_context_manager_create_full (%GSSDP_CLIENT_UDA_VERSION_1_0, %G_SOCKET_FAMILY_IPV4, port);
* Equivalent to calling #gupnp_context_manager_create_full (%GSSDP_UDA_VERSION_1_0, %G_SOCKET_FAMILY_IPV4, port);
*
* Returns: (transfer full): A new #GUPnPContextManager object.
*
......@@ -631,7 +631,9 @@ gupnp_context_manager_create (guint port)
/**
* gupnp_context_manager_create_full:
* @family: GSocketFamily to create the context for
* @uda_version: #GSSDPUDAVersion the created contexts should implement
* (UDA 1.0 or 1.1). For %GSSDP_UDA_VERSION_UNSPECIFIED for default.
* @family: #GSocketFamily to create the context for
* @port: Port to create contexts for, or 0 if you don't care what port is used.
*
* Factory-method to create a new #GUPnPContextManager. The final type of the
......@@ -832,6 +834,16 @@ gupnp_context_manager_get_white_list (GUPnPContextManager *manager)
return priv->white_list;
}
/**
* gupnp_context_manager_get_socket_family:
* @manager: A #GUPnPContextManager
*
* Get the #GSocketFamily the contexts are created for. Can be
* %G_SOCKET_FAMILY_IPV6, %G_SOCKET_FAMILY_IPV4 or %G_SOCKET_FAMILY_INVALID for
* both
*
* Returns: The socket family
*/
GSocketFamily
gupnp_context_manager_get_socket_family (GUPnPContextManager *manager)
{
......@@ -845,6 +857,14 @@ gupnp_context_manager_get_socket_family (GUPnPContextManager *manager)
return priv->family;
}
/**
* gupnp_context_manager_get_uda_version:
* @manager: A #GUPnPContextManager
*
* Get the UDA protocol version the contexts are implementing
*
* Returns: The UDA protocol version
*/
GSSDPUDAVersion
gupnp_context_manager_get_uda_version (GUPnPContextManager *manager)
{
......
......@@ -1614,7 +1614,7 @@ gupnp_context_remove_server_handler (GUPnPContext *context, const char *path)
* Returns: A re-written version of the @uri if the context is on a link-local
* IPv6 address, a copy of the @uri otherwise.
*
* Since: 1.11.1
* Since: 1.1.1
*/
char *
gupnp_context_rewrite_uri (GUPnPContext *context, const char *plain_uri)
......
......@@ -143,7 +143,13 @@ gupnp_xml_doc_new_from_path (const char *path,
return gupnp_xml_doc_new (doc);
}
/**
* gupnp_xml_doc_get_doc:
* @xml_doc: A #GUPnPXMLDoc
*
* Returns: a pointer to the wrapped #xmlDoc
*/
const xmlDoc *
gupnp_xml_doc_get_doc (GUPnPXMLDoc *doc) {
return doc->doc;
gupnp_xml_doc_get_doc (GUPnPXMLDoc *xml_doc) {
return xml_doc->doc;
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment