From d4444ef0a671e19aa2ec9266ad8254e8761357db Mon Sep 17 00:00:00 2001
From: Fritz Elfert <felfert@to.com>
Date: Sun, 4 Feb 2001 04:43:28 +0000
Subject: More KDOC documentation in headers.

---
 lib/rfsv16.h      |  5 +++++
 lib/rfsv32.h      |  5 +++++
 lib/rfsvfactory.h | 29 ++++++++++++++++++++++++++---
 lib/rpcs.h        |  6 ++----
 lib/rpcs16.h      | 17 +++++++++++------
 lib/rpcs32.h      |  5 +++++
 lib/rpcsfactory.h | 48 ++++++++++++++++++++++++------------------------
 7 files changed, 78 insertions(+), 37 deletions(-)

(limited to 'lib')

diff --git a/lib/rfsv16.h b/lib/rfsv16.h
index 00de31e..33aba60 100644
--- a/lib/rfsv16.h
+++ b/lib/rfsv16.h
@@ -3,6 +3,11 @@
 
 #include "rfsv.h"
 
+/**
+ * This is the implementation of the @rfsv protocol for
+ * Psion series 3 (SIBO) variant.
+ * For a complete documentation, see @ref rfsv .
+ */
 class rfsv16 : public rfsv {
 public:
 	rfsv16(ppsocket *);
diff --git a/lib/rfsv32.h b/lib/rfsv32.h
index 0e9cf64..4df18b3 100644
--- a/lib/rfsv32.h
+++ b/lib/rfsv32.h
@@ -4,6 +4,11 @@
 #include "rfsv.h"
 #include "plpdirent.h"
 
+/**
+ * This is the implementation of the @rfsv protocol for
+ * Psion series 5 (EPOC) variant.
+ * For a complete documentation, see @ref rfsv .
+ */
 class rfsv32 : public rfsv {
 
 public:
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;
 };
diff --git a/lib/rpcs.h b/lib/rpcs.h
index 83a8732..4547cd1 100644
--- a/lib/rpcs.h
+++ b/lib/rpcs.h
@@ -20,7 +20,7 @@ class bufferArray;
  * variants are implemented in
  * @ref rpcs32 or @ref rpcs16 respectively.
  * These normally are instantiated by using
- * @ref rpcsfactory.
+ * @ref rpcsfactory .
  */
 class rpcs {
 	public:
@@ -202,6 +202,7 @@ class rpcs {
 		 * @returns A psion error code. 0 = Ok.
 		 */
 		Enum<rfsv::errs> stopProgram(const char *);
+
 		Enum<rfsv::errs> queryProgram(const char *);
 		Enum<rfsv::errs> formatOpen(const char *, int &, int &);
 		Enum<rfsv::errs> formatRead(int);
@@ -275,9 +276,6 @@ class rpcs {
 		 * @return Psion error code. 0 = Ok.
 		 */
 		virtual Enum<rfsv::errs> getCmdLine(const char *process, bufferStore &ret) = 0; 
-
-		// API only existent on EPOC
-		// default-methods for SIBO here.
 		/**
 		 * Retrieve general Information about the connected
 		 * machine.
diff --git a/lib/rpcs16.h b/lib/rpcs16.h
index efc6b99..7085939 100644
--- a/lib/rpcs16.h
+++ b/lib/rpcs16.h
@@ -6,13 +6,18 @@
 class ppsocket;
 class bufferStore;
 
+/**
+ * This is the implementation of the @ref rpcs protocol for
+ * Psion series 3 (SIBO) variant.
+ * For a complete documentation, see @ref rpcs .
+ */
 class rpcs16 : public rpcs {
-	public:
-		rpcs16(ppsocket *);
-		~rpcs16();
-
-		Enum<rfsv::errs> queryDrive(const char, bufferArray &);
-		Enum<rfsv::errs> getCmdLine(const char *, bufferStore &); 
+ public:
+	rpcs16(ppsocket *);
+	~rpcs16();
+	
+	Enum<rfsv::errs> queryDrive(const char, bufferArray &);
+	Enum<rfsv::errs> getCmdLine(const char *, bufferStore &); 
 };
 
 #endif
diff --git a/lib/rpcs32.h b/lib/rpcs32.h
index 3b2a3f7..0cab1b2 100644
--- a/lib/rpcs32.h
+++ b/lib/rpcs32.h
@@ -5,6 +5,11 @@
 
 class ppsocket;
 
+/**
+ * This is the implementation of the @ref rpcs protocol for
+ * Psion series 5 (EPOC) variant.
+ * For a complete documentation, see @ref rpcs .
+ */
 class rpcs32 : public rpcs {
 	public:
 		rpcs32(ppsocket *);
diff --git a/lib/rpcsfactory.h b/lib/rpcsfactory.h
index feffaee..d57eb29 100644
--- a/lib/rpcsfactory.h
+++ b/lib/rpcsfactory.h
@@ -10,32 +10,32 @@ class ppsocket;
  * variant depending on the connected Psion.
  */
 class rpcsfactory {
-	public:
-		/**
-		 * Constructs a rpcsfactory.
-		 *
-		 * @param skt The socket to be used for connecting
-		 * to the ncpd daemon.
-		 */
-		rpcsfactory(ppsocket * skt);
+ public:
+	/**
+	 * Constructs a rpcsfactory.
+	 *
+	 * @param skt The socket to be used for connecting
+	 * to the ncpd daemon.
+	 */
+	rpcsfactory(ppsocket * skt);
 
-		/**
-		 * Creates a new rpsc instance.
-		 *
-		 * @param reconnect Set to true, if automatic reconnect
-		 * should be performed on failure.
-		 *
-		 * @returns A pointer to a newly created rpcs instance or
-		 * NULL on failure.
-		 */
-		virtual rpcs * create(bool reconnect);
+	/**
+	 * Creates a new rpcs instance.
+	 *
+	 * @param reconnect Set to true, if automatic reconnect
+	 * should be performed on failure.
+	 *
+	 * @returns A pointer to a newly created rpcs instance or
+	 * NULL on failure.
+	 */
+	virtual rpcs * create(bool reconnect);
 
-	private:
-		/**
-		 * The socket to be used for connecting to the
-		 * ncpd daemon.
-		 */
-		ppsocket *skt;
+ private:
+	/**
+	 * The socket to be used for connecting to the
+	 * ncpd daemon.
+	 */
+	ppsocket *skt;
 };
 
 #endif
-- 
cgit v1.2.3