[kdbus] KDBUS_ITEM_PAYLOAD_OFF items are (once again) relative to msg header
[platform/upstream/glib.git] / glib / gbase64.c
index 7c7ab7b..a6cbea4 100644 (file)
  *
  * 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
+ * of Base64, see 
+ * [RFC 1421](http://www.ietf.org/rfc/rfc1421.txt)
+ * or
+ * [RFC 2045](http://www.ietf.org/rfc/rfc2045.txt).
+ * Base64 is most commonly used as a MIME transfer encoding
  * for email.
  *
  * GLib supports incremental encoding using g_base64_encode_step() and
@@ -79,11 +81,11 @@ static const char base64_alphabet[] =
  * @break_lines is typically used when putting base64-encoded data in emails.
  * It breaks the lines at 72 columns instead of putting all of the text on
  * the same line. This avoids problems with long lines in the email system.
- * Note however that it breaks the lines with <literal>LF</literal>
- * characters, not <literal>CR LF</literal> sequences, so the result cannot
- * be passed directly to SMTP or certain other protocols.
+ * Note however that it breaks the lines with `LF` characters, not
+ * `CR LF` sequences, so the result cannot be passed directly to SMTP
+ * or certain other protocols.
  *
- * Return value: The number of bytes of output that was written
+ * Returns: The number of bytes of output that was written
  *
  * Since: 2.12
  */
@@ -190,7 +192,7 @@ g_base64_encode_step (const guchar *in,
  * be written to it. It will need up to 4 bytes, or up to 5 bytes if
  * line-breaking is enabled.
  *
- * Return value: The number of bytes of output that was written
+ * Returns: The number of bytes of output that was written
  *
  * Since: 2.12
  */
@@ -242,7 +244,7 @@ g_base64_encode_close (gboolean  break_lines,
  * Encode a sequence of binary data into its Base-64 stringified
  * representation.
  *
- * Return value: (transfer full): a newly allocated, zero-terminated Base-64
+ * Returns: (transfer full): a newly allocated, zero-terminated Base-64
  *               encoded string representing @data. The returned string must
  *               be freed with g_free().
  *
@@ -309,7 +311,7 @@ static const unsigned char mime_base64_rank[256] = {
  * at least: (@len / 4) * 3 + 3 bytes (+ 3 may be needed in case of non-zero
  * state).
  *
- * Return value: The number of bytes of output that was written
+ * Returns: The number of bytes of output that was written
  *
  * Since: 2.12
  **/
@@ -391,7 +393,7 @@ g_base64_decode_step (const gchar  *in,
  * that the returned binary data is not necessarily zero-terminated,
  * so it should not be used as a character string.
  *
- * Return value: (transfer full) (array length=out_len) (element-type guint8):
+ * Returns: (transfer full) (array length=out_len) (element-type guint8):
  *               newly allocated buffer containing the binary data
  *               that @text represents. The returned buffer must
  *               be freed with g_free().
@@ -430,7 +432,7 @@ g_base64_decode (const gchar *text,
  * Decode a sequence of Base-64 encoded text into binary data
  * by overwriting the input data.
  *
- * Return value: (transfer none): The binary data that @text responds. This pointer
+ * Returns: (transfer none): The binary data that @text responds. This pointer
  *               is the same as the input @text.
  *
  * Since: 2.20