Documentation Conventions
Typographical Conventions
This documentation uses the following typographic conventions.
| Convention | Indicates |
|---|---|
|
bold |
System-supplied or system-defined functions and support routines, structure members, and registry key names. For example, WdfObjectCreate is a system-supplied function provided to support drivers. |
|
italic |
Placeholder function names, formal parameters, or any other text that is meant to be replaced by driver writers. For example: AddDevice is a placeholder name for a required function whose actual name is defined by the driver writer. DeviceObject is a formal parameter to a number of system-supplied support routines called by kernel-mode drivers. Italic items in registry paths are placeholders that the driver writer should replace with driver- or device-specific text. |
|
Code examples. For example: |
Conventions for Documenting Header File Annotations
Some WDK header files contain function annotations that provide developers and static analysis tools with information about a function's parameters and their intended purpose. These annotations help the analysis tools verify correct parameter usage, but they are sometimes difficult for humans to read. Therefore, the syntax blocks on WDK reference pages typically contain only __in, __out, __inout, and _opt annotations. The Parameters and Remarks sections of reference pages provide verbal descriptions of the behaviors and restrictions that a function's additional annotations specify.
Send comments about this topic to Microsoft
Build date: 10/26/2012
