More KDOC documentation in headers.

1 files changed, 26 insertions, 3 deletions

diff --git a/lib/rfsvfactory.h b/lib/rfsvfactory.h
index 17b7252..99136e3 100644
--- a/lib/rfsvfactory.h
+++ b/lib/rfsvfactory.h
@@ -5,13 +5,36 @@
 
 class ppsocket;
 
+/**
+ * A factory for automatically instantiating the correct
+ * @ref rfsv protocol variant depending on the connected Psion.
+ */
 class rfsvfactory {
-	public:
+ public:
+	/**
+	 * Constructs a rfsvfactory.
+	 *
+	 * @param skt The socket to be used for connecting
+	 * to the ncpd daemon.
+	 */
 	rfsvfactory(ppsocket * skt);
+
+	/**
+	 * Creates a new @ref rfsv instance.
+	 *
+	 * @param reconnect Set to true, if automatic reconnect
+	 * should be performed on failure.
+	 *
+	 * @returns A pointer to a newly created rfsv instance or
+	 * NULL on failure.
+	 */
 	virtual rfsv * create(bool);
 
-	private:
-	// Vars
+ private:
+	/**
+	 * The socket to be used for connecting to the
+	 * ncpd daemon.
+	 */
 	ppsocket *skt;
 	int serNum;
 };