From: Craig Loftus Date: Thu, 23 Jul 2009 19:24:22 +0000 (+0100) Subject: Migrate gbase64 docs from SGML template to inline comments X-Git-Tag: 2.21.5~36 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=a465508e2d3d52b919ccbf9f2c5bd90395922904;p=platform%2Fupstream%2Fglib.git Migrate gbase64 docs from SGML template to inline comments Fixes bug #589649. Signed-off-by: David King --- diff --git a/docs/reference/glib/tmpl/base64.sgml b/docs/reference/glib/tmpl/base64.sgml deleted file mode 100644 index dbec7a0..0000000 --- a/docs/reference/glib/tmpl/base64.sgml +++ /dev/null @@ -1,105 +0,0 @@ - -Base64 Encoding - - -encodes and decodes data in Base64 format - - - -Base64 is an encoding that allows to encode a sequence of arbitrary -bytes as a sequence of printable ASCII characters. For the definition -of Base64, see RFC -1421 or RFC -2045. 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. - - - - - - - - - - - - - - - -@in: -@len: -@break_lines: -@out: -@state: -@save: -@Returns: - - - - - - - -@break_lines: -@out: -@state: -@save: -@Returns: - - - - - - - -@data: -@len: -@Returns: - - - - - - - -@in: -@len: -@out: -@state: -@save: -@Returns: - - - - - - - -@text: -@out_len: -@Returns: - - - - - - - -@text: -@out_len: -@Returns: - - 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 RFC + * 1421 or RFC + * 2045. 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+/";