Introduction
OMhelp is designed to be embedded in computer source code.
In fact, it is language independent and can be can combine source
code files in multiple languages to form one documentation system.
Only the text between a $begin and a $end is processed
by OMhelp.
It is intended that these commands be comments in the language.
near_equal_c.c
Use an editor of your choice to
create the file near_equal_c.c
in the
test directory
the contents of which can be seen by selecting
view_near_equal_c
.
Note that you can copy and paste the contents of
near_equal_c.c to your editor window.
You may just copy the file near_equal_c.c from the
getting started directory
.
Example by Itself
Use a web browser of your choosing to view the file
test/htm/near_equal_c.htm.
A Language with only One Line Comments
This example covers languages that only have one line comments; e.g.,
Matlab, Fortran, R.
(The R language uses the $ character, this it may be necessary to change
the OMhelp KeyCharacter
.)
near_equal_f.f
Use an editor of your choice to
create the file near_equal_f.f
in the
test directory
the contents of which can be seen by selecting
view_near_equal_f
.
Note that you can copy and paste the contents of
near_equal_f.f to your editor window.
You may just copy the file near_equal_f.f from the
getting started directory
.
