summaryrefslogtreecommitdiff
path: root/doc/guide/index.xhtml
diff options
context:
space:
mode:
Diffstat (limited to 'doc/guide/index.xhtml')
-rw-r--r--doc/guide/index.xhtml10
1 files changed, 7 insertions, 3 deletions
diff --git a/doc/guide/index.xhtml b/doc/guide/index.xhtml
index bc215e3..638b65b 100644
--- a/doc/guide/index.xhtml
+++ b/doc/guide/index.xhtml
@@ -743,9 +743,13 @@ namespace cli
struct option_info
{
- const char* option;
- std::string (*search_func) (const char*, void* arg);
- void* arg;
+ // If search_func is not NULL, it is called, with the arg
+ // value as the second argument, to locate the options file.
+ // If it returns an empty string, then the file is ignored.
+ //
+ const char* option;
+ std::string (*search_func) (const char*, void* arg);
+ void* arg;
};
argv_file_scanner (int& argc,