diff options
Diffstat (limited to 'include/swmodule.h')
| -rw-r--r-- | include/swmodule.h | 12 |
1 files changed, 11 insertions, 1 deletions
diff --git a/include/swmodule.h b/include/swmodule.h index 9c733dc..7bbdd32 100644 --- a/include/swmodule.h +++ b/include/swmodule.h @@ -4,7 +4,7 @@ * all types of modules (e.g. texts, commentaries, maps, * lexicons, etc.) * - * $Id: swmodule.h 2944 2013-08-03 09:43:40Z scribe $ + * $Id: swmodule.h 3287 2014-12-03 06:16:12Z greg.hellings $ * * Copyright 1997-2013 CrossWire Bible Society (http://www.crosswire.org) * CrossWire Bible Society @@ -194,6 +194,16 @@ public: // are not comfortable with, or don't wish to use stl maps). virtual void setConfig(ConfigEntMap *config); virtual const ConfigEntMap &getConfig() const { return *config; } + + /** + * Gets a configuration property about a module. These entries are primarily + * pulled from the module's .conf file, but also includes 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; /** |