fx_entry_doc Struct Reference

Documentation for an entry, for use with fx_module_doc. More...

List of all members.

Public Attributes
const char *	key
	The entry's name; paths allowed.
const char *	meta
	Currently unused; constraints on val.
fx_mod_t	mod_type
	The entry's usage type, e.g.
const char *	text
	Information to print on --help.
fx_val_t	val_type
	The entry's data type, e.g.

---

Detailed Description

Documentation for an entry, for use with fx_module_doc.

You should define a constant list of these at the top of any file/class that makes use of an fx_module. Such lists should be terminated by FX_ENTRY_DOC_DONE.

See also:

fx_module_doc, fx_submodule_doc, fx_init

Definition at line 153 of file fx.h.

---

Member Data Documentation

const char * fx_entry_doc::key

The entry's name; paths allowed.

Definition at line 155 of file fx.h.

Referenced by fx_help().

const char * fx_entry_doc::meta

Currently unused; constraints on val.

Definition at line 161 of file fx.h.

fx_mod_t fx_entry_doc::mod_type

The entry's usage type, e.g.

FX_REQUIRED.

Definition at line 157 of file fx.h.

Referenced by fx_help().

const char * fx_entry_doc::text

Information to print on --help.

Definition at line 163 of file fx.h.

Referenced by fx_help().

fx_val_t fx_entry_doc::val_type

The entry's data type, e.g.

FX_INT.

Definition at line 159 of file fx.h.

Referenced by fx_help().

---

The documentation for this struct was generated from the following files:

• fastlib/fx/fx.h
• include/fastlib/fx/fx.h