Update po files.

[platform/upstream/cryptsetup.git] / docs / doxygen_index

diff --git a/docs/doxygen_index b/docs/doxygen_index
index 055093d..3bca941 100644 (file)
--- a/docs/doxygen_index
+++ b/docs/doxygen_index
@@ -3,27 +3,29 @@
  *
  * The documentation covers public parts of cryptsetup API. In the following sections you'll find
  * the examples that describe some features of cryptsetup API.
+ * For more info about libcryptsetup API versions see
+ * <a href="http://upstream-tracker.org/versions/libcryptsetup.html">Upstream Tracker</a>.
  *
  * <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 +35,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 +47,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
@@ -97,23 +99,23 @@
  *
  *             @subsection cluks_ex crypt_luks_usage.c - Complex example
  *
- *                     To compile and link against current libcryptsetup use command:
+ *                     To compile and run use following commands in examples directory:
  *
  * @code
- * gcc -Wall -L../../lib/.libs -I../../lib -lcryptsetup crypt_luks_usage.c -o crypt_luks_usage
- * LD_LIBRARY_PATH=../../lib/.libs ./crypt_luks_usage _path_to_[block_device]_file
+ * make
+ * ./crypt_luks_usage _path_to_[block_device]_file
  * @endcode
  *
- *                     Note that you need to have the cryptsetup library compiled. @include crypt_log_usage.c
+ *                     Note that you need to have the cryptsetup library compiled. @include crypt_luks_usage.c
  *
  *     @section clog crypt_log_usage - cryptsetup logging API example
  *
- *             Example describes basic use case for cryptsetup logging API. To compile the example and link
- *             against current libcryptsetup use command:
+ *             Example describes basic use case for cryptsetup logging. To compile and run
+ *             use following commands in examples directory:
  *
  * @code
- * gcc -Wall -L../../lib/.libs -I../../lib -lcryptsetup crypt_log_usage.c -o crypt_log_usage
- * LD_LIBRARY_PATH=../../.libs ./crypt_log_usage
+ * make
+ * ./crypt_log_usage
  * @endcode
  *
  *             Note that you need to have the cryptsetup library compiled. @include crypt_log_usage.c