SILC Runtime Toolkit 1.2 Beta 1

[runtime.git] / lib / silcutil / silcbase64.h

diff --git a/lib/silcutil/silcbase64.h b/lib/silcutil/silcbase64.h
index e060d4d716d413b2df137b70b6b175c42e47bcc0..0ef7760c592ebd7ee100956176b1b0370458e155 100644 (file)
--- a/lib/silcutil/silcbase64.h
+++ b/lib/silcutil/silcbase64.h
@@ -4,7 +4,7 @@
 
   Author: Pekka Riikonen <priikone@silcnet.org>
 
-  Copyright (C) 2007 Pekka Riikonen
+  Copyright (C) 2007 - 2008 Pekka Riikonen
 
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
@@ -17,7 +17,7 @@
 
 */
 
-/****h* silcutil/SILC Base64 API
+/****h* silcutil/Base64 Interface
  *
  * DESCRIPTION
  *
@@ -28,7 +28,7 @@
 #ifndef SILCBASE64_H
 #define SILCBASE64_H
 
-/****f* silcutil/SilcBase64API/silc_base64_encode
+/****f* silcutil/silc_base64_encode
  *
  * SYNOPSIS
  *
@@ -38,14 +38,14 @@
  * DESCRIPTION
  *
  *    Encodes data into Base 64 (PEM) encoding. Returns NULL terminated
- *    Base 64 encoded data string.
+ *    Base 64 encoded data string.  Returns NULL if system is out of memory.
  *
  *    If `stack' is non-NULL the returned buffer is allocated from `stack'.
  *
  ***/
 char *silc_base64_encode(SilcStack stack, unsigned char *data, SilcUInt32 len);
 
-/****f* silcutil/SilcBase64API/silc_base64_encode_file
+/****f* silcutil/silc_base64_encode_file
  *
  * SYNOPSIS
  *
@@ -55,7 +55,7 @@ char *silc_base64_encode(SilcStack stack, unsigned char *data, SilcUInt32 len);
  * DESCRIPTION
  *
  *    Same as silc_base64_encode() but puts newline ('\n') every 72
- *    characters.
+ *    characters.  Returns NULL if system is out of memory.
  *
  *    If `stack' is non-NULL the returned buffer is allocated from `stack'.
  *
@@ -63,7 +63,7 @@ char *silc_base64_encode(SilcStack stack, unsigned char *data, SilcUInt32 len);
 char *silc_base64_encode_file(SilcStack stack,
                              unsigned char *data, SilcUInt32 data_len);
 
-/****f* silcutil/SilcBase64API/silc_base_decode
+/****f* silcutil/silc_base_decode
  *
  * SYNOPSIS
  *
@@ -74,7 +74,8 @@ char *silc_base64_encode_file(SilcStack stack,
  *
  * DESCRIPTION
  *
- *    Decodes Base 64 (PEM) into data. Returns the decoded data.
+ *    Decodes Base 64 (PEM) into data. Returns the decoded data.  Returns
+ *    NULL if the data is not valid Base 64 encoded data.
  *
  *    If `stack' is non-NULL the returned buffer is allocated from `stack'.
  *