MatlabDocMaker Class Reference

Detailed Description

MatlabDocMaker: Class for information & tasks concerning the UQ-RB-Test documentation.

Prerequisites

• doxygen: mtoc++ is merely a filter for doxygen
• mtocpp, mtocpp_post on the search/environment paths
• m4: A macro parser [Unix only]

Author

Daniel Wirtz

Date

2011-10-13

Change in 1.2:

(Daniel Wirtz, 2011-11-08) Improved the createUnix method by displaying the warnings and writing the output to a log file afterwards. Not using cprintf anymore as this is 3rd party software.

Change in 1.2:

(Daniel Wirtz, 2011-11-07) Fixed a recursion bug caused by copy and paste. Now the preferences are stored on an per-application basis.

Change in 1.2:

(Daniel Wirtz, 2011-11-04) Changed the name to MatlabDocMaker in order to export it into the mtoc++ distribution later.

New in 1.2:

(Daniel Wirtz, 2011-10-13) Added this class and moved documentation related stuff here from the KerMor class.

This class is part of the mtoc++ tool

• Homepage http://www.morepas.org/software/mtocpp
• License http://www.morepas.org/software/mtocpp/licensing.html

Definition at line 17 of file MatlabDocMaker.m.

Static Public Member Functions
static function name =	getProjectName ()
	Returns the project name. More...
static function version =	getProjectVersion ()
	Returns the current version of the project. More...
static function char dir =	getOutputDirectory ()
	Returns the directory where the applications source files reside. More...
static function char dir =	getSourceDirectory ()
	Returns the directory where the applications source files reside. More...
static function char dir =	getConfigDirectory ()
	Returns the directory where the applications documentation configuration files reside. More...
static function char bin =	getDoxygenBin ()
	Allows access to a custom doxygen binary. More...
static function	open ()
	Opens the generated documentation.
static function	create (bool open)
	Creates the Doxygen documentation. More...
static function	setup ()
	Runs the setup script for MatlabDocMaker and collects all necessary paths in order for the documentation creation to work properly.

Member Function Documentation

function MatlabDocMaker.create ( bool  open )

static

Creates the Doxygen documentation.

Parameters

open	Set to true if the documentation should be opened after successful compilation Default: false

Definition at line 180 of file MatlabDocMaker.m.

Here is the call graph for this function:

function char dir = MatlabDocMaker.getConfigDirectory ( )

static

Returns the directory where the applications documentation configuration files reside.

This folder must contain at least the files "mtoc.conf" and "Doxyfile.m4"

Return values

dir	The documentation configuration directory

Note

This method has the MATLAB method attribute Sealed set to true. It cannot be overwritten.

matlab documentation of method attributes.

Definition at line 126 of file MatlabDocMaker.m.

function char bin = MatlabDocMaker.getDoxygenBin ( )

static

Allows access to a custom doxygen binary.

Return values

bin	The fully qualified path to a custom doxygen executable

Note

This method has the MATLAB method attribute Sealed set to true. It cannot be overwritten.

matlab documentation of method attributes.

Definition at line 148 of file MatlabDocMaker.m.

function char dir = MatlabDocMaker.getOutputDirectory ( )

static

Returns the directory where the applications source files reside.

Return values

dir	The output directory

Note

This method has the MATLAB method attribute Sealed set to true. It cannot be overwritten.

matlab documentation of method attributes.

Definition at line 90 of file MatlabDocMaker.m.

Here is the caller graph for this function:

function name = MatlabDocMaker.getProjectName ( )

static

Returns the project name.

Note

Changing the return value of this method will require another execution of MatlabDocMaker.setup as the preferences key also depends on it.

Return values

name	The project name

Definition at line 52 of file MatlabDocMaker.m.

Here is the caller graph for this function:

function version = MatlabDocMaker.getProjectVersion ( )

static

Returns the current version of the project.

Note

The built-in @new and @change tags from the Doxyfile.m4 support two-level versioning a la X.X.

Return values

version

The project version

Definition at line 68 of file MatlabDocMaker.m.

Here is the caller graph for this function:

function char dir = MatlabDocMaker.getSourceDirectory ( )

static

Returns the directory where the applications source files reside.

Return values

dir	The project source directory

Note

This method has the MATLAB method attribute Sealed set to true. It cannot be overwritten.

matlab documentation of method attributes.

Definition at line 108 of file MatlabDocMaker.m.

Here is the caller graph for this function:

---

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

• general/MatlabDocMaker.m