afs: Document ->lpr of struct afs_callback_arg.

[paraslash.git] / afs.h

diff --git a/afs.h b/afs.h
index f506cbff1076842df7d3924d02aaee1ec97ec1bc..8beca5aefcd0b9d06aed05e915877a2c5104a1a8 100644 (file)
--- a/afs.h
+++ b/afs.h
@@ -161,6 +161,14 @@ struct afs_callback_arg {
        struct osl_object query;
        /** Will be written on band SBD_OUTPUT, fully buffered. */
        struct para_buffer pbout;
        struct osl_object query;
        /** Will be written on band SBD_OUTPUT, fully buffered. */
        struct para_buffer pbout;

+       /**
+        * Convenience pointer for the deserialized parse result.
+        *
+        * Most afs command handlers call \ref send_lls_callback_request() to
+        * serialize the parse result of the subcommand and pass it to the
+        * callback. In afs context a pointer to the deserialized parse result
+        * is stored here.
+        */

        struct lls_parse_result *lpr;
 };
 
        struct lls_parse_result *lpr;
 };