Helpfile Class Reference

Public Member Functions
	Helpfile ()
virtual	~Helpfile ()
void	readHelp (istream &in, const string &filename)
void	writeXML (FILE *out, const string &page_name)
void	extractInternalLinks ()
const Section &	get_title () const

Detailed Description

Definition at line 409 of file arb_help2xml.cxx.

Constructor & Destructor Documentation

Helpfile::Helpfile ( )

inline

Definition at line 427 of file arb_help2xml.cxx.

virtual Helpfile::~Helpfile ( )

inlinevirtual

Definition at line 428 of file arb_help2xml.cxx.

Member Function Documentation

void Helpfile::readHelp	(	istream &	in,
		const string &	filename
	)

Definition at line 756 of file arb_help2xml.cxx.

References arb_assert, MessageAttachable::attached_message(), check_duplicates(), check_TODO(), checkControlComment(), eatSpace(), extractKeyword(), Reader::getLineNo(), Reader::getNext(), h2x_assert, inputfile, isEmptyOrComment(), KNOWN_SECTION_TYPES, line, MAX_TITLE_CHARS, name_only(), parseSection(), SEC_NONE, SEC_SECTION, strf(), title, unattached_message(), uplinks, and warnAboutDuplicate().

Referenced by ARB_main().

void Helpfile::writeXML	(	FILE *	out,
		const string &	page_name
	)

Definition at line 1674 of file arb_help2xml.cxx.

References create_top_links(), eatWhitespace(), h2x_assert, inputfile, MAX_SUBTITLE_CHARS, PLAIN_TEXT, remove_LF_and_indentation(), s, strf(), T, title, and uplinks.

Referenced by ARB_main().

void Helpfile::extractInternalLinks

(

)

Definition at line 1787 of file arb_help2xml.cxx.

References check_specific_duplicates(), li, line, s, start, and uplinks.

Referenced by ARB_main().

const Section& Helpfile::get_title ( ) const

inline

Definition at line 434 of file arb_help2xml.cxx.

References title.

---

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

• HELP_SOURCE/arb_help2xml.cxx