claunia/libcdio-osx
Archived
1
0
Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen lint corrections.

Browse Source
This commit is contained in:
rocky
2005-03-21 09:19:06 +00:00
parent 74dc895997
commit 2a11267eb9
4 changed files with 23 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
include/cdio/audio.h
View File

@@ -1,5 +1,5 @@
/* -*- c -*- /* -*- c -*-
$Id: audio.h,v 1.9 2005/03/19 06:42:24 rocky Exp $ $Id: audio.h,v 1.10 2005/03/21 09:19:06 rocky Exp $
Copyright (C) 2005 Rocky Bernstein <rocky@panix.com> Copyright (C) 2005 Rocky Bernstein <rocky@panix.com>
@@ -87,21 +87,16 @@ extern "C" {
*/ */
driver_return_code_t cdio_audio_pause (CdIo_t *p_cdio); driver_return_code_t cdio_audio_pause (CdIo_t *p_cdio);
/*!
Pause playing CD through analog output
@param p_cdio the CD object to be acted upon.
*/
driver_return_code_t cdio_audio_pause (CdIo_t *p_cdio);
/*! /*!
Playing CD through analog output at the given MSF. Playing CD through analog output at the given MSF.
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param p_start_msf pointer to staring MSF
@param p_end_msf pointer to ending MSF
*/ */
driver_return_code_t cdio_audio_play_msf (CdIo_t *p_cdio, driver_return_code_t cdio_audio_play_msf (CdIo_t *p_cdio,
msf_t *p_start_msf, /*in*/msf_t *p_start_msf,
msf_t *p_end_msf); /*in*/ msf_t *p_end_msf);
/*! /*!
Playing CD through analog output at the desired track and index Playing CD through analog output at the desired track and index
@@ -116,9 +111,10 @@ extern "C" {
Get subchannel information. Get subchannel information.
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param p_subchannel place for returned subchannel information
*/ */
driver_return_code_t cdio_audio_read_subchannel (CdIo_t *p_cdio, driver_return_code_t cdio_audio_read_subchannel (CdIo_t *p_cdio,
cdio_subchannel_t *p_subchannel); /*out*/ cdio_subchannel_t *p_subchannel);
/*! /*!
Resume playing an audio CD. Resume playing an audio CD.
@@ -132,9 +128,10 @@ extern "C" {
Set volume of an audio CD. Set volume of an audio CD.
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param p_volume place for returned volume-level information
*/ */
driver_return_code_t cdio_audio_set_volume (CdIo_t *p_cdio, driver_return_code_t cdio_audio_set_volume (CdIo_t *p_cdio, /*out*/
cdio_audio_volume_t *p_volume); cdio_audio_volume_t *p_volume);
/*! /*!

4
include/cdio/device.h
View File

@@ -1,5 +1,5 @@
/* -*- c -*- /* -*- c -*-
$Id: device.h,v 1.22 2005/03/14 02:02:49 rocky Exp $ $Id: device.h,v 1.23 2005/03/21 09:19:06 rocky Exp $
Copyright (C) 2005 Rocky Bernstein <rocky@panix.com> Copyright (C) 2005 Rocky Bernstein <rocky@panix.com>
@@ -226,7 +226,7 @@ extern "C" {
it was DRIVER_UNKNOWN or DRIVER_DEVICE; If this is NULL, we won't it was DRIVER_UNKNOWN or DRIVER_DEVICE; If this is NULL, we won't
report back the driver used. report back the driver used.
*/ */
driver_return_code_t cdio_close_tray (const char *psz_device, driver_return_code_t cdio_close_tray (const char *psz_drive,
/*in/out*/ driver_id_t *p_driver_id); /*in/out*/ driver_id_t *p_driver_id);
/*! /*!

14
include/cdio/mmc.h
View File

@@ -1,5 +1,5 @@
/* /*
$Id: mmc.h,v 1.18 2005/03/09 10:23:01 rocky Exp $ $Id: mmc.h,v 1.19 2005/03/21 09:19:06 rocky Exp $
Copyright (C) 2003, 2004, 2005 Rocky Bernstein <rocky@panix.com> Copyright (C) 2003, 2004, 2005 Rocky Bernstein <rocky@panix.com>
@@ -420,10 +420,11 @@ typedef struct mmc_cdb_s {
Read Audio Subchannel information Read Audio Subchannel information
@param p_cdio the CD object to be acted upon. @param p_cdio the CD object to be acted upon.
@param p_subchannel place for returned subchannel information
*/ */
driver_return_code_t driver_return_code_t
mmc_audio_read_subchannel (CdIo_t *p_cdio, cdio_subchannel_t *p_subchannel); mmc_audio_read_subchannel (CdIo_t *p_cdio,
/*out*/ cdio_subchannel_t *p_subchannel);
/*! /*!
Return a string containing the name of the audio state as returned from Return a string containing the name of the audio state as returned from
@@ -632,7 +633,9 @@ mmc_audio_read_subchannel (CdIo_t *p_cdio, cdio_subchannel_t *p_subchannel);
For data Mode 2, form 2, User Data is 2 324 bytes beginning at For data Mode 2, form 2, User Data is 2 324 bytes beginning at
offset CDIO_CD_XA_SYNC_HEADER. offset CDIO_CD_XA_SYNC_HEADER.
@param b_edc_ecc, Return EDC/ECC error detection/correction bits. @param b_sync
@param b_edc_ecc true if we return EDC/ECC error detection/correction bits.
The presence and size of EDC redundancy or ECC parity is defined The presence and size of EDC redundancy or ECC parity is defined
according to sector type: according to sector type:
@@ -693,7 +696,8 @@ mmc_audio_read_subchannel (CdIo_t *p_cdio, cdio_subchannel_t *p_subchannel);
M2RAW_SECTOR_SIZE. M2RAW_SECTOR_SIZE.
@param i_lsn sector to read @param i_lsn sector to read
@param i_blocksize @param i_blocksize size of each block
@param i_blocks number of blocks to read
*/ */
driver_return_code_t mmc_read_data_sectors ( CdIo_t *p_cdio, void *p_buf, driver_return_code_t mmc_read_data_sectors ( CdIo_t *p_cdio, void *p_buf,

4
include/cdio/read.h
View File

@@ -1,5 +1,5 @@
/* -*- c -*- /* -*- c -*-
$Id: read.h,v 1.5 2005/02/17 07:03:37 rocky Exp $ $Id: read.h,v 1.6 2005/03/21 09:19:06 rocky Exp $
Copyright (C) 2005 Rocky Bernstein <rocky@panix.com> Copyright (C) 2005 Rocky Bernstein <rocky@panix.com>
@@ -97,6 +97,8 @@ extern "C" {
@param i_lsn sector to read @param i_lsn sector to read
@param i_blocksize size of block. Should be either CDIO_CD_FRAMESIZE, @param i_blocksize size of block. Should be either CDIO_CD_FRAMESIZE,
M2RAW_SECTOR_SIZE, or M2F2_SECTOR_SIZE. See comment above under p_buf. M2RAW_SECTOR_SIZE, or M2F2_SECTOR_SIZE. See comment above under p_buf.
@param i_blocks number of blocks to read
*/ */
driver_return_code_t cdio_read_data_sectors ( const CdIo_t *p_cdio, driver_return_code_t cdio_read_data_sectors ( const CdIo_t *p_cdio,
void *p_buf, lsn_t i_lsn, void *p_buf, lsn_t i_lsn,