fx_submodule_doc Struct Reference

Documentation for a submodule, for use with fx_module_doc. More...

Collaboration diagram for fx_submodule_doc:

[legend]

List of all members.

Public Attributes
struct fx_module_doc *	doc
	The submodule's documentation.
const char *	key
	The submodule's name; paths allowed.
const char *	text
	Information to print on --help.

---

Detailed Description

Documentation for a submodule, 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_SUBMODULE_DOC_DONE.

See also:

fx_module_doc, fx_entry_doc, fx_init

Definition at line 175 of file fx.h.

---

Member Data Documentation

struct fx_module_doc * fx_submodule_doc::doc

The submodule's documentation.

Definition at line 179 of file fx.h.

Referenced by fx_help().

const char * fx_submodule_doc::key

The submodule's name; paths allowed.

Definition at line 177 of file fx.h.

Referenced by fx_help().

const char * fx_submodule_doc::text

Information to print on --help.

Definition at line 181 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