eessppeelllloo/cryptsetup
1
0
Fork 0
mirror of https://gitlab.com/cryptsetup/cryptsetup.git synced 2025-12-12 03:10:08 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix some doxygen docs warnings and mistakes.

Browse Source 
git-svn-id: https://cryptsetup.googlecode.com/svn/trunk@621 36d66b0a-2a48-0410-832c-cd162a569da5
This commit is contained in:
Milan Broz
2011-10-08 20:27:54 +00:00
parent 7a773f70f3
commit 4e9fa4d2bb
3 changed files with 43 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

34
docs/doxygen_index
View File

@@ -5,25 +5,25 @@
* the examples that describe some features of cryptsetup API.
*
* <OL type="A">
* <LI>@ref cexamples "Cryptsetup API examples" @endref</LI>
* <LI>@ref cexamples "Cryptsetup API examples"</LI>
* <OL type="1">
* <LI>@ref cluks "crypt_luks_usage" @endref - cryptsetup LUKS device type usage examples</LI>
* <LI>@ref cluks "crypt_luks_usage" - cryptsetup LUKS device type usage examples</LI>
* <UL>
* <LI>@ref cinit "crypt_init()" @endref</LI>
* <LI>@ref cformat "crypt_format()" @endref - header and payload on mutual device</LI>
* <LI>@ref ckeys "Keyslot operations" @endref </LI>
* <LI>@ref cinit "crypt_init()"</LI>
* <LI>@ref cformat "crypt_format()" - header and payload on mutual device</LI>
* <LI>@ref ckeys "Keyslot operations" </LI>
* <UL>
* <LI>@ref ckeyslot_vol "crypt_keyslot_add_by_volume_key()" @endref</LI>
* <LI>@ref ckeyslot_pass "crypt_keyslot_add_by_passphrase()" @endref</LI>
* <LI>@ref ckeyslot_vol "crypt_keyslot_add_by_volume_key()"</LI>
* <LI>@ref ckeyslot_pass "crypt_keyslot_add_by_passphrase()"</LI>
* </UL>
* <LI>@ref cload "crypt_load() @endref"
* <LI>@ref cactivate "crypt_activate_by_passphrase()" @endref</LI>
* <LI>@ref cactive_pars "crypt_get_active_device()" @endref</LI>
* <LI>@ref cinit_by_name "crypt_init_by_name()" @endref</LI>
* <LI>@ref cdeactivate "crypt_deactivate()" @endref</LI>
* <LI>@ref cluks_ex "crypt_luks_usage.c" @endref</LI>
* <LI>@ref cload "crypt_load()"
* <LI>@ref cactivate "crypt_activate_by_passphrase()"</LI>
* <LI>@ref cactive_pars "crypt_get_active_device()"</LI>
* <LI>@ref cinit_by_name "crypt_init_by_name()"</LI>
* <LI>@ref cdeactivate "crypt_deactivate()"</LI>
* <LI>@ref cluks_ex "crypt_luks_usage.c"</LI>
* </UL>
* <LI>@ref clog "crypt_log_usage" @endref - cryptsetup logging API examples</LI>
* <LI>@ref clog "crypt_log_usage" - cryptsetup logging API examples</LI>
* </OL>
* </OL>
*
@@ -33,7 +33,7 @@
*
* Every time you need to do something with cryptsetup or dmcrypt device
* you need a valid context. The first step to start your work is
* @ref crypt_init @endref call. You can call it either with path
* @ref crypt_init call. You can call it either with path
* to the block device or path to the regular file. If you don't supply the path,
* empty context is initialized.
*
@@ -45,12 +45,12 @@
* are both stored on the same device. There's also a possibility to store header and
* data separately.
*
* <B>Bear in mind</B> that @ref crypt_format() @endref is destructive operation and it
* <B>Bear in mind</B> that @ref crypt_format() is destructive operation and it
* overwrites part of the backing block device.
*
* @subsection ckeys Keyslot operations examples
*
* After successful @ref crypt_format @endref of LUKS device, volume key is not stored
* After successful @ref crypt_format of LUKS device, volume key is not stored
* in a persistent way on the device. Keyslot area is an array beyond LUKS header, where
* volume key is stored in the encrypted form using user input passphrase. For more info about
* LUKS keyslots and how it's actually protected, please look at