Changeset - 13880b12fb9b
[Not reviewed]
default
0 1 0
Nathan Brink (binki) - 16 years ago 2009-07-25 16:16:31
ohnobinki@ohnopublishing.net
fixed up options.h docs
1 file changed with 2 insertions and 2 deletions:
0 comments (0 inline, 0 general)
src/common/options.h
Show inline comments
 
@@ -38,25 +38,25 @@ struct options_common
 
  struct remoteio_opts *remoteio;
 
  struct client_opts *client;
 
  struct daemon_opts *daemon;
 
};
 

	
 
/**
 
  This function needs to eat some of your arguments to it, just like gtk+ and other libs like to. It particularly needs to be able to find the location of the config file, which should be taken from arguments if it's there. The argument list will have members that I recognize removed.
 

	
 
  Options should be kept alive during the program's life.
 

	
 
  \param mycfg will be set to the section of the configuration file specific to the caller (client or server specific section). Who is supposed to free this variable?
 
  \param myopts holds the caller's confuse option declarations
 
  \param myname holds the name of the section of the config file that refers to mycfg and myopts
 
  \param myname holds the name of the section of the config file that refers to mycfg and myopts -- currently ``slave'', ``client'', and ``server'' are valid
 

	
 
  \param allopts will be set to a pointer that many functions need for operation
 
  \param argc the argc that was passed to main()
 
  \param argc the argc that was passed to main() -- these will be used to determine the location of the config file
 
  \param argv the argv that was passed to main()
 
 */
 
int options_init(int argc, char *argv[], cfg_t **mycfg, cfg_opt_t *myopts, char *myname, struct options_common **allopts);
 

	
 
/**
 
   Frees the struct options_common. This should be run before the program exits.
 
 */
 
int options_free(struct options_common *allopts);
 
#endif
0 comments (0 inline, 0 general)