luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-12 23:46:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

Migrate gbase64 docs from SGML template to inline comments

Browse Source 
Fixes bug #589649.

Signed-off-by: David King <davidk@openismus.com>
This commit is contained in:
Craig Loftus 2009-07-23 20:24:22 +01:00 committed by David King
parent 32c84729f5
commit a465508e2d
2 changed files with 20 additions and 105 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
docs/reference/glib/tmpl/base64.sgml
View File

@ -1,105 +0,0 @@
<!-- ##### SECTION Title ##### -->
Base64 Encoding
<!-- ##### SECTION Short_Description ##### -->
encodes and decodes data in Base64 format
<!-- ##### SECTION Long_Description ##### -->
<para>
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 <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.
</para>
<para>
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().
</para>
<para>
Support for Base64 encoding has been added in GLib 2.12.
</para>
<!-- ##### SECTION See_Also ##### -->
<para>
</para>
<!-- ##### SECTION Stability_Level ##### -->
<!-- ##### FUNCTION g_base64_encode_step ##### -->
<para>
</para>
@in:
@len:
@break_lines:
@out:
@state:
@save:
@Returns:
<!-- ##### FUNCTION g_base64_encode_close ##### -->
<para>
</para>
@break_lines:
@out:
@state:
@save:
@Returns:
<!-- ##### FUNCTION g_base64_encode ##### -->
<para>
</para>
@data:
@len:
@Returns:
<!-- ##### FUNCTION g_base64_decode_step ##### -->
<para>
</para>
@in:
@len:
@out:
@state:
@save:
@Returns:
<!-- ##### FUNCTION g_base64_decode ##### -->
<para>
</para>
@text:
@out_len:
@Returns:
<!-- ##### FUNCTION g_base64_decode_inplace ##### -->
<para>
</para>
@text:
@out_len:
@Returns:

20
glib/gbase64.c
View File

@ -33,6 +33,26 @@
#include "galias.h" #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[] = static const char base64_alphabet[] =
"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/"; "ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";