Source code of Windows XP (NT5)
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

47 lines
2.2 KiB

  1. /****************************************************************************
  2. * @doc EXTERNAL TEST
  3. * @api void | cFuncWithAsmCallback | This is an imaginary C function
  4. * to test AUTODOC. It has an associated callback function that uses
  5. * registers for parameter passing.
  6. * @parm BYTE | bParam | Specifies an 8-bit parameter value.
  7. * @parm WORD | wParam | Specifies a 16-bit parameter value.
  8. * @parm BYTE | bParamFlag | Specifies an 8-bit parameter value using
  9. * one of the following flags:
  10. * @flag RED | A flag value.
  11. * @flag WHITE | Another flag value.
  12. * @parm FARPROC | lpCallback | Specifies a 32-bit pointer to a callback
  13. * function.
  14. * @rdesc This is the normal return description text.
  15. *
  16. * This is a second paragraph of text. The return value is described
  17. * by one of the following flags:
  18. * @flag FLAG | This is a flag.
  19. * @flag FLAG2 | This is also a flag.
  20. * @comm Here are some comments pertaining to this function. <F>This
  21. * sentence should be bold.<D> <P>This sentence should be italicized.<D>
  22. * The callback function is specified as follows:
  23. * @asmcb asmCallback | The name <F>asmCallback<D> is a placeholder for
  24. * the application-supplied callback function.
  25. * @reg AL | Specifies an 8-bit parameter value.
  26. * @reg BX | Specifies a 16-bit parameter value.
  27. * @reg CL | Specifies an 8-bit parameter value using one of the
  28. * following flags:
  29. * @flag RED | A flag value.
  30. * @flag WHITE | Another flag value.
  31. * @rdesc This is the normal return description text.
  32. * @reg BX | The contents of this return register is not dependent
  33. * on the state of any flags.
  34. * @flag FLAG | This register can have flags.
  35. * @cond If CY clear:
  36. * @reg AX | Specifies a return value according to the following
  37. * flags:
  38. * @flag FLAG | This register can have flags.
  39. * @cond If CY set:
  40. * @reg AX | Specifies an error value according to the following
  41. * flags:
  42. * @flag ERROR | Specifies an error value.
  43. * @flag ANOTHERERROR | Specifies another error value.
  44. * @uses EFLAGS
  45. * @comm Here are some comments pertaining to the callback function.
  46. * @xref asmFunc
  47. *****************************************************************************/