[glib] Migrate gbase64 docs from SGML template to inline comments



commit a465508e2d3d52b919ccbf9f2c5bd90395922904
Author: Craig Loftus <talk craigloftus net>
Date:   Thu Jul 23 20:24:22 2009 +0100

    Migrate gbase64 docs from SGML template to inline comments
    
    Fixes bug #589649.
    
    Signed-off-by: David King <davidk openismus com>

 docs/reference/glib/tmpl/base64.sgml |  105 ----------------------------------
 glib/gbase64.c                       |   20 +++++++
 2 files changed, 20 insertions(+), 105 deletions(-)
---
diff --git a/glib/gbase64.c b/glib/gbase64.c
index bebff76..23d4ebf 100644
--- a/glib/gbase64.c
+++ b/glib/gbase64.c
@@ -33,6 +33,26 @@
 
 #include "galias.h"
 
+/**
+ * SECTION:base64 Base64 Encoding
+ * @short_description: encodes and decodes data in Base64 format
+ *
+ * Base64 is an encoding that allows a sequence of arbitrary bytes to be
+ * encoded as a sequence of printable ASCII characters. For the definition
+ * of Base64, see <ulink url="http://www.ietf.org/rfc/rfc1421.txt";>RFC
+ * 1421</ulink> or <ulink url="http://www.ietf.org/rfc/rfc2045.txt";>RFC
+ * 2045</ulink>. Base64 is most commonly used as a MIME transfer encoding
+ * for email.
+ *
+ * GLib supports incremental encoding using g_base64_encode_step() and
+ * g_base64_encode_close(). Incremental decoding can be done with
+ * g_base64_decode_step(). To encode or decode data in one go, use
+ * g_base64_encode() or g_base64_decode(). To avoid memory allocation when
+ * decoding, you can use g_base64_decode_inplace().
+ *
+ * Support for Base64 encoding has been added in GLib 2.12.
+ */
+
 static const char base64_alphabet[] =
 	"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
 



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