From: Andre Noll <maan@tuebingen.mpg.de>
Date: Mon, 26 Mar 2018 23:23:07 +0000 (+0200)
Subject: afs: Document ->lpr of struct afs_callback_arg.
X-Git-Tag: v0.6.2~23
X-Git-Url: http://git.tue.mpg.de/?a=commitdiff_plain;h=e8d5da94efd6cbb0aa75f57290c76d9992ff8f47;p=paraslash.git

afs: Document ->lpr of struct afs_callback_arg.

This should have been documented when the ->lpr member was introduced
two years ago in commit ba0a963f (server: Convert com_add() to lopsub).
---

diff --git a/afs.h b/afs.h
index f506cbff..8beca5ae 100644
--- 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;
+	/**
+	 * 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;
 };