File: help.tm

package info (click to toggle)
tmexpand 0.1.2.0-5
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, forky, sid, trixie
  • size: 500 kB
  • sloc: sh: 189; makefile: 161
file content (24 lines) | stat: -rw-r--r-- 584 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
#%+
  Text appearing between the #%+/- delimiters will be ignored and not
  appear when expanded.
  
  This example shows how slang function documentation may be expanded
  using the slhlp macros.  It does not expand to .sgml, but to the
  text format that slang reads.
#%-
#i slhlp.tm
#d int Integer_Type

\function{my_function}
\synopsis{A function returning an integer}
\usage{\int my_function ()}
\description
  This function returns an integer.
\example
#v+
   if (my_function ()) exit (1);
#v-
\notes
  This function is obsolete
\seealso{my_other_function, bobs_function}
\done