ESLA

Embeddable Scriting LAnguage

frantz@pangea.stanford.edu

Stanford University, Rock Fracture Project research group

© 2003

HelpDisplay Class Reference

---

Detailed Description

Create help for an executable, in console mode. Predefined sections are present: NAME SYNOPTSIS DESCRIPTION ARGUMENTS .. your extra sections here BUGS DATE COPYRIGHT

Definition at line 50 of file help_display.h.

Public Methods
	HelpDisplay (const std::string &prog_name)
void	preformat (int size)
void	begin_description ()
void	new_section (const std::string &section_name, int space=6)
bool	add_section_text (const std::string &section_name, const std::string &text, int offset=0)
void	end_description ()
void	display (std::ostream &)

---

Constructor & Destructor Documentation

HelpDisplay::HelpDisplay (  const std::string &    prog_name )

---

Member Function Documentation

bool HelpDisplay::add_section_text (  const std::string &    section_name, const std::string &    text, int    offset = 0 )

void HelpDisplay::begin_description (    )

void HelpDisplay::display (  std::ostream &    )

void HelpDisplay::end_description (    )

void HelpDisplay::new_section (  const std::string &    section_name, int    space = 6 )

void HelpDisplay::preformat (  int    size )

---