Completed doxygen conversion of the documentation for the libgedcom part.

[gedcom-parse.git] / gedcom / compat.c

diff --git a/gedcom/compat.c b/gedcom/compat.c
index ce45d41195543c56e3f7c50fd9336b5fb5259331..c53465b609319744a7ed2ab63f4e051a7b94562d 100644 (file)
--- a/gedcom/compat.c
+++ b/gedcom/compat.c
@@ -162,11 +162,22 @@ union _COMPAT_STATE {
 
 /* Compatibility handling */
 
+/** Allows to enable/disable the compatibility mode.
+
+    \param enable_compat  This argument can be:
+      - 0  Disable compatibility mode
+      - 1  Allow compatibility mode (this is the default)
+ */
 void gedcom_set_compat_handling(int enable_compat)
 {
   compat_enabled = enable_compat;
 }
 
+/** Allows to set some options for the compatibility handling.
+
+    \param options  Can be an OR'ed combination of the options listed defined
+    by the enum \ref Gedcom_compat.
+*/
 void gedcom_set_compat_options(Gedcom_compat options)
 {
   compat_options = options;