luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-07-30 13:53:30 +02:00
Code Issues Packages Projects Releases Wiki Activity

Add base64 docs

Browse Source
This commit is contained in:
Matthias Clasen
2006-04-05 03:19:30 +00:00
parent 5cf8f1d4a8
commit 6324ed6b34
9 changed files with 178 additions and 49 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
docs/reference/ChangeLog
View File

@@ -1,3 +1,8 @@
2006-04-04 Matthias Clasen <mclasen@redhat.com>
* glib/glib-sections.txt:
* glib/glib-docs.sgml: Add Base64 section
2006-04-03 Matthias Clasen <mclasen@redhat.com>
* gobject/tmpl/objects.sgml: Add some verbiage to

2
docs/reference/glib/glib-docs.sgml
View File

@@ -58,6 +58,7 @@
<!ENTITY glib-Markup SYSTEM "xml/markup.xml">
<!ENTITY glib-Keyfile SYSTEM "xml/keyfile.xml">
<!ENTITY glib-Bookmarkfile SYSTEM "xml/bookmarkfile.xml">
<!ENTITY glib-Base64 SYSTEM "xml/base64.xml">
<!ENTITY glib-i18n SYSTEM "xml/i18n.xml">
<!ENTITY glib-Version SYSTEM "xml/version.xml">
@@ -135,6 +136,7 @@ synchronize their operation.
&glib-String-Utility-Functions;
&glib-Character-Set-Conversion;
&glib-Unicode-Manipulation;
&glib-Base64;
&glib-i18n;
&glib-Date-and-Time-Functions;
&glib-Random-Numbers;

10
docs/reference/glib/glib-sections.txt
View File

@@ -2305,3 +2305,13 @@ g_strip_context
<SUBSECTION>
g_get_language_names
</SECTION>
<SECTION>
<TITLE>Base64 Encoding</TITLE>
<FILE>base64</FILE>
g_base64_encode_step
g_base64_encode_close
g_base64_encode
g_base64_decode_step
g_base64_decode
</SECTION>

95
docs/reference/glib/tmpl/base64.sgml Normal file
View File

@@ -0,0 +1,95 @@
<!-- ##### 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() and g_base64_decode_close(). To encode or
decode data in one go, use g_base64_encode() of g_base64_decode().
</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: