luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-02-09 04:15:49 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Fix formatting of some literals and properties

Browse Source 
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>
This commit is contained in:
Philip Withnall 2018-11-23 13:29:30 +00:00
parent e88c2d1ab5
commit 79aead142f
3 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
gio/gcancellable.c
View File

@ -339,7 +339,7 @@ g_cancellable_set_error_if_cancelled (GCancellable *cancellable,
* *
* See also g_cancellable_make_pollfd(). * 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. * is not supported, or on errors.
**/ **/
int int

14
gio/gdatainputstream.c
View File

@ -323,7 +323,7 @@ read_data (GDataInputStream *stream,
* *
* Reads an unsigned 8-bit/1-byte value from @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. * if an error occurred.
**/ **/
guchar 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, * 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(). * 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. * an error occurred.
**/ **/
gint16 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, * 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(). * 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. * an error occurred.
**/ **/
guint16 guint16
@ -445,7 +445,7 @@ g_data_input_stream_read_uint16 (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * 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. * an error occurred.
**/ **/
gint32 gint32
@ -493,7 +493,7 @@ g_data_input_stream_read_int32 (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * 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. * an error occurred.
**/ **/
guint32 guint32
@ -541,7 +541,7 @@ g_data_input_stream_read_uint32 (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * 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. * an error occurred.
**/ **/
gint64 gint64
@ -589,7 +589,7 @@ g_data_input_stream_read_int64 (GDataInputStream *stream,
* triggering the cancellable object from another thread. If the operation * triggering the cancellable object from another thread. If the operation
* was cancelled, the error %G_IO_ERROR_CANCELLED will be returned. * 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. * an error occurred.
**/ **/
guint64 guint64

2
gio/gtlsdatabase.c
View File

@ -779,7 +779,7 @@ g_tls_database_lookup_certificate_for_handle_finish (GTlsDatabase *se
* *
* Lookup the issuer of @certificate in the database. * 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 * of @certificate is not modified, and the two certificates are not hooked
* into a chain. * into a chain.
* *