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

Various doxygen improvements.

Browse Source
This commit is contained in:
rocky
2005-01-20 04:51:14 +00:00
parent 1b48133934
commit fb07d7d0fe
4 changed files with 29 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
include/cdio/device.h
View File

@@ -1,5 +1,5 @@
/* -*- c -*-
$Id: device.h,v 1.6 2005/01/20 00:36:38 rocky Exp $
$Id: device.h,v 1.7 2005/01/20 04:51:14 rocky Exp $
Copyright (C) 2005 Rocky Bernstein <rocky@panix.com>
@@ -462,6 +462,8 @@ extern "C" {
/*! Set up CD-ROM for reading using the BSDI driver. The device_name is
the some sort of device name.
@param psz_source the name of the device to open
@param am the preferred access mode to use
@return the cdio object for subsequent operations.
NULL on error or there is no BSDI driver.
@@ -473,6 +475,7 @@ extern "C" {
/*! Set up CD-ROM for reading using the BSDI driver. The device_name is
the some sort of device name.
@param psz_source the name of the device to open
@return the cdio object for subsequent operations.
NULL on error or there is no BSDI driver.

4
include/cdio/iso9660.h
View File

@@ -1,5 +1,5 @@
/*
$Id: iso9660.h,v 1.56 2005/01/12 11:34:52 rocky Exp $
$Id: iso9660.h,v 1.57 2005/01/20 04:51:14 rocky Exp $
Copyright (C) 2000 Herbert Valerio Riedel <hvr@gnu.org>
Copyright (C) 2003, 2004, 2005 Rocky Bernstein <rocky@panix.com>
@@ -226,7 +226,7 @@ struct iso9660_pvd {
uint32_t opt_type_m_path_table; /**< 732 encoded */
iso9660_dir_t root_directory_record; /**< See section 9.1 of
ISO 9660 spec. */
char root_directory_filename; /**< Is \0 */
char root_directory_filename; /**< Is '\\0' */
char volume_set_id[ISO_MAX_VOLUMESET_ID]; /**< dchars */
char publisher_id[ISO_MAX_PUBLISHER_ID]; /**< achars */
char preparer_id[ISO_MAX_PREPARER_ID]; /**< achars */

6
include/cdio/paranoia.h
View File

@@ -1,5 +1,5 @@
/*
$Id: paranoia.h,v 1.3 2005/01/13 04:00:15 rocky Exp $
$Id: paranoia.h,v 1.4 2005/01/20 04:51:14 rocky Exp $
Copyright (C) 2004, 2005 Rocky Bernstein <rocky@panix.com>
Copyright (C) 1998 Monty xiphmont@mit.edu
@@ -19,7 +19,7 @@
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/** \file cdda_paranoia.h
/** \file paranoia.h
* \brief The top-level header for libcdda_paranoia:
a library for reading CD-DA with error tolerance and repair.
*/
@@ -100,6 +100,8 @@ extern void paranoia_modeset(cdrom_paranoia_t *p, int mode);
/*!
reposition reading offset.
@param p paranoia type
@param seek byte offset to seek to
@param whence like corresponding parameter in libc's lseek, e.g.
SEEK_SET or SEEK_END.
*/

34
include/cdio/read.h
View File

@@ -1,5 +1,5 @@
/* -*- c -*-
$Id: read.h,v 1.1 2005/01/09 16:07:46 rocky Exp $
$Id: read.h,v 1.2 2005/01/20 04:51:14 rocky Exp $
Copyright (C) 2005 Rocky Bernstein <rocky@panix.com>
@@ -48,6 +48,10 @@ extern "C" {
Reads into buf the next size bytes.
Similar to (if not the same as) libc's read()
@param p_cdio object to read from
@param p_buf place to read data into
@param i_size number of bytes to read
@return (ssize_t) -1 on error.
*/
ssize_t cdio_read(const CdIo_t *p_cdio, void *p_buf, size_t i_size);
@@ -56,8 +60,8 @@ extern "C" {
Read an audio sector
@param p_cdio object to read from
@param buf place to read data into
@param lsn sector to read
@param p_buf place to read data into
@param i_lsn sector to read
@return 0 if no error, nonzero otherwise.
*/
@@ -67,21 +71,21 @@ extern "C" {
Reads audio sectors
@param p_cdio object to read from
@param buf place to read data into
@param lsn sector to read
@param p_buf place to read data into
@param i_lsn sector to read
@param i_sectors number of sectors to read
@return 0 if no error, nonzero otherwise.
*/
int cdio_read_audio_sectors (const CdIo_t *p_cdio, void *buf, lsn_t lsn,
int cdio_read_audio_sectors (const CdIo_t *p_cdio, void *p_buf, lsn_t i_lsn,
unsigned int i_sectors);
/*!
Reads a mode 1 sector
@param p_cdio object to read from
@param buf place to read data into
@param lsn sector to read
@param p_buf place to read data into
@param i_lsn sector to read
@param b_form2 true for reading mode 1 form 2 sectors or false for
mode 1 form 1 sectors.
@@ -94,8 +98,8 @@ extern "C" {
Reads mode 1 sectors
@param p_cdio object to read from
@param buf place to read data into
@param lsn sector to read
@param p_buf place to read data into
@param i_lsn sector to read
@param b_form2 true for reading mode 1 form 2 sectors or false for
mode 1 form 1 sectors.
@param i_sectors number of sectors to read
@@ -109,8 +113,8 @@ extern "C" {
Reads a mode 2 sector
@param p_cdio object to read from
@param buf place to read data into
@param lsn sector to read
@param p_buf place to read data into
@param i_lsn sector to read
@param b_form2 true for reading mode 2 form 2 sectors or false for
mode 2 form 1 sectors.
@@ -123,10 +127,10 @@ extern "C" {
Reads mode 2 sectors
@param p_cdio object to read from
@param buf place to read data into
@param lsn sector to read
@param p_buf place to read data into
@param i_lsn sector to read
@param b_form2 true for reading mode2 form 2 sectors or false for
mode 2 form 1 sectors.
mode 2 form 1 sectors.
@param i_sectors number of sectors to read
@return 0 if no error, nonzero otherwise.