[aravis] doc: minor fixes.



commit 1960c52f7e6b106e5f62d7843d5490b40e2811a6
Author: Emmanuel Pacaud <emmanuel gnome org>
Date:   Mon Sep 9 10:38:50 2013 +0200

    doc: minor fixes.

 docs/reference/aravis/aravis-docs.xml     |    2 +-
 docs/reference/aravis/aravis-sections.txt |   26 +++++++++++++-------------
 src/arvstr.c                              |    7 +++++++
 3 files changed, 21 insertions(+), 14 deletions(-)
---
diff --git a/docs/reference/aravis/aravis-docs.xml b/docs/reference/aravis/aravis-docs.xml
index defc6ef..96b06be 100644
--- a/docs/reference/aravis/aravis-docs.xml
+++ b/docs/reference/aravis/aravis-docs.xml
@@ -105,11 +105,11 @@
 
                <chapter>
                        <title>Utils</title>
-                       <xi:include href="xml/arvpixelformat.xml"/>
                        <xi:include href="xml/arvdebug.xml"/>
                        <xi:include href="xml/arvevaluator.xml"/>
                        <xi:include href="xml/arvgst.xml"/>
                        <xi:include href="xml/arvstatistic.xml"/>
+                       <xi:include href="xml/arvstr.xml"/>
                        <xi:include href="xml/arvvalue.xml"/>
                        <xi:include href="xml/arvzip.xml"/>
                </chapter>
diff --git a/docs/reference/aravis/aravis-sections.txt b/docs/reference/aravis/aravis-sections.txt
index 04afacf..b01be25 100644
--- a/docs/reference/aravis/aravis-sections.txt
+++ b/docs/reference/aravis/aravis-sections.txt
@@ -69,9 +69,15 @@ ArvCameraClass
 </SECTION>
 
 <SECTION>
-<FILE>arvpixelformat</FILE>
-<TITLE>ArvPixelFormat</TITLE>
+<FILE>arvbuffer</FILE>
+<TITLE>ArvBuffer</TITLE>
+ArvFrameCallback
+ArvBufferStatus
+ArvBuffer
 ArvPixelFormat
+arv_buffer_new
+arv_buffer_new_full
+arv_buffer_new_allocate
 ARV_PIXEL_FORMAT_BIT_PER_PIXEL
 ARV_PIXEL_FORMAT_BAYER_BG_10
 ARV_PIXEL_FORMAT_BAYER_BG_12
@@ -126,17 +132,6 @@ ARV_PIXEL_FORMAT_YUV_411_PACKED
 ARV_PIXEL_FORMAT_YUV_422_PACKED
 ARV_PIXEL_FORMAT_YUV_422_YUYV_PACKED
 ARV_PIXEL_FORMAT_YUV_444_PACKED
-</SECTION>
-
-<SECTION>
-<FILE>arvbuffer</FILE>
-<TITLE>ArvBuffer</TITLE>
-ArvFrameCallback
-ArvBufferStatus
-ArvBuffer
-arv_buffer_new
-arv_buffer_new_full
-arv_buffer_new_allocate
 <SUBSECTION Standard>
 ARV_BUFFER
 ARV_IS_BUFFER
@@ -1012,6 +1007,11 @@ arv_statistic_reset
 arv_statistic_fill
 arv_statistic_set_name
 arv_statistic_to_string
+</SECTION>
+
+<SECTION>
+<FILE>arvstr</FILE>
+<TITLE>ArvStr</TITLE>
 arv_str_strip
 arv_str_is_uri
 arv_str_to_uri
diff --git a/src/arvstr.c b/src/arvstr.c
index c363954..2f2821e 100644
--- a/src/arvstr.c
+++ b/src/arvstr.c
@@ -28,6 +28,11 @@
 #include <math.h>
 
 /**
+ * SECTION: arvstr
+ * @short_description: String utilities
+ */
+
+/**
  * arv_str_strip:
  * @str: (allow-none): a string
  * @illegal_chars: illegal characters
@@ -37,6 +42,8 @@
  * Several consecutive @illegal_chars are replaced by only one @replacement_char. @illegal_chars at the 
beginnig or at the end of @str
  * are simply removed.
  *
+ * If @replacement_char is '\0', all @illegal_chars are simply removed.
+ *
  * Returns: @str
  *
  * Since: 0.3.0


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]