180 lines
2.7 KiB
Plaintext
180 lines
2.7 KiB
Plaintext
@HR = asmFuncWithCallback
|
|
|
|
This is an imaginary assembler function
|
|
to test AUTODOC. It has an associated callback function.
|
|
|
|
@HO = Registers
|
|
|
|
@RNAME = <B>AL<D>
|
|
|
|
@RDESC = Specifies an 8-bit parameter value.
|
|
|
|
@RDESC = This is the second paragraph of a register description.
|
|
|
|
@RNAME = <B>BX<D>
|
|
|
|
@RDESC = Specifies a 16-bit parameter value.
|
|
|
|
@RNAME = <B>CL<D>
|
|
|
|
@RDESC = Specifies an 8-bit parameter value using one of the
|
|
following flags:
|
|
|
|
@RFLAG = RED
|
|
|
|
@RFLDESC = A flag value.
|
|
|
|
@RFLAG = WHITE
|
|
|
|
@RFLDESC = Another flag value.
|
|
|
|
@RNAME = <B>EDX<D>
|
|
|
|
@RDESC = Specifies a 32-bit pointer to a callback function.
|
|
|
|
@LE =
|
|
|
|
@HO = Returns
|
|
|
|
The following registers contain meaningful return values:
|
|
|
|
@RNAME = <B>CX<D>
|
|
|
|
@RDESC = This register should come out before the conditionals are
|
|
printed.
|
|
|
|
@FLAG = FOOBAR
|
|
|
|
@FLDESC = Random flag before the conditionals.
|
|
|
|
@LE =
|
|
|
|
@COND = If AL is zero, the callback was succcessfully installed, and the
|
|
following registers contain:
|
|
|
|
@COND = This is the second paragraph of a conditional.
|
|
|
|
@RNAME = <B>BX<D>
|
|
|
|
@RDESC = Specifies a 16-bit return value.
|
|
|
|
@RNAME = <B>DS:SI<D>
|
|
|
|
@RDESC = Points to the ASCIIZ name of the callback.
|
|
|
|
@LE =
|
|
|
|
@COND = Otherwise, an error is specified as follows:
|
|
|
|
@RNAME = <B>AL<D>
|
|
|
|
@RDESC = Contains one of the following error codes:
|
|
|
|
@FLAG = ERROR1
|
|
|
|
@FLDESC = An error.
|
|
|
|
@FLAG = ERROR2
|
|
|
|
@FLDESC = Another error.
|
|
|
|
@LE =
|
|
|
|
@LE =
|
|
|
|
@HO = Uses
|
|
|
|
EFLAGS
|
|
|
|
@LE =
|
|
|
|
@HO = Comments
|
|
|
|
Here are some comments pertaining to this function. <B>This
|
|
sentence should be bold. <MI>This sentence should be italicized.<D>
|
|
|
|
This is the second paragraph of comments. The callback function is
|
|
specified as follows:
|
|
|
|
@HO = Callback
|
|
|
|
<B>asmCallback<D>
|
|
|
|
The name <B>asmCallback<D> is a placeholder for
|
|
the application-supplied callback function.
|
|
|
|
@HU = Registers
|
|
|
|
@RNAME = <B>AL<D>
|
|
|
|
@RDESC = Specifies an 8-bit parameter value.
|
|
|
|
@RNAME = <B>BX<D>
|
|
|
|
@RDESC = Specifies a 16-bit parameter value.
|
|
|
|
@RNAME = <B>CL<D>
|
|
|
|
@RDESC = Specifies an 8-bit parameter value using one of the
|
|
following flags:
|
|
|
|
@RFLAG = RED
|
|
|
|
@RFLDESC = A flag value.
|
|
|
|
@RFLAG = WHITE
|
|
|
|
@RFLDESC = Another flag value.
|
|
|
|
@LE =
|
|
|
|
@HU = Returns
|
|
|
|
The following registers contain meaningful return values:
|
|
|
|
@RNAME = <B>AL<D>
|
|
|
|
@RDESC = If zero, the callback was successfully installed.
|
|
Otherwise, an error is specified by one of the following flags:
|
|
|
|
@FLAG = ERROR1
|
|
|
|
@FLDESC = An error.
|
|
|
|
@FLAG = ERROR2
|
|
|
|
@FLDESC = Another error.
|
|
|
|
@LE =
|
|
|
|
@COND = This is an empty conditional to test the code.
|
|
|
|
None
|
|
|
|
@LE =
|
|
|
|
@COND = Otherwise, the following registers are returned:
|
|
|
|
@RNAME = <B>BX<D>
|
|
|
|
@RDESC = Specifies a 16-bit return value.
|
|
|
|
@LE =
|
|
|
|
@LE =
|
|
|
|
@HU = Uses
|
|
|
|
EFLAGS
|
|
|
|
@LE =
|
|
|
|
@HU = Comments
|
|
|
|
Here are some comments pertaining to the callback function.
|
|
|
|
@HO = See Also
|
|
|
|
asmFunc
|
|
|