Prev

Next

Index-> contents reference index search external

Up-> cppad_swig library xam.m4 omhelp.m4

cppad_swig-> testing swig_xam.i library whats_new_2018

library-> module a_double vector a_fun sparse error xam.m4

xam.m4-> lang_m4 xam_file_name.m4 header.m4 lang_name.m4 omhelp.m4

omhelp.m4

Headings-> Syntax FunctionName_ Omhelp_title Omhelp_tag Assumption ---..lang_m4 ---..lang_file_name ---..Formatting

@(@\newcommand{\B}[1]{ {\bf #1} } \newcommand{\R}[1]{ {\rm #1} }@)@ M4 Macro That Include Omhelp to Display Source Code
Syntax
Omhelp_(FunctionName_, Omhelp_title)

FunctionName_
is the name of function corresponding to this output file; see FunctionName_ .

Omhelp_title
is the title of this Omhelp section that displays this source code.

Omhelp_tag
The Omhelp cross reference tag that will be used for this section is
     name_xam.ext
where ext is the file extension used for the current language.

Assumption

lang_m4
It is assumed that the macros in lang_m4 have been set for the language that the output corresponds to.

lang_file_name
The name of the source code file where the current output is placed is assumed to be
     build/lib/example/language/lang_file_name
see language and lang_file_name .

Formatting
Let source code denote the language specific source code and comment denote the commenting characters. The input file is assumed to have the following format / order:
     comment BEGIN SOURCE
     source code
     comment END SOURCE
     Omhelp_(name_xam, Omhelp_title)


---

Input File: lib/xam/omhelp.m4