Reacted on doxygen errors of Debian buildd

This commit is contained in:
Thomas Schmitt 2009-12-31 14:42:09 +00:00
parent c7a6796ba7
commit aebaca8b99
2 changed files with 18 additions and 17 deletions

View File

@ -2,7 +2,7 @@
/* /*
API definition of libisoburn. API definition of libisoburn.
Copyright 2007-2009 Vreixo Formoso Lopes <metalpain2002@yahoo.es> Copyright 2007-2010 Vreixo Formoso Lopes <metalpain2002@yahoo.es>
and Thomas Schmitt <scdbackup@gmx.net> and Thomas Schmitt <scdbackup@gmx.net>
*/ */
@ -438,7 +438,7 @@ enum burn_disc_status isoburn_disc_get_status(struct burn_drive *drive);
/** Tells whether the media can be treated by isoburn_disc_erase(). /** Tells whether the media can be treated by isoburn_disc_erase().
Wrapper for: burn_disc_erasable() Wrapper for: burn_disc_erasable()
@since 0.1.0 @since 0.1.0
@param drive The drive to inquire. @param d The drive to inquire.
@return 0=not erasable , else erasable @return 0=not erasable , else erasable
*/ */
int isoburn_disc_erasable(struct burn_drive *d); int isoburn_disc_erasable(struct burn_drive *d);
@ -463,7 +463,7 @@ void isoburn_disc_erase(struct burn_drive *drive, int fast);
of libisoburn and libisofs. of libisoburn and libisofs.
Note: Sessions and tracks are counted beginning with 1, not with 0. Note: Sessions and tracks are counted beginning with 1, not with 0.
@since 0.1.6 @since 0.1.6
@param drive The drive where msc1 is to be set @param d The drive where msc1 is to be set
@param adr_mode Determines how to interpret adr_value and to set msc1. @param adr_mode Determines how to interpret adr_value and to set msc1.
If adr_value shall represent a number then decimal ASCII If adr_value shall represent a number then decimal ASCII
digits are expected. digits are expected.
@ -521,8 +521,8 @@ struct isoburn_toc_track;
isoburn_toc_disc_free() when no longer needed. isoburn_toc_disc_free() when no longer needed.
Wrapper for: burn_drive_get_disc() Wrapper for: burn_drive_get_disc()
@since 0.1.6 @since 0.1.6
@param drive The drive with the media to inspect @param d The drive with the media to inspect
@return NULL in case there is no content info, else it is a valid handle @return NULL in case there is no content info, else it is a valid handle
*/ */
struct isoburn_toc_disc *isoburn_toc_drive_get_disc(struct burn_drive *d); struct isoburn_toc_disc *isoburn_toc_drive_get_disc(struct burn_drive *d);
@ -531,8 +531,8 @@ struct isoburn_toc_disc *isoburn_toc_drive_get_disc(struct burn_drive *d);
This number includes the eventual gaps between sessions and tracks. This number includes the eventual gaps between sessions and tracks.
So this call is not really a wrapper for burn_disc_get_sectors(). So this call is not really a wrapper for burn_disc_get_sectors().
@since 0.1.6 @since 0.1.6
@param disc The master handle of the media @param disc The master handle of the media
@return number of blocks, <=0 indicates unknown or unreadable state @return Number of blocks, <=0 indicates unknown or unreadable state
*/ */
int isoburn_toc_disc_get_sectors(struct isoburn_toc_disc *disc); int isoburn_toc_disc_get_sectors(struct isoburn_toc_disc *disc);
@ -622,7 +622,7 @@ void isoburn_toc_disc_free(struct isoburn_toc_disc *disc);
image header and obtain its alleged size. Depending on the info mode image header and obtain its alleged size. Depending on the info mode
one other string of text information can be retrieved too. one other string of text information can be retrieved too.
@since 0.1.6 @since 0.1.6
@param drive The drive with the media to inspect @param d The drive with the media to inspect
@param lba The block number from where to read @param lba The block number from where to read
@param image_blocks The number of 2048 bytes blocks @param image_blocks The number of 2048 bytes blocks
@param info Caller provided memory, enough to take eventual info reply @param info Caller provided memory, enough to take eventual info reply
@ -646,7 +646,7 @@ int isoburn_read_iso_head(struct burn_drive *d, int lba,
which would describe it. which would describe it.
Note: Sessions and tracks are counted beginning with 1, not with 0. Note: Sessions and tracks are counted beginning with 1, not with 0.
@since 0.3.2 @since 0.3.2
@param drive The drive where msc1 is to be set @param d The drive where msc1 is to be set
@param adr_mode Determines how to interpret the input adr_value. @param adr_mode Determines how to interpret the input adr_value.
If adr_value shall represent a number then decimal ASCII If adr_value shall represent a number then decimal ASCII
digits are expected. digits are expected.
@ -811,7 +811,7 @@ int isoburn_ropt_get_input_charset(struct isoburn_read_opts *o,
Enable or disable methods to automatically choose an input charset. Enable or disable methods to automatically choose an input charset.
This eventually overrides the name set via isoburn_ropt_set_input_charset() This eventually overrides the name set via isoburn_ropt_set_input_charset()
@since 0.3.8 @since 0.3.8
@param o The option set to work on
@param mode Bitfield for control purposes: @param mode Bitfield for control purposes:
bit0= allow to set the input character set automatically from bit0= allow to set the input character set automatically from
attribute "isofs.cs" of root directory. attribute "isofs.cs" of root directory.
@ -1300,7 +1300,7 @@ int isoburn_disc_track_lba_nwa(struct burn_drive *d, struct burn_write_opts *o,
overwriteable media. This value is supposed to be <= 2048 * nwa as of overwriteable media. This value is supposed to be <= 2048 * nwa as of
isoburn_disc_track_lba_nwa(). isoburn_disc_track_lba_nwa().
@since 0.1.0 @since 0.1.0
@param drive The drive holding the media. @param d The drive holding the media.
@param start_byte The reply value counted in bytes, not in sectors. @param start_byte The reply value counted in bytes, not in sectors.
@param flag Unused yet. Submit 0. @param flag Unused yet. Submit 0.
@return 1=stat_byte is valid, 0=not an emulated appendable, -1=error @return 1=stat_byte is valid, 0=not an emulated appendable, -1=error
@ -1390,9 +1390,10 @@ int isoburn_prepare_new_image(struct burn_drive *in_drive,
the in_drive media. the in_drive media.
@return <=0 error , 1 = success @return <=0 error , 1 = success
*/ */
int isoburn_prepare_blind_grow(struct burn_drive *d, struct burn_disc **disc, int isoburn_prepare_blind_grow(struct burn_drive *in_drive,
struct isoburn_imgen_opts *opts, struct burn_disc **disc,
struct burn_drive *out_drive, int nwa); struct isoburn_imgen_opts *opts,
struct burn_drive *out_drive, int nwa);
/** /**
@ -1473,7 +1474,7 @@ int isoburn_drive_wrote_well(struct burn_drive *d);
@param d The output drive to which the session was written @param d The output drive to which the session was written
@return 1 success , <=0 failure @return 1 success , <=0 failure
*/ */
int isoburn_activate_session(struct burn_drive *drive); int isoburn_activate_session(struct burn_drive *d);
/** Wait after normal end of operations until libisofs ended all write /** Wait after normal end of operations until libisofs ended all write
@ -1522,6 +1523,6 @@ void isoburn_finish(void);
1 is emulated multi-session 1 is emulated multi-session
-1 is not suitable for isoburn -1 is not suitable for isoburn
*/ */
int isoburn_needs_emulation(struct burn_drive *drive); int isoburn_needs_emulation(struct burn_drive *d);

View File

@ -1 +1 @@
#define Xorriso_timestamP "2009.12.31.142331" #define Xorriso_timestamP "2009.12.31.144342"