G3D::Journal Class Reference

Routines for programmatically working with journal.md.html and journal.dox files. More...

Static Public Member Functions
static void	appendToFirstSection (const String &journalFilename, const String &text)
	Adds text to the bottom of the first section in the .dox or .md.html file at journalFilename. More...
static String	findJournalFile (const String &hint=".")
	Locates journal.dox or journal.md.html and returns the fully-qualified filename, starting a search from hint. More...
static String	firstSectionTitle (const String &journalFilename)
	Returns title of the first Doxygen "section" or Markdeep level 1 header (underlined by === or prefixed by a single #) command the journal at journalFilename, or the empty string if no section title is found. More...
static String	formatImage (const String &journalFilename, const String &imageFilename, const String &caption, const String &description)
static void	insertNewSection (const String &journalFilename, const String &title, const String &text)
	Inserts text immediately before the first "section" command in the .dox file or before the first level 1 header in the .md.html file at journalFilename. More...

Detailed Description

Routines for programmatically working with journal.md.html and journal.dox files.

See also

G3D::GApp::Settings::ScreenCapture::outputDirectory, G3D::VideoRecordDialog, G3D::ScreenCapture, G3D::Log, G3D::System::findDataFile

Member Function Documentation

appendToFirstSection()

static void G3D::Journal::appendToFirstSection ( const String &  journalFilename, const String &  text  )

static

Adds text to the bottom of the first section in the .dox or .md.html file at journalFilename.

findJournalFile()

static String G3D::Journal::findJournalFile ( const String &  hint = "." )

static

Locates journal.dox or journal.md.html and returns the fully-qualified filename, starting a search from hint.

Returns the empty string if not found.

firstSectionTitle()

static String G3D::Journal::firstSectionTitle ( const String &  journalFilename )

static

Returns title of the first Doxygen "section" or Markdeep level 1 header (underlined by === or prefixed by a single #) command the journal at journalFilename, or the empty string if no section title is found.

Assumes that journalFilename exists.

formatImage()

static String G3D::Journal::formatImage ( const String &  journalFilename, const String &  imageFilename, const String &  caption, const String &  description  )

static

insertNewSection()

static void G3D::Journal::insertNewSection ( const String &  journalFilename, const String &  title, const String &  text  )

static

Inserts text immediately before the first "section" command in the .dox file or before the first level 1 header in the .md.html file at journalFilename.