diff options
| author | Craig Loftus <talk@craigloftus.net> | 2009-07-23 20:24:22 +0100 |
|---|---|---|
| committer | David King <davidk@openismus.com> | 2009-08-10 15:40:01 +0200 |
| commit | a465508e2d3d52b919ccbf9f2c5bd90395922904 (patch) | |
| tree | b6b3d552412ae59f6e98a45d88c505aaf2f92ecb /docs | |
| parent | 32c84729f5dac30170cf20aa44e6857a44e5349f (diff) | |
| download | glib-a465508e2d3d52b919ccbf9f2c5bd90395922904.tar.gz | |
Migrate gbase64 docs from SGML template to inline comments
Fixes bug #589649.
Signed-off-by: David King <davidk@openismus.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/reference/glib/tmpl/base64.sgml | 105 |
1 files changed, 0 insertions, 105 deletions
diff --git a/docs/reference/glib/tmpl/base64.sgml b/docs/reference/glib/tmpl/base64.sgml deleted file mode 100644 index dbec7a05c..000000000 --- a/docs/reference/glib/tmpl/base64.sgml +++ /dev/null @@ -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: - - |