aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorLorenz Meier <lm@inf.ethz.ch>2012-08-20 07:50:56 +0200
committerLorenz Meier <lm@inf.ethz.ch>2012-08-20 07:50:56 +0200
commitfd04ab0d443cd57a997aae393e116bd3435cef0b (patch)
treeb23fb6e6d254ed090052a0ab402baa67fb3e63ad
parentc729bf98fee00b3decbc178cbd5a3f9b96a064a1 (diff)
downloadpx4-firmware-fd04ab0d443cd57a997aae393e116bd3435cef0b.tar.gz
px4-firmware-fd04ab0d443cd57a997aae393e116bd3435cef0b.tar.bz2
px4-firmware-fd04ab0d443cd57a997aae393e116bd3435cef0b.zip
Fixed / extended comments
-rw-r--r--apps/systemlib/param/param.h6
1 files changed, 4 insertions, 2 deletions
diff --git a/apps/systemlib/param/param.h b/apps/systemlib/param/param.h
index 0d94ce6e3..bc62f2b79 100644
--- a/apps/systemlib/param/param.h
+++ b/apps/systemlib/param/param.h
@@ -101,7 +101,7 @@ __EXPORT int param_set(param_t param, void *val);
__EXPORT int param_export(const char *filename, bool only_unsaved);
/**
- * Import parameters from a file, discarding any unrecognised parameters.
+ * Import parameters from a file, discarding any unrecognized parameters.
*
* @param filename The name of the file to import from.
* @return Zero on success, nonzero if an error occurred during import.
@@ -112,7 +112,9 @@ __EXPORT int param_import(const char *filename);
/**
* Apply a function to each parameter.
*
- * Note that the parameter set is not locked during the traversal.
+ * Note that the parameter set is not locked during the traversal. It also does
+ * not hold an internal state, so the callback function can block or sleep between
+ * parameter callbacks.
*
* @param func The function to invoke for each parameter.
* @param arg Argument passed to the function.