[gupnp] [PATCH] Documentation update
- From: Sven Neumann <s neumann raumfeld com>
- To: gupnp o-hand com
- Cc: Sven Neumann <s neumann raumfeld com>
- Subject: [gupnp] [PATCH] Documentation update
- Date: Mon, 23 Aug 2010 10:41:52 +0200
Exclude private header files from the gtk-doc parser and add missing
symbols to gupnp-av-sections.txt.
Signed-off-by: Sven Neumann <s neumann raumfeld com>
---
doc/Makefile.am | 11 ++++++--
doc/gupnp-av-sections.txt | 53 ++++++++++++--------------------------------
2 files changed, 23 insertions(+), 41 deletions(-)
diff --git a/doc/Makefile.am b/doc/Makefile.am
index a1219d6..72a89fa 100644
--- a/doc/Makefile.am
+++ b/doc/Makefile.am
@@ -47,9 +47,14 @@ CFILE_GLOB=$(top_srcdir)/libgupnp-av/*.c
# Header files to ignore when scanning.
# e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h
-IGNORE_HFILES= xml-util.h \
- gvalue-util.h \
- gupnp-av-marshal.h
+IGNORE_HFILES= \
+ xml-util.h \
+ gvalue-util.h \
+ gupnp-av-marshal.h \
+ gupnp-didl-lite-contributor-private.h \
+ gupnp-didl-lite-descriptor-private.h \
+ gupnp-didl-lite-object-private.h \
+ gupnp-didl-lite-resource-private.h
# Images to copy into HTML directory.
# e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
diff --git a/doc/gupnp-av-sections.txt b/doc/gupnp-av-sections.txt
index 34c7a08..9ecf96e 100644
--- a/doc/gupnp-av-sections.txt
+++ b/doc/gupnp-av-sections.txt
@@ -3,6 +3,8 @@
<TITLE>GUPnPDIDLLiteObject</TITLE>
GUPnPDIDLLiteObject
gupnp_didl_lite_object_get_xml_node
+gupnp_didl_lite_object_get_upnp_namespace
+gupnp_didl_lite_object_get_dc_namespace
gupnp_didl_lite_object_get_properties
gupnp_didl_lite_object_get_id
gupnp_didl_lite_object_get_parent_id
@@ -176,6 +178,7 @@ gupnp_didl_lite_resource_get_audio_channels
gupnp_didl_lite_resource_get_width
gupnp_didl_lite_resource_get_height
gupnp_didl_lite_resource_get_color_depth
+gupnp_didl_lite_resource_get_xml_node
<SUBSECTION Standard>
GUPNP_TYPE_DIDL_LITE_RESOURCE
GUPNP_DIDL_LITE_RESOURCE
@@ -241,6 +244,7 @@ GUPnPProtocolInfo
GUPnPDLNAConversion
GUPnPDLNAFlags
GUPnPDLNAOperation
+gupnp_protocol_info_new
gupnp_protocol_info_new_from_string
gupnp_protocol_info_to_string
gupnp_protocol_info_is_compatible
@@ -267,47 +271,15 @@ GUPNP_PROTOCOL_INFO_CLASS
GUPNP_IS_PROTOCOL_INFO
GUPNP_IS_PROTOCOL_INFO_CLASS
GUPNP_PROTOCOL_INFO_GET_CLASS
+GUPNP_TYPE_DLNA_CONVERSION
+GUPNP_TYPE_DLNA_FLAGS
+GUPNP_TYPE_DLNA_OPERATION
<SUBSECTION Private>
GUPnPProtocolInfoPrivate
gupnp_protocol_info_get_type
-</SECTION>
-
-<SECTION>
-<FILE>gupnp-protocol-info</FILE>
-<TITLE>GUPnPProtocolInfo</TITLE>
-GUPnPProtocolInfo
-GUPnPDLNAConversion
-GUPnPDLNAFlags
-GUPnPDLNAOperation
-gupnp_protocol_info_new_from_string
-gupnp_protocol_info_to_string
-gupnp_protocol_info_is_compatible
-gupnp_protocol_info_set_protocol
-gupnp_protocol_info_set_network
-gupnp_protocol_info_set_mime_type
-gupnp_protocol_info_set_dlna_profile
-gupnp_protocol_info_set_play_speeds
-gupnp_protocol_info_set_dlna_conversion
-gupnp_protocol_info_set_dlna_operation
-gupnp_protocol_info_set_dlna_flags
-gupnp_protocol_info_get_protocol
-gupnp_protocol_info_get_network
-gupnp_protocol_info_get_mime_type
-gupnp_protocol_info_get_dlna_profile
-gupnp_protocol_info_get_play_speeds
-gupnp_protocol_info_get_dlna_conversion
-gupnp_protocol_info_get_dlna_operation
-gupnp_protocol_info_get_dlna_flags
-<SUBSECTION Standard>
-GUPNP_TYPE_PROTOCOL_INFO
-GUPNP_PROTOCOL_INFO
-GUPNP_PROTOCOL_INFO_CLASS
-GUPNP_IS_PROTOCOL_INFO
-GUPNP_IS_PROTOCOL_INFO_CLASS
-GUPNP_PROTOCOL_INFO_GET_CLASS
-<SUBSECTION Private>
-GUPnPProtocolInfoPrivate
-gupnp_protocol_info_get_type
+gupnp_dlna_conversion_get_type
+gupnp_dlna_flags_get_type
+gupnp_dlna_operation_get_type
</SECTION>
<SECTION>
@@ -345,16 +317,21 @@ GUPNP_SEARCH_CRITERIA_PARSER_CLASS
GUPNP_IS_SEARCH_CRITERIA_PARSER
GUPNP_IS_SEARCH_CRITERIA_PARSER_CLASS
GUPNP_SEARCH_CRITERIA_PARSER_GET_CLASS
+GUPNP_TYPE_SEARCH_CRITERIA_OP
<SUBSECTION Private>
GUPnPSearchCriteriaParserPrivate
gupnp_search_criteria_parser_get_type
+gupnp_search_criteria_op_get_type
</SECTION>
<SECTION>
<FILE>gupnp-av-error</FILE>
<TITLE>Error codes</TITLE>
GUPNP_PROTOCOL_ERROR
+GUPNP_SEARCH_CRITERIA_PARSER_ERROR
GUPnPProtocolError
+GUPnPSearchCriteriaParserError
<SUBSECTION Private>
gupnp_protocol_error_quark
+gupnp_search_criteria_parser_error_quark
</SECTION>
--
1.7.0.4
--
To unsubscribe send a mail to gupnp+unsubscribe\@o-hand.com
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]