From 59448b9635a1cb4e0dcc659c69935a0193cb7d7e Mon Sep 17 00:00:00 2001 From: nojhan Date: Tue, 4 Oct 2011 21:43:53 +0200 Subject: [PATCH] more doc on the parser format --- eo/src/utils/eoParser.h | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/eo/src/utils/eoParser.h b/eo/src/utils/eoParser.h index 48b18e91..e65f7566 100644 --- a/eo/src/utils/eoParser.h +++ b/eo/src/utils/eoParser.h @@ -97,6 +97,11 @@ private : This class is persistent, so it can be stored and reloaded to restore parameter settings. + Parameters can be read from argv, strings or streams, and must be specified + using the following convention: --name=value or -n=value + + You should not use space as a separator between the parameter and its value. + @ingroup Parameters */ class eoParser : public eoParameterLoader, public eoObject, public eoPersistent