doxy

include/netcdf_filter.h

@@ -141,7 +141,7 @@ EXTERNL int nc_plugin_path_finalize(void);
  * Since this function does not modify the plugin path, it can be called at any time.
  * @param formatx specify which dispatch implementatio to read: currently NC_FORMATX_NC_HDF5 or NC_FORMATX_NCZARR.
  * @param ndirsp return the number of dirs in the internal path list
- * @param dirsp return the sequence of directies in the internal path list; caller must free.
+ * @param dirs memory for storing the sequence of directies in the internal path list.
  * @return NC_NOERR
  * @author Dennis Heimbigner
  *

libdispatch/dplugins.c

@@ -166,24 +166,6 @@ nc_plugin_path_finalize(void)
  * with ndirsp not NULL and dirs set to NULL to get the size of
  * the path list. The second time with dirs not NULL to get the
  * actual sequence of paths.
-
-Note also that modifying the plugin paths must be done "atomically".
-That is, in a multi-threaded environment, it is important that
-the sequence of actions involved in setting up the plugin paths
-must be done by a single processor or in some other way as to
-guarantee that two or more processors are not simultaneously
-accessing the plugin path read/write operations.
-
-As an example, assume there exists a mutex lock called PLUGINLOCK.
-Then any processor accessing the plugin paths should operate
-as follows:
-````
-lock(PLUGINLOCK);
-nc_plugin_path_read(...);
-<rebuild plugin path>
-nc_plugin_path_write(...);
-unlock(PLUGINLOCK);
-````
 */
 
 EXTERNL int
@@ -217,6 +199,24 @@ nc_plugin_path_read(int formatx, size_t* ndirsp, char** dirs)
  * @return ::NC_EINVAL if formatx is unknown or ndirs > 0 and dirs == NULL
  *
  * @author Dennis Heimbigner
+ * 
+ * Note that modifying the plugin paths must be done "atomically".
+ * That is, in a multi-threaded environment, it is important that
+ * the sequence of actions involved in setting up the plugin paths
+ * must be done by a single processor or in some other way as to
+ * guarantee that two or more processors are not simultaneously
+ * accessing the plugin path read/write operations.
+ * 
+ * As an example, assume there exists a mutex lock called PLUGINLOCK.
+ * Then any processor accessing the plugin paths should operate
+ * as follows:
+ * <pre>
+ * lock(PLUGINLOCK);
+ * nc_plugin_path_read(...);
+ * <rebuild plugin path>
+ * nc_plugin_path_write(...);
+ * unlock(PLUGINLOCK);
+ * </pre>
 */
 
 EXTERNL int