stepan
/
dynare
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Added documentation for the new internals command.

time-shift
Stéphane Adjemian (Scylla) 2011-09-12 14:17:08 +02:00
parent 1467bec712
commit 3dfbead178
1 changed files with 51 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

51
doc/dynare.texi
View File

@ -28,6 +28,13 @@
@emph{Options}
@end macro
@macro flagshead
@iftex
@sp 1
@end iftex
@emph{Flags}
@end macro
@macro examplehead
@iftex
@sp 1
@ -94,6 +101,7 @@ This is Dynare Reference Manual, version @value{VERSION}.
* Introduction::
* Installation and configuration::
* Dynare invocation::
* Dynare internal documentation and unitary tests::
* The Model file::
* The Configuration File::
* Examples::
@ -745,6 +753,49 @@ during the computation.
Structure containing the various results of the computations.
@end defvr
-*-
@node Dynare internal documentation and unitary tests
@chapter Dynare internal documentation and unitary tests
One can obtain internal documentation of matlab/octave's routines or perform unitary tests
using the @code{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.
@deffn {MATLAB/Octave command} internals @var{FLAG} @var{ROUTINENAME}[.m]
@descriptionhead
Depending on the @var{FLAG} this command prints internal documentation of a matlab/octave
routine or triggers unitary tests associated to this routine.
@flagshead
@table @code
@item --info
Prints on screen the internal documentation of @var{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 @var{ROUTINENAME} has to be provided.
@item --test
Performs the unitary test associated to @var{ROUTINENAME} (if this routine exists and if the matalab/octave m
file has unitary test sections).
@end table
@examplehead
@example
internals --info particle/local_state_iteration
internals --test particle/local_state_iteration
@end example
@end deffn
@node The Model file
@chapter The Model file