diff options
| author | David Oberhollenzer <david.oberhollenzer@sigma-star.at> | 2020-03-21 16:44:29 +0100 |
|---|---|---|
| committer | David Oberhollenzer <david.oberhollenzer@sigma-star.at> | 2020-03-22 23:30:28 +0100 |
| commit | 1abe9ec858bafc20c4cc588443b02539448ffd71 (patch) | |
| tree | 7fa2a281c14539a0f1a5d1074c37d393577592b0 /doc | |
| parent | 850107807e112a3ddd8cab30d8453a4610245bc4 (diff) | |
doxygen: add rudmentary main page to the API reference manual
Signed-off-by: David Oberhollenzer <david.oberhollenzer@sigma-star.at>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Makemodule.am | 2 | ||||
| -rw-r--r-- | doc/mainpage.dox | 19 |
2 files changed, 20 insertions, 1 deletions
diff --git a/doc/Makemodule.am b/doc/Makemodule.am index b215d5d..9963467 100644 --- a/doc/Makemodule.am +++ b/doc/Makemodule.am @@ -1,4 +1,4 @@ dist_man1_MANS += doc/gensquashfs.1 doc/rdsquashfs.1 doc/sqfs2tar.1 dist_man1_MANS += doc/tar2sqfs.1 doc/sqfsdiff.1 -EXTRA_DIST += doc/format.txt doc/parallelism.txt +EXTRA_DIST += doc/format.txt doc/parallelism.txt doc/mainpage.dox diff --git a/doc/mainpage.dox b/doc/mainpage.dox new file mode 100644 index 0000000..c676481 --- /dev/null +++ b/doc/mainpage.dox @@ -0,0 +1,19 @@ +/** + * @mainpage libsquashfs API reference + * + * @section intro Introduction + * + * The libsquashfs library attempts to encapsulate the actual core of the + * SquashFS reading and writing logic of the squashfs-tools-ng package, + * while trying to offer a generic API that should cover a broad variety of + * applications that might want to make use SquashFS. + * + * All disk I/O is abstracted away through the \ref sqfs_file_t interface. A + * reference implementation that uses native file I/O can be instatiated + * using @ref sqfs_open_file. Providing a custom implementation allows reading + * or writing SquashFS images to something other than regular files, embedding + * SquashFS in a custom container format or applying custom transformations on + * the raw byte level. + * + * @example list_files.c + */ |