[sword-svn] r3286 - in branches/sword-1-7-x: . include

[greg.hellings at crosswire.org]

Author: greg.hellings
Date: 2014-12-02 23:15:55 -0700 (Tue, 02 Dec 2014)
New Revision: 3286

Modified:
   branches/sword-1-7-x/
   branches/sword-1-7-x/include/swmodule.h
Log:
Merged r3272



Property changes on: branches/sword-1-7-x
___________________________________________________________________
Modified: svn:mergeinfo
   - /trunk:2989-2991,2997,3001-3004,3006,3010-3020,3026-3039,3045-3046,3048,3056,3058-3062,3067,3073,3077-3081,3085-3086,3091,3094,3097-3099,3102,3104,3106-3108,3110,3115,3118-3121,3126-3127,3131-3135,3140,3144,3151,3153-3155,3190-3192,3198-3199,3202-3203,3225,3230,3232-3234,3236,3238-3239,3242,3244,3256-3257
   + /trunk:2989-2991,2997,3001-3004,3006,3010-3020,3026-3039,3045-3046,3048,3056,3058-3062,3067,3073,3077-3081,3085-3086,3091,3094,3097-3099,3102,3104,3106-3108,3110,3115,3118-3121,3126-3127,3131-3135,3140,3144,3151,3153-3155,3190-3192,3198-3199,3202-3203,3225,3230,3232-3234,3236,3238-3239,3242,3244,3256-3257,3272

Modified: branches/sword-1-7-x/include/swmodule.h
===================================================================
--- branches/sword-1-7-x/include/swmodule.h	2014-12-03 06:14:50 UTC (rev 3285)
+++ branches/sword-1-7-x/include/swmodule.h	2014-12-03 06:15:55 UTC (rev 3286)
@@ -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;
 
 	/**