[librsvg: 8/9] Toplevel module docs for rsvg-features




commit 2de689633c282bfe2507704fb365c32e56d2f0e4
Author: Federico Mena Quintero <federico gnome org>
Date:   Fri Sep 18 15:21:49 2020 -0500

    Toplevel module docs for rsvg-features

 librsvg/librsvg-features.c | 17 +++++++++++++++++
 1 file changed, 17 insertions(+)
---
diff --git a/librsvg/librsvg-features.c b/librsvg/librsvg-features.c
index b78f2806..54c68c71 100644
--- a/librsvg/librsvg-features.c
+++ b/librsvg/librsvg-features.c
@@ -1,3 +1,20 @@
+/**
+ * SECTION: rsvg-features
+ * @short_description: Check for the version of librsvg being used.
+ *
+ * Librsvg provides a few C macros that C and C++ programs can use to
+ * check the version being used at compile-time, that is, the API that
+ * the program expects to have.  This is useful for programs that need
+ * to conditionally compile code with <literal>#ifdef</literal> blocks
+ * depending on the version of librsvg that may be available during
+ * compilation.
+ *
+ * Librsvg also provides a few global constants that can be used to
+ * check the version of librsvg being used at run-time.  This is
+ * useful to know which version of librsvg is actually being used on
+ * the system where the program is running.
+ */
+
 #include "rsvg.h"
 
 /**


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]