[sword-svn] r1728 - trunk/include

[mgruner at crosswire.org]

Author: mgruner
Date: 2005-02-23 06:49:32 -0700 (Wed, 23 Feb 2005)
New Revision: 1728

Modified:
   trunk/include/ftptrans.h
   trunk/include/installmgr.h
   trunk/include/treekey.h
   trunk/include/treekeyidx.h
Log:
small doc changes; installmgr and ftptrans only added so that they show 
up in the apidoc, even though they are not yet properly documented.
These four classes need to still be documented!!!!!!!!!!!!!
!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!


Modified: trunk/include/ftptrans.h
===================================================================
--- trunk/include/ftptrans.h	2005-02-23 13:13:59 UTC (rev 1727)
+++ trunk/include/ftptrans.h	2005-02-23 13:49:32 UTC (rev 1728)
@@ -15,17 +15,21 @@
 
 SWORD_NAMESPACE_START
 
-//class for reporting status
+/** Class for reporting status
+*/
 class StatusReporter {
 public:
-	// Messages before stages of a batch download
+	/** Messages before stages of a batch download */
 	virtual void preStatus(long totalBytes, long completedBytes, const char *message);
 	
-	// frequently called throughout a download, to report status
+	/** frequently called throughout a download, to report status */
 	virtual void statusUpdate(double dtTotal, double dlNow);
 };
 
 
+/** TODO: document
+* A base class to be used for reimplementation of network services.
+*/
 class FTPTransport {
 
 protected:

Modified: trunk/include/installmgr.h
===================================================================
--- trunk/include/installmgr.h	2005-02-23 13:13:59 UTC (rev 1727)
+++ trunk/include/installmgr.h	2005-02-23 13:49:32 UTC (rev 1728)
@@ -12,7 +12,8 @@
 class SWMgr;
 class SWConfig;
 
-
+/** TODO: document
+*/
 class InstallSource {
 	SWMgr *mgr;
 public:
@@ -33,6 +34,8 @@
 
 typedef std::map<SWBuf, InstallSource *> InstallSourceMap;
 
+/** TODO: document
+*/
 class InstallMgr {
 
 protected:

Modified: trunk/include/treekey.h
===================================================================
--- trunk/include/treekey.h	2005-02-23 13:13:59 UTC (rev 1727)
+++ trunk/include/treekey.h	2005-02-23 13:49:32 UTC (rev 1728)
@@ -31,8 +31,8 @@
 SWORD_NAMESPACE_START
 
 /**
- * Class VerseKey
- * The SWKey implementation used for verse based modules like Bibles or commentaries.
+ * Class TreeKey
+ * The base class for all tree-based key implementations in Sword.
  */
 class SWDLLEXPORT TreeKey : public SWKey {
 	static SWClass classdef;

Modified: trunk/include/treekeyidx.h
===================================================================
--- trunk/include/treekeyidx.h	2005-02-23 13:13:59 UTC (rev 1727)
+++ trunk/include/treekeyidx.h	2005-02-23 13:49:32 UTC (rev 1728)
@@ -30,8 +30,8 @@
 SWORD_NAMESPACE_START
 
 /**
- * Class VerseKey
- * The SWKey implementation used for verse based modules like Bibles or commentaries.
+ * Class TreeKeyIdx
+ * The TreeKey implementation used for all tree-based modules in Sword, such as GenBooks.
  */
 class SWDLLEXPORT TreeKeyIdx : public TreeKey {