From 409c49f057f2d1cdea1fc2856ac20771bc0089d1 Mon Sep 17 00:00:00 2001 From: Dean Camera Date: Thu, 24 Sep 2009 02:05:33 +0000 Subject: Doxygen fixes to \param directives to give data direction in all projects. Make HID item filtering routines clearer in the HID WithParser demos. --- Projects/AVRISP/Lib/V2Protocol.c | 12 ++++++------ Projects/AVRISP/Lib/V2ProtocolParams.c | 10 +++++----- Projects/AVRISP/Lib/V2ProtocolTarget.c | 12 ++++++------ Projects/AVRISP/Lib/V2ProtocolTarget.h | 2 +- 4 files changed, 18 insertions(+), 18 deletions(-) (limited to 'Projects') diff --git a/Projects/AVRISP/Lib/V2Protocol.c b/Projects/AVRISP/Lib/V2Protocol.c index 3aa2d89ca..6099234fa 100644 --- a/Projects/AVRISP/Lib/V2Protocol.c +++ b/Projects/AVRISP/Lib/V2Protocol.c @@ -101,7 +101,7 @@ void V2Protocol_ProcessCommand(void) /** Handler for unknown V2 protocol commands. This discards all sent data and returns a * STATUS_CMD_UNKNOWN status back to the host. * - * \param V2Command Issued V2 Protocol command byte from the host + * \param[in] V2Command Issued V2 Protocol command byte from the host */ static void V2Protocol_Command_Unknown(uint8_t V2Command) { @@ -136,7 +136,7 @@ static void V2Protocol_Command_SignOn(void) /** Handler for the CMD_SET_PARAMETER and CMD_GET_PARAMETER commands from the host, setting or * getting a device parameter's value from the parameter table. * - * \param V2Command Issued V2 Protocol command byte from the host + * \param[in] V2Command Issued V2 Protocol command byte from the host */ static void V2Protocol_Command_GetSetParam(uint8_t V2Command) { @@ -289,7 +289,7 @@ static void V2Protocol_Command_LeaveISPMode(void) /** Handler for the CMD_PROGRAM_FLASH_ISP and CMD_PROGRAM_EEPROM_ISP commands, writing out bytes, * words or pages of data to the attached device. * - * \param V2Command Issued V2 Protocol command byte from the host + * \param[in] V2Command Issued V2 Protocol command byte from the host */ static void V2Protocol_Command_ProgramMemory(uint8_t V2Command) { @@ -425,7 +425,7 @@ static void V2Protocol_Command_ProgramMemory(uint8_t V2Command) /** Handler for the CMD_READ_FLASH_ISP and CMD_READ_EEPROM_ISP commands, reading in bytes, * words or pages of data from the attached device. * - * \param V2Command Issued V2 Protocol command byte from the host + * \param[in] V2Command Issued V2 Protocol command byte from the host */ static void V2Protocol_Command_ReadMemory(uint8_t V2Command) { @@ -516,7 +516,7 @@ static void V2Protocol_Command_ChipErase(void) /** Handler for the CMD_READ_FUSE_ISP, CMD_READ_LOCK_ISP, CMD_READ_SIGNATURE_ISP and CMD_READ_OSCCAL commands, * reading the requested configuration byte from the device. * - * \param V2Command Issued V2 Protocol command byte from the host + * \param[in] V2Command Issued V2 Protocol command byte from the host */ static void V2Protocol_Command_ReadFuseLockSigOSCCAL(uint8_t V2Command) { @@ -546,7 +546,7 @@ static void V2Protocol_Command_ReadFuseLockSigOSCCAL(uint8_t V2Command) /** Handler for the CMD_WRITE_FUSE_ISP and CMD_WRITE_LOCK_ISP commands, writing the requested configuration * byte to the device. * - * \param V2Command Issued V2 Protocol command byte from the host + * \param[in] V2Command Issued V2 Protocol command byte from the host */ static void V2Protocol_Command_WriteFuseLock(uint8_t V2Command) { diff --git a/Projects/AVRISP/Lib/V2ProtocolParams.c b/Projects/AVRISP/Lib/V2ProtocolParams.c index 2d646a93c..6aaa9558e 100644 --- a/Projects/AVRISP/Lib/V2ProtocolParams.c +++ b/Projects/AVRISP/Lib/V2ProtocolParams.c @@ -108,7 +108,7 @@ void V2Params_UpdateParamValues(void) * be called before calls to \ref V2Params_GetParameterValue() or \ref V2Params_SetParameterValue() when * getting or setting parameter values in response to requests from the host. * - * \param ParamID Parameter ID whose privellages are to be retrieved from the table + * \param[in] ParamID Parameter ID whose privellages are to be retrieved from the table * * \return Privellages for the requested parameter, as a mask of PARAM_PRIV_* masks */ @@ -124,7 +124,7 @@ uint8_t V2Params_GetParameterPrivellages(uint8_t ParamID) /** Retrieves the current value for a given parameter in the parameter table. * - * \param ParamID Parameter ID whose value is to be retrieved from the table + * \param[in] ParamID Parameter ID whose value is to be retrieved from the table * * \return Current value of the parameter in the table, or 0 if not found */ @@ -140,8 +140,8 @@ uint8_t V2Params_GetParameterValue(uint8_t ParamID) /** Sets the value for a given parameter in the parameter table. * - * \param ParamID Parameter ID whose value is to be set in the table - * \param Value New value to set the parameter to + * \param[in] ParamID Parameter ID whose value is to be set in the table + * \param[in] Value New value to set the parameter to * * \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise */ @@ -162,7 +162,7 @@ void V2Params_SetParameterValue(uint8_t ParamID, uint8_t Value) /** Retrieves a parameter entry (including ID, value and privellages) from the parameter table that matches the given * parameter ID. * - * \param ParamID Parameter ID to find in the table + * \param[in] ParamID Parameter ID to find in the table * * \return Pointer to the associated parameter information from the parameter table if found, NULL otherwise */ diff --git a/Projects/AVRISP/Lib/V2ProtocolTarget.c b/Projects/AVRISP/Lib/V2ProtocolTarget.c index 24cd941a4..9f8978a70 100644 --- a/Projects/AVRISP/Lib/V2ProtocolTarget.c +++ b/Projects/AVRISP/Lib/V2ProtocolTarget.c @@ -79,7 +79,7 @@ uint8_t V2Protocol_GetSPIPrescalerMask(void) /** Asserts or deasserts the target's reset line, using the correct polarity as set by the host using a SET PARAM command. * When not asserted, the line is tristated so as not to intefere with normal device operation. * - * \param ResetTarget Boolean true when the target should be held in reset, false otherwise + * \param[in] ResetTarget Boolean true when the target should be held in reset, false otherwise */ void V2Protocol_ChangeTargetResetLine(bool ResetTarget) { @@ -100,11 +100,11 @@ void V2Protocol_ChangeTargetResetLine(bool ResetTarget) /** Waits until the last issued target memory programming command has completed, via the check mode given and using * the given parameters. * - * \param ProgrammingMode Programming mode used and completion check to use, a mask of PROG_MODE_* constants - * \param PollAddress Memory address to poll for completion if polling check mode used - * \param PollValue Poll value to check against if polling check mode used - * \param DelayMS Milliseconds to delay before returning if delay check mode used - * \param ReadMemCommand Device low-level READ MEMORY command to send if value check mode used + * \param[in] ProgrammingMode Programming mode used and completion check to use, a mask of PROG_MODE_* constants + * \param[in] PollAddress Memory address to poll for completion if polling check mode used + * \param[in] PollValue Poll value to check against if polling check mode used + * \param[in] DelayMS Milliseconds to delay before returning if delay check mode used + * \param[in] ReadMemCommand Device low-level READ MEMORY command to send if value check mode used * * \return V2 Protocol status \ref STATUS_CMD_OK if the no timeout occurred, \ref STATUS_RDY_BSY_TOUT or * \ref STATUS_CMD_TOUT otherwise diff --git a/Projects/AVRISP/Lib/V2ProtocolTarget.h b/Projects/AVRISP/Lib/V2ProtocolTarget.h index 6322b9f33..0de7b39cc 100644 --- a/Projects/AVRISP/Lib/V2ProtocolTarget.h +++ b/Projects/AVRISP/Lib/V2ProtocolTarget.h @@ -60,7 +60,7 @@ /* Inline Functions: */ /** Blocking delay for a given number of milliseconds, via a hardware timer. * - * \param DelayMS Number of milliseconds to delay for + * \param[in] DelayMS Number of milliseconds to delay for */ static inline void V2Protocol_DelayMS(uint8_t DelayMS) { -- cgit v1.2.3