From a14ece5f5727e5c8c6b32ed144808ee9ec66ac78 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Tue, 15 Jun 2010 03:34:55 +0000 Subject: Change over Doxygen \note documentation to \pre where applicable. --- LUFA/Drivers/USB/Class/Host/CDC.h | 20 ++++++++-------- LUFA/Drivers/USB/Class/Host/HID.h | 19 +++++++-------- LUFA/Drivers/USB/Class/Host/MIDI.h | 8 +++---- LUFA/Drivers/USB/Class/Host/MassStorage.h | 24 +++++++++---------- LUFA/Drivers/USB/Class/Host/Printer.h | 4 ++-- LUFA/Drivers/USB/Class/Host/RNDIS.h | 12 +++++----- LUFA/Drivers/USB/Class/Host/StillImage.h | 40 +++++++++++++++---------------- 7 files changed, 62 insertions(+), 65 deletions(-) (limited to 'LUFA/Drivers/USB/Class/Host') diff --git a/LUFA/Drivers/USB/Class/Host/CDC.h b/LUFA/Drivers/USB/Class/Host/CDC.h index 0f8807ed2..ece23c546 100644 --- a/LUFA/Drivers/USB/Class/Host/CDC.h +++ b/LUFA/Drivers/USB/Class/Host/CDC.h @@ -205,8 +205,8 @@ * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be * packed into a single pipe packet, increasing data throughput. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in] Data Pointer to the string to send to the device @@ -222,8 +222,8 @@ * \ref CDC_Host_Flush() function is called to flush the pending data to the host. This allows for multiple bytes to be * packed into a single pipe packet, increasing data throughput. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * \param[in] Data Byte of data to send to the device @@ -234,8 +234,8 @@ /** Determines the number of bytes received by the CDC interface from the device, waiting to be read. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * @@ -247,8 +247,8 @@ * returns 0. The \ref CDC_Host_BytesReceived() function should be queried before data is received to ensure that no data * underflow occurs. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * @@ -258,8 +258,8 @@ /** Flushes any data waiting to be sent, ensuring that the send buffer is cleared. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] CDCInterfaceInfo Pointer to a structure containing a CDC Class host configuration and state * diff --git a/LUFA/Drivers/USB/Class/Host/HID.h b/LUFA/Drivers/USB/Class/Host/HID.h index 1988e5d33..82ff3baca 100644 --- a/LUFA/Drivers/USB/Class/Host/HID.h +++ b/LUFA/Drivers/USB/Class/Host/HID.h @@ -167,9 +167,8 @@ /** Receives a HID IN report from the attached HID device, when a report has been received on the HID IN Data pipe. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. - * \n\n + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \note The destination buffer should be large enough to accommodate the largest report that the attached device * can generate. @@ -185,9 +184,8 @@ #if !defined(HID_HOST_BOOT_PROTOCOL_ONLY) /** Receives a HID IN report from the attached device, by the report ID. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. - * \n\n + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, this method is unavailable. * @@ -204,9 +202,8 @@ /** Sends an OUT or FEATURE report to the currently attached HID device, using the device's OUT pipe if available, * or the device's Control pipe if not. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. - * \n\n + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \note When the HID_HOST_BOOT_PROTOCOL_ONLY compile time token is defined, the ReportID parameter is removed * from the parameter list of this function. @@ -233,8 +230,8 @@ /** Determines if a HID IN report has been received from the attached device on the data IN pipe. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] HIDInterfaceInfo Pointer to a structure containing a HID Class host configuration and state * diff --git a/LUFA/Drivers/USB/Class/Host/MIDI.h b/LUFA/Drivers/USB/Class/Host/MIDI.h index f7898709f..5ac1becb8 100644 --- a/LUFA/Drivers/USB/Class/Host/MIDI.h +++ b/LUFA/Drivers/USB/Class/Host/MIDI.h @@ -130,8 +130,8 @@ /** Sends a MIDI event packet to the device. If no device is connected, the event packet is discarded. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * \param[in] Event Pointer to a populated USB_MIDI_EventPacket_t structure containing the MIDI event to send @@ -154,8 +154,8 @@ /** Receives a MIDI event packet from the device. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MIDIInterfaceInfo Pointer to a structure containing a MIDI Class configuration and state * \param[out] Event Pointer to a USB_MIDI_EventPacket_t structure where the received MIDI event is to be placed diff --git a/LUFA/Drivers/USB/Class/Host/MassStorage.h b/LUFA/Drivers/USB/Class/Host/MassStorage.h index 6c1f7f67f..9b67c7fc4 100644 --- a/LUFA/Drivers/USB/Class/Host/MassStorage.h +++ b/LUFA/Drivers/USB/Class/Host/MassStorage.h @@ -174,8 +174,8 @@ /** Retrieves the Mass Storage device's inquiry data for the specified LUN, indicating the device characteristics and * properties. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in] LUNIndex LUN index within the device the command is being issued to @@ -199,8 +199,8 @@ /** Retrieves the total capacity of the attached USB Mass Storage device, in blocks, and block size. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in] LUNIndex LUN index within the device the command is being issued to @@ -215,8 +215,8 @@ /** Retrieves the device sense data, indicating the current device state and error codes for the previously * issued command. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in] LUNIndex LUN index within the device the command is being issued to @@ -231,8 +231,8 @@ /** Issues a PREVENT MEDIUM REMOVAL command, to logically (or, depending on the type of device, physically) lock * the device from removal so that blocks of data on the medium can be read or altered. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in] LUNIndex LUN index within the device the command is being issued to @@ -245,8 +245,8 @@ /** Reads blocks of data from the attached Mass Storage device's medium. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in] LUNIndex LUN index within the device the command is being issued to @@ -263,8 +263,8 @@ /** Writes blocks of data to the attached Mass Storage device's medium. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] MSInterfaceInfo Pointer to a structure containing a MS Class host configuration and state * \param[in] LUNIndex LUN index within the device the command is being issued to diff --git a/LUFA/Drivers/USB/Class/Host/Printer.h b/LUFA/Drivers/USB/Class/Host/Printer.h index 78b3f26b0..89f229975 100644 --- a/LUFA/Drivers/USB/Class/Host/Printer.h +++ b/LUFA/Drivers/USB/Class/Host/Printer.h @@ -161,8 +161,8 @@ * printer is able to understand - for example, PCL data. Not all printers accept all printer languages; see * \ref PRNT_Host_GetDeviceID() for details on determining acceptable languages for an attached printer. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] PRNTInterfaceInfo Pointer to a structure containing a Printer Class host configuration and state * \param[in] PrinterCommands Pointer to a buffer containing the raw command stream to send to the printer diff --git a/LUFA/Drivers/USB/Class/Host/RNDIS.h b/LUFA/Drivers/USB/Class/Host/RNDIS.h index 111d60b5c..f39be799f 100644 --- a/LUFA/Drivers/USB/Class/Host/RNDIS.h +++ b/LUFA/Drivers/USB/Class/Host/RNDIS.h @@ -195,8 +195,8 @@ /** Determines if a packet is currently waiting for the host to read in and process. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state * @@ -207,8 +207,8 @@ /** Retrieves the next pending packet from the device, discarding the remainder of the RNDIS packet header to leave * only the packet contents for processing by the host in the nominated buffer. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state * \param[out] Buffer Pointer to a buffer where the packer data is to be written to @@ -221,8 +221,8 @@ /** Sends the given packet to the attached RNDIS device, after adding a RNDIS packet message header. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] RNDISInterfaceInfo Pointer to a structure containing an RNDIS Class host configuration and state * \param[in] Buffer Pointer to a buffer where the packer data is to be read from diff --git a/LUFA/Drivers/USB/Class/Host/StillImage.h b/LUFA/Drivers/USB/Class/Host/StillImage.h index 1feddb882..b737e3672 100644 --- a/LUFA/Drivers/USB/Class/Host/StillImage.h +++ b/LUFA/Drivers/USB/Class/Host/StillImage.h @@ -146,8 +146,8 @@ /** Opens a new PIMA session with the attached device. This should be used before any session-orientated PIMA commands * are issued to the device. Only one session can be open at the one time. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * @@ -159,8 +159,8 @@ /** Closes an already opened PIMA session with the attached device. This should be used after all session-orientated * PIMA commands have been issued to the device. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * @@ -172,8 +172,8 @@ /** Sends a raw PIMA block header to the device, filling out the transaction ID automatically. This can be used to send * arbitrary PIMA blocks to the device with or without parameters. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[in] PIMAHeader Pointer to a PIMA container structure that is to be sent @@ -187,8 +187,8 @@ /** Receives a raw PIMA block header to the device. This can be used to receive arbitrary PIMA blocks from the device with * or without parameters. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[out] PIMAHeader Pointer to a PIMA container structure where the received block is to be stored @@ -201,8 +201,8 @@ /** Sends a given PIMA command to the attached device, filling out the PIMA command header's Transaction ID automatically. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[in] Operation PIMA operation code to issue to the device @@ -218,8 +218,8 @@ /** Receives and checks a response block from the attached PIMA device, once a command has been issued and all data * associated with the command has been transferred. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * @@ -230,8 +230,8 @@ /** Indicates if the device has issued a PIMA event block to the host via the asynchronous events pipe. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * @@ -241,8 +241,8 @@ /** Receives an asynchronous event block from the device via the asynchronous events pipe. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[out] PIMAHeader Pointer to a PIMA container structure where the event should be stored @@ -257,8 +257,8 @@ /** Sends arbitrary data to the attached device, for use in the data phase of PIMA commands which require data * transfer beyond the regular PIMA command block parameters. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[in] Buffer Pointer to a buffer where the data to send has been stored @@ -272,8 +272,8 @@ /** Receives arbitrary data from the attached device, for use in the data phase of PIMA commands which require data * transfer beyond the regular PIMA command block parameters. * - * \note This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the - * call will fail. + * \pre This function must only be called when the Host state machine is in the HOST_STATE_Configured state or the + * call will fail. * * \param[in,out] SIInterfaceInfo Pointer to a structure containing a Still Image Class host configuration and state * \param[out] Buffer Pointer to a buffer where the received data is to be stored -- cgit v1.2.3