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.

36 lines
1.8 KiB

  1. /****************************************************************************
  2. * @doc EXTERNAL TEST
  3. * @api void | cFuncWithCallback | This is an imaginary C function
  4. * to test AUTODOC. It has an associated callback function.
  5. * @parm BYTE | bParam | Specifies an 8-bit parameter value.
  6. * @parm WORD | wParam | Specifies a 16-bit parameter value.
  7. * @parm BYTE | bParamFlag | Specifies an 8-bit parameter value using
  8. * one of the following flags:
  9. * @flag RED | A flag value.
  10. * @flag WHITE | Another flag value.
  11. * @parm FARPROC | lpCallback | Specifies a 32-bit pointer to a callback
  12. * function.
  13. * @rdesc If zero, the callback was successfully installed. Otherwise,
  14. * an error is specified by one of the following flags:
  15. * @flag ERROR1 | An error.
  16. * @flag ERROR2 | Another error.
  17. * @comm Here are some comments pertaining to this function. Ventura
  18. * character formatting tags like <MI>this italicized text<D> should
  19. * pass through the AUTODOC tools. <F>This sentence should be bold.<D>
  20. * <P>This sentence should be italicized.<D> The callback function is
  21. * specified as follows:
  22. * @cb WORD | cCallback | The name <F>cCallback<D> is a placeholder for
  23. * the application-supplied callback function.
  24. * @parm BYTE | bParam | Specifies an 8-bit parameter value.
  25. * @parm WORD | wParam | Specifies a 16-bit parameter value.
  26. * @parm BYTE | bParamFlag | Specifies an 8-bit parameter value using
  27. * one of the following flags:
  28. * @flag RED | A flag value.
  29. * @flag WHITE | Another flag value.
  30. * @rdesc If zero, the callback was successfully installed. Otherwise,
  31. * an error is specified by one of the following flags:
  32. * @flag ERROR1 | An error.
  33. * @flag ERROR2 | Another error.
  34. * @comm Here are some comments pertaining to the callback function.
  35. * @xref asmFunc
  36. *****************************************************************************/