[ < ] [ > ]   [ << ] [ Up ] [ >> ]         [Top] [Contents] [Index] [ ? ]

7. Dynare internal documentation and unitary tests

One can obtain internal documentation of matlab/octave’s routines or perform unitary tests using the internals command. This is a new feature, and, at this time, will work properly for a small number of routines. At the top of the (available) matlab/octave routines a commented block for the internal documentation is written in the GNU texinfo documentation format. This block is processed by calling texinfo from matlab. Consequently, texinfo has to be installed on your machine.

MATLAB/Octave command: internals FLAG ROUTINENAME[.m]

Description

Depending on the FLAG this command prints internal documentation of a matlab/octave routine or triggers unitary tests associated to this routine.

Flags

--info

Prints on screen the internal documentation of ROUTINENAME (if this routine exists and if this routine has texinfo internal documentation header). If the command is executed in the matlab directory of Dynare, then the path to ROUTINENAME has to be provided.

--test

Performs the unitary test associated to ROUTINENAME (if this routine exists and if the matalab/octave m file has unitary test sections).

Example

 
internals --info particle/local_state_iteration
internals --test particle/local_state_iteration

[ < ] [ > ]   [ << ] [ Up ] [ >> ]

This document was generated by Build Daemon user on March 23, 2013 using texi2html 1.82.