Reduce doxygen warnings regarding documenting some parameters.

This commit is contained in:
R. Bernstein
2011-10-26 21:23:27 -04:00
parent bf925d61d7
commit f09889f331
3 changed files with 23 additions and 8 deletions

View File

@@ -545,7 +545,7 @@ driver_return_code_t mmc_audio_get_volume (CdIo_t *p_cdio, /*out*/
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param track the track you to get ISRC info @param track the track you to get ISRC info
@param buf place to put ISRC info @param p_isrc place to put ISRC info
*/ */
driver_return_code_t driver_return_code_t
mmc_isrc_track_read_subchannel (CdIo_t *p_cdio, /*in*/ const track_t track, mmc_isrc_track_read_subchannel (CdIo_t *p_cdio, /*in*/ const track_t track,
@@ -755,7 +755,7 @@ driver_return_code_t mmc_audio_get_volume (CdIo_t *p_cdio, /*out*/
about the current state of the drive (e.g. 00h TEST UNIT READY). about the current state of the drive (e.g. 00h TEST UNIT READY).
@param p_cdio CD structure set by cdio_open(). @param p_cdio CD structure set by cdio_open().
@param sense returns the sense bytes received from the drive. @param pp_sense returns the sense bytes received from the drive.
This is allocated memory or NULL if no sense bytes are This is allocated memory or NULL if no sense bytes are
available. Dispose non-NULL pointers by free() when no longer available. Dispose non-NULL pointers by free() when no longer
needed. See SPC-3 4.5.3 Fixed format sense data. SCSI error needed. See SPC-3 4.5.3 Fixed format sense data. SCSI error

View File

@@ -42,7 +42,7 @@ extern "C" {
/** /**
Detects if a disc (CD or DVD) is erasable or not. Detects if a disc (CD or DVD) is erasable or not.
@param p_user_data the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param b_erasable, if not NULL, on return will be set indicate whether @param b_erasable, if not NULL, on return will be set indicate whether
the operation was a success (DRIVER_OP_SUCCESS) or if not to some the operation was a success (DRIVER_OP_SUCCESS) or if not to some
@@ -70,9 +70,7 @@ extern "C" {
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param i_status, if not NULL, on return will be set indicate whether @param i_timeout_ms, number of millisections to wait before timeout
the operation was a success (DRIVER_OP_SUCCESS) or if not to some
other value.
@param p_disctype the disc type set on success. @param p_disctype the disc type set on success.
@return DRIVER_OP_SUCCESS (0) if we got the status. @return DRIVER_OP_SUCCESS (0) if we got the status.

View File

@@ -44,6 +44,15 @@ extern "C" {
/** /**
Get drive capabilities vis SCSI-MMC GET CONFIGURATION Get drive capabilities vis SCSI-MMC GET CONFIGURATION
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param p_buf pointer to location to store mode sense information
@param i_size number of bytes allocated to p_buf
@param i_timeout_ms value in milliseconds to use on timeout. Setting
to 0 uses the default time-out value stored in
mmc_timeout_ms.
@return DRIVER_OP_SUCCESS (0) if we got the status. @return DRIVER_OP_SUCCESS (0) if we got the status.
return codes are the same as driver_return_code_t return codes are the same as driver_return_code_t
*/ */
@@ -94,8 +103,12 @@ extern "C" {
and put the results in p_buf and put the results in p_buf
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param p_buf pointer to location to store mode sense information @param p_buf pointer to location to store mode sense information
@param i_size number of bytes allocated to p_buf @param i_size number of bytes allocated to p_buf
@param i_page which "page" of the mode sense command we are interested in
@param i_page_code which "page" of the mode sense command we are
interested in
@return DRIVER_OP_SUCCESS if we ran the command ok. @return DRIVER_OP_SUCCESS if we ran the command ok.
*/ */
driver_return_code_t mmc_mode_sense_10( CdIo_t *p_cdio, /*out*/ void *p_buf, driver_return_code_t mmc_mode_sense_10( CdIo_t *p_cdio, /*out*/ void *p_buf,
@@ -119,8 +132,12 @@ extern "C" {
SCSI-MMC PREVENT/ALLOW MEDIUM REMOVAL. SCSI-MMC PREVENT/ALLOW MEDIUM REMOVAL.
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param b_prevent true of drive locked and false if unlocked
@param b_persisent make b_prevent state persistent @param b_persisent make b_prevent state persistent
@param b_prevent true of drive locked and false if unlocked
@param i_timeout_ms value in milliseconds to use on timeout. Setting
to 0 uses the default time-out value stored in
mmc_timeout_ms.
@return DRIVER_OP_SUCCESS (0) if we got the status. @return DRIVER_OP_SUCCESS (0) if we got the status.
return codes are the same as driver_return_code_t return codes are the same as driver_return_code_t