[glib: 12/16] docs: Fix formatting of some literals and properties
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib: 12/16] docs: Fix formatting of some literals and properties
- Date: Mon, 26 Nov 2018 11:51:11 +0000 (UTC)
commit 79aead142f2b2f1555e5b0c0f14af53221b142e4
Author: Philip Withnall <withnall endlessm com>
Date: Fri Nov 23 13:29:30 2018 +0000
docs: Fix formatting of some literals and properties
Using `%` indicates that you’re linking to a symbol. In these cases we
wanted some nicely formatted literals, or a link to a specific property.
Use backticks for the literals, and link to the property fully.
Signed-off-by: Philip Withnall <withnall endlessm com>
gio/gcancellable.c | 2 +-
gio/gdatainputstream.c | 14 +++++++-------
gio/gtlsdatabase.c | 2 +-
3 files changed, 9 insertions(+), 9 deletions(-)
---
diff --git a/gio/gcancellable.c b/gio/gcancellable.c
index 48c736cca..de6d43495 100644
--- a/gio/gcancellable.c
+++ b/gio/gcancellable.c
@@ -339,7 +339,7 @@ g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
*
* See also g_cancellable_make_pollfd().
*
- * Returns: A valid file descriptor. %-1 if the file descriptor
+ * Returns: A valid file descriptor. `-1` if the file descriptor
* is not supported, or on errors.
**/
int
diff --git a/gio/gdatainputstream.c b/gio/gdatainputstream.c
index 9f207b158..c2b19fdc9 100644
--- a/gio/gdatainputstream.c
+++ b/gio/gdatainputstream.c
@@ -323,7 +323,7 @@ read_data (GDataInputStream *stream,
*
* Reads an unsigned 8-bit/1-byte value from @stream.
*
- * Returns: an unsigned 8-bit/1-byte value read from the @stream or %0
+ * Returns: an unsigned 8-bit/1-byte value read from the @stream or `0`
* if an error occurred.
**/
guchar
@@ -353,7 +353,7 @@ g_data_input_stream_read_byte (GDataInputStream *stream,
* In order to get the correct byte order for this read operation,
* see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
*
- * Returns: a signed 16-bit/2-byte value read from @stream or %0 if
+ * Returns: a signed 16-bit/2-byte value read from @stream or `0` if
* an error occurred.
**/
gint16
@@ -397,7 +397,7 @@ g_data_input_stream_read_int16 (GDataInputStream *stream,
* In order to get the correct byte order for this read operation,
* see g_data_input_stream_get_byte_order() and g_data_input_stream_set_byte_order().
*
- * Returns: an unsigned 16-bit/2-byte value read from the @stream or %0 if
+ * Returns: an unsigned 16-bit/2-byte value read from the @stream or `0` if
* an error occurred.
**/
guint16
@@ -445,7 +445,7 @@ g_data_input_stream_read_uint16 (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: a signed 32-bit/4-byte value read from the @stream or %0 if
+ * Returns: a signed 32-bit/4-byte value read from the @stream or `0` if
* an error occurred.
**/
gint32
@@ -493,7 +493,7 @@ g_data_input_stream_read_int32 (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: an unsigned 32-bit/4-byte value read from the @stream or %0 if
+ * Returns: an unsigned 32-bit/4-byte value read from the @stream or `0` if
* an error occurred.
**/
guint32
@@ -541,7 +541,7 @@ g_data_input_stream_read_uint32 (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: a signed 64-bit/8-byte value read from @stream or %0 if
+ * Returns: a signed 64-bit/8-byte value read from @stream or `0` if
* an error occurred.
**/
gint64
@@ -589,7 +589,7 @@ g_data_input_stream_read_int64 (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned.
*
- * Returns: an unsigned 64-bit/8-byte read from @stream or %0 if
+ * Returns: an unsigned 64-bit/8-byte read from @stream or `0` if
* an error occurred.
**/
guint64
diff --git a/gio/gtlsdatabase.c b/gio/gtlsdatabase.c
index 4725d8c81..821af97e0 100644
--- a/gio/gtlsdatabase.c
+++ b/gio/gtlsdatabase.c
@@ -779,7 +779,7 @@ g_tls_database_lookup_certificate_for_handle_finish (GTlsDatabase *se
*
* Lookup the issuer of @certificate in the database.
*
- * The %issuer property
+ * The #GTlsCertificate:issuer property
* of @certificate is not modified, and the two certificates are not hooked
* into a chain.
*
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]