@ tefigel

|
|   Document interface of an entity function.
|

|
|   Part 1: table header
|
if FUNCTGENSTEP=FUNCTGENRESULTPRE
   add FUNCTIONCOUNT 1

@  text
@    if FUNCTIONCOUNT=1
<table border=1>
    <tr>
        <th>Name</th>
        <th>Parameters</th>
        <th></th>
        <th>Returns</th>
    </tr>
@    endif
    <tr>
        <td align=right> FUNCTION </td>
	<td align=right>
@    if VOIDPARAM=1
            <i>(void)</i>
@    endif
@  endtext

endif

|
|   Part 2: parameter list
|
set FIELDADDINFO=

if ISLINK=1
   set FIELDADDINFO=link to 
endif

if ISLIST=1
   set FIELDADDINFO=list of 
endif

if FUNCTGENSTEP=FUNCTGENPARAMS

@  text
            <i>FIELDADDINFO&FIELDTYPE</i> FIELD
@    if FUNCTPARAMINDEX<FUNCTPARAMS
            ,<br>
@    endif
 
@  endtext

endif

|
|   Part 3: return value
|
if FUNCTGENSTEP=FUNCTGENRESULTPOST

@  text
        </td>
	<td> -&gt; </td>
	<td>
@    if VOIDRESULT=1
            <i>(void)</i>
@    else
            <i>FIELDADDINFO&FIELDTYPE</i> FIELD
@    endif
        </td>
    </tr>
@  endtext

endif