help::help_manager::implementation Class Reference

Public Member Functions
const section &	regenerate ()
	Regenerates the cached help topics if necessary. More...

Private Attributes
std::size_t	last_num_encountered_units_ {0}
std::size_t	last_num_encountered_terrains_ {0}
boost::tribool	last_debug_state_ {boost::indeterminate}
section	toplevel_section_
	The default toplevel. More...
section	hidden_sections_
	All sections and topics not referenced from the default toplevel. More...

Friends
class	help_manager

Detailed Description

Definition at line 93 of file help.cpp.

Member Function Documentation

regenerate()

const section & help::help_manager::implementation::regenerate

(

)

Regenerates the cached help topics if necessary.

Returns

the current toplevel section.

Definition at line 118 of file help.cpp.

References unit_type_data::build_all(), game_config::debug, prefs::encountered_terrains(), prefs::encountered_units(), help::generate_contents(), prefs::get(), unit_type::HELP_INDEXED, hidden_sections_, last_debug_state_, last_num_encountered_terrains_, last_num_encountered_units_, toplevel_section_, and unit_types.

Friends And Related Function Documentation

help_manager

friend class help_manager

friend

Definition at line 96 of file help.cpp.

Member Data Documentation

hidden_sections_

section help::help_manager::implementation::hidden_sections_

private

All sections and topics not referenced from the default toplevel.

Definition at line 115 of file help.cpp.

Referenced by regenerate().

last_debug_state_

boost::tribool help::help_manager::implementation::last_debug_state_ {boost::indeterminate}

private

Definition at line 109 of file help.cpp.

Referenced by regenerate().

last_num_encountered_terrains_

std::size_t help::help_manager::implementation::last_num_encountered_terrains_ {0}

private

Definition at line 107 of file help.cpp.

Referenced by regenerate().

last_num_encountered_units_

std::size_t help::help_manager::implementation::last_num_encountered_units_ {0}

private

Definition at line 106 of file help.cpp.

Referenced by regenerate().

toplevel_section_

section help::help_manager::implementation::toplevel_section_

private

The default toplevel.

Definition at line 112 of file help.cpp.

Referenced by regenerate().

---

The documentation for this class was generated from the following file:

• help/help.cpp