Unverified Commit 40a9d051 authored by Liz Decolvenaere's avatar Liz Decolvenaere Committed by GitHub
Browse files

Fixed docs for colon/semicolon separated paths

Fixed the documentation. I should probably go add commentary in a README or something denoting that OPENMM_PLUGIN_DIR can take :'s.
parent 62cf58b8
...@@ -213,26 +213,24 @@ public: ...@@ -213,26 +213,24 @@ public:
*/ */
static void loadPluginLibrary(const std::string& file); static void loadPluginLibrary(const std::string& file);
/** /**
* Load multiple dynamic libraries (DLLs) which contain OpenMM plugins from a single directory. * Load multiple dynamic libraries (DLLs) which contain OpenMM plugins from one or more directories.
* This method loops over every file contained in the specified directory and calls loadPluginLibrary() * Multiple fully-qualified paths can be joined together with ':' on unix-like systems
* (or ';' on windows-like systems); each will be searched for plugins, in-order. For example,
* '/foo/plugins:/bar/plugins' will search both `/foo/plugins` and `/bar/plugins`. If an
* identically-named plugin is encountered twice it will be loaded at both points; be careful!!!
*
* This method loops over every file contained in the specified directories and calls loadPluginLibrary()
* for each one. If an error occurs while trying to load a particular file, that file is simply * for each one. If an error occurs while trying to load a particular file, that file is simply
* ignored. You can retrieve a list of all such errors by calling getPluginLoadFailures(). * ignored. You can retrieve a list of all such errors by calling getPluginLoadFailures().
* *
* @param directory the path to the directory containing libraries to load * @param directory a ':' (unix) or ';' (windows) deliminated list of paths containing libraries to load
* @return the names of all files which were successfully loaded as libraries * @return the names of all files which were successfully loaded as libraries
*/ */
static std::vector<std::string> loadPluginsFromDirectory(const std::string& directory); static std::vector<std::string> loadPluginsFromDirectory(const std::string& directory);
/** /**
* Get the default directory from which to load plugins. If the environment variable * Get the default directory from which to load plugins. If the environment variable
* OPENMM_PLUGIN_DIR is set, this returns its value. Otherwise, it returns a platform * OPENMM_PLUGIN_DIR is set, this returns its value. Otherwise, it returns a platform
* specific default location. * specific default location.
*
* On unix-like systems, OPENMM_PLUGIN_DIR is allowed to either be a
* single, fully-qualified path (e.g., /foo/plugins) or a ':'-concatenated
* set of fully-qualified paths (e.g., /foo/plugins:bar/plugins). On
* windows-like systems, the same is true, but the path separator is '\\'
* and the path concatenator is ';'. If an identically-named plugin is
* encountered twice it will be loaded at both points; be careful!!!
* *
* @return the path to the default plugin directory * @return the path to the default plugin directory
*/ */
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment