Hopefully silenced warnings of doxygen on Debian buildd

doc/comments

@@ -10,7 +10,7 @@ optical discs. This page is about its capability to read, manipulate, and
 write ISO 9660 filesystems with Rock Ridge extensions. Media can be optical
 media or filesystem objects.
 
-Our scope is currently Linux 2.4 and 2.6, or FreeBSD .
+Our scope is currently Linux 2.4 and 2.6, or FreeBSD, or OpenSolaris.
 
 libisoburn is an add-on to libburn and libisofs which coordinates both and
 also allows to grow ISO-9660 filesystem images on multi-session media as well
@@ -21,7 +21,9 @@ xorriso is an application of all three libraries which creates, loads,
 manipulates and writes ISO 9660 filesystem images with Rock Ridge extensions.
 Manipulation is not only adding or overwriting of files but also deletion,
 renaming, and attribute changing. An incremental backup feature is provided.
-See xorriso/README for more
+The xorriso features are accessible via built-in command interpreters and
+via a C language API.
+
 
 SONAME:
 libisoburn.so.1 (since 0.1.0, February 2008).
@@ -32,7 +34,7 @@ libisoburn.so.1 (since 0.1.0, February 2008).
 Our build system is based on autotools.
 User experience tells us that you will need at least autotools version 1.7.
 
-To build libisoburn go into its toplevel directory and execute
+To build libisoburn go into its toplevel directory and execute:
 
 -  ./bootstrap  (needed if you downloaded from SVN)
 
@@ -40,14 +42,28 @@ To build libisoburn go into its toplevel directory and execute
 
 -  make
 
-To make the libraries accessible for running resp. developing applications 
+To make the library and the xorriso application accessible for running resp.
+software development:
 
 -  make install
 
-Read libisoburn/libisoburn.h for a description of the API.
-See also README, xorriso/README, and the man page xorriso/xorriso.1 which
-gives an idea of the capabilities provided by Libburnia.
 
+For direct use as command line tool use the xorriso binary which among many
+other features provides a mkisofs emulation via command "-as mkisofs".
+See man page xorriso/xorriso.1 or GNU info document xorriso/xorriso.info.
+
+
+If you want to link an own application with libisoburn, you have
+two alternative APIs for choice:
+
+-  libisoburn, together with libburn and libisofs.
+
+-  xorriso, a complete representation of xorriso command line options.
+   It encapsulates the three lower level libraries.
+   Calls of both API families shall not be mixed.
+
+For a description of the lbisoburn API read libisoburn/libisoburn.h
+See file README for download and installation of a release tarball.
 You will also have to install and understand the two libraries of the 
 Libburnia project which provide fundamental services:
 libburn is the library by which preformatted data get onto optical media.
@@ -55,4 +71,15 @@ See libburn/libburn.h for its API description.
 libisofs is the library to handle ISO 9660 filesystems with Rock Ridge 
 extensions. Its API is described in libisofs/libisofs.h .
 
+For xorriso features see its man page xorriso/xorriso.1 or
+its GNU info document xorriso/xorriso.info.
+For the corresponding C language API see libisoburn/xorriso.h (resp.
+xorriso/xorriso.h in the build directory).
+The implementation this API is part of libisoburn.
+The xorriso command line tool gets installed as dynamically linked
+binary together with libisoburn.
+
+There is also a statically linked release named GNU xorriso.
+See xorriso/README_gnu_xorriso for its download and installation.
+
 */

libisoburn/libisoburn.h

@@ -1173,7 +1173,7 @@ int isoburn_igopt_get_data_start(struct isoburn_imgen_opts *o, int *lba);
 /** Set resp. get parameters "name" and "timestamp" for a scdbackup checksum
     tag. It will be appended to the libisofs session tag if the image starts at
     LBA 0. See isoburn_disc_track_lba_nwa. The scdbackup tag can be used
-    to verify the image by command scdbackup_verify <device> -auto_end.
+    to verify the image by command scdbackup_verify $device -auto_end.
     See scdbackup/README appendix VERIFY for its inner details.
     @since 0.4.4
     @param o          The option set to work on
@@ -1225,17 +1225,22 @@ int isoburn_igopt_get_system_area(struct isoburn_imgen_opts *o,
 /** Explicitely set the four timestamps of the emerging ISO image.
     Default with all parameters is 0.
     @since 0.5.4
-    ECMA-119 defines the timestamps in the Primary Volume Descriptor as:
+    @param opts
+           The option set to work on
     @param creation_time
+           ECMA-119 Volume Creation Date and Time
            When "the information in the volume was created."
            A value of 0 means that the timepoint of write start is to be used.
     @param modification_time
+           ECMA-119 Volume Modification Date and Time
            When "the informationin the volume was last modified."
            A value of 0 means that the timepoint of write start is to be used.
     @param expiration_time
+           ECMA-119 Volume Expiration Date and Time
            When "the information in the volume may be regarded as obsolete."
            A value of 0 means that the information never shall expire.
     @param effective_time
+           ECMA-119 Volume Effective Date and Time
            When "the information in the volume may be used."
            A value of 0 means that not such retention is intended.
     @param uuid

xorriso/xorriso_timestamp.h

@@ -1 +1 @@
-#define Xorriso_timestamP "2010.07.31.085437"
+#define Xorriso_timestamP "2010.08.09.092037"