[glib/docgen-fixes] docs: Use the proper Markdown syntax for lists
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [glib/docgen-fixes] docs: Use the proper Markdown syntax for lists
- Date: Mon, 2 Aug 2021 15:31:12 +0000 (UTC)
commit d6f7f8e96120478f9c32fdf5a07d082ac5b6219d
Author: Emmanuele Bassi <ebassi gnome org>
Date: Mon Aug 2 16:27:51 2021 +0100
docs: Use the proper Markdown syntax for lists
You need to separate the first entry in the list from the preceding
paragraph, and you should add a space before the enumerating symbol.
GTK-Doc accepts a very lax Markdown syntax, but any other tool parsing
our documentation will likely fail.
gio/gmemorymonitor.c | 15 ++++++++-------
1 file changed, 8 insertions(+), 7 deletions(-)
---
diff --git a/gio/gmemorymonitor.c b/gio/gmemorymonitor.c
index 37ddf48ca..cef89f7fe 100644
--- a/gio/gmemorymonitor.c
+++ b/gio/gmemorymonitor.c
@@ -42,13 +42,14 @@
* There is also an implementation for use inside Flatpak sandboxes.
*
* Possible actions to take when the signal is received are:
- * - Free caches
- * - Save files that haven't been looked at in a while to disk, ready to be reopened when needed
- * - Run a garbage collection cycle
- * - Try and compress fragmented allocations
- * - Exit on idle if the process has no reason to stay around
- * - Call [`malloc_trim(3)`](man:malloc_trim) to return cached heap pages to
- * the kernel (if supported by your libc)
+ *
+ * - Free caches
+ * - Save files that haven't been looked at in a while to disk, ready to be reopened when needed
+ * - Run a garbage collection cycle
+ * - Try and compress fragmented allocations
+ * - Exit on idle if the process has no reason to stay around
+ * - Call [`malloc_trim(3)`](man:malloc_trim) to return cached heap pages to
+ * the kernel (if supported by your libc)
*
* Note that some actions may not always improve system performance, and so
* should be profiled for your application. `malloc_trim()`, for example, may
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]