Merge remote branch 'refs/remotes/fml/master'

[paraslash.git] / write.h

diff --git a/write.h b/write.h
index 936d99c0a45cc1bcc166e97fbb4552d2545182ca..1361fcf1d052b31596f1407a81cc485b5fa833e1 100644 (file)
--- a/write.h
+++ b/write.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2006-2009 Andre Noll <maan@systemlinux.org>
+ * Copyright (C) 2006-2010 Andre Noll <maan@systemlinux.org>
  *
  * Licensed under the GPL v2. For licencing details see COPYING.
  */
@@ -39,10 +39,15 @@ struct writer {
         * It should check whether the command line options given by \a options are
         * valid.  On success, it should return a pointer to the writer-specific
         * configuration data determined by \a options.  Note that this might be called
-        * more than once with different values of \a options.
+        * more than once with different values of \a options. \sa \ref free_config().
         */
        void *(*parse_config)(const char *options);
-       void (*free_config)(void *conf);
+       /**
+        * Dellocate all configuration resources.
+        *
+        * This should free whatever was allocated by \ref parse_config().
+        */
+       void (*free_config)(void *config);
        /**
         * Open one instance of this writer.
         *