summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorBoris Kolpackov <boris@codesynthesis.com>2011-01-23 14:39:19 +0200
committerBoris Kolpackov <boris@codesynthesis.com>2011-01-23 14:39:19 +0200
commit8027e319831f02538fe431b5870d90c0267b3b78 (patch)
tree3ffb2c9f47b188cc361febffb7a24f45cec5321b /doc
parent0267ede2d356abdef7b3e9af19d4725605a58947 (diff)
Allow the options file search function to ignore the file
Diffstat (limited to 'doc')
-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&amp; argc,