[sword-svn] r3272 - trunk/include

[scribe at crosswire.org]

Author: scribe
Date: 2014-10-29 07:40:21 -0700 (Wed, 29 Oct 2014)
New Revision: 3272

Modified:
   trunk/include/swmodule.h
Log:
added comments for getConfigEntry, including information about
PrefixPath and AbsoluteDataPath

Modified: trunk/include/swmodule.h
===================================================================
--- trunk/include/swmodule.h	2014-10-11 21:12:39 UTC (rev 3271)
+++ trunk/include/swmodule.h	2014-10-29 14:40:21 UTC (rev 3272)
@@ -194,6 +194,16 @@
 	// are not comfortable with, or don't wish to use  stl maps).
 	virtual void setConfig(ConfigEntMap *config);
 	virtual const ConfigEntMap &getConfig() const { return *config; }
+
+	/**
+	 * Get's a configuration property about a module.  These entries are primarily
+	 * pulled from the modules .conf file, but also include some virtual entries
+	 * such as:
+	 * 	PrefixPath - the absolute filesystem path to the sword module repository
+	 *	location where this module is located.
+	 *	AbsoluteDataPath - the full path to the root folder where the module
+	 *	data is stored.
+	 */
 	virtual const char *getConfigEntry(const char *key) const;
 
 	/**