diff options
author | Ingo Huerner <ingo.huerner@xse.de> | 2014-05-14 09:53:08 +0200 |
---|---|---|
committer | Ingo Huerner <ingo.huerner@xse.de> | 2014-05-14 09:53:08 +0200 |
commit | a543d9192faae6d54941eb2bc683808a234acfd4 (patch) | |
tree | 8f0fe4a359247a3755d086502ef038f6609b7d8a /include | |
parent | b5c52f74865d8e95db66a36fae4acb23ed22f16f (diff) | |
download | persistence-client-library-a543d9192faae6d54941eb2bc683808a234acfd4.tar.gz |
Adjusted data definitions according to PCO; Added doxygen config file
Diffstat (limited to 'include')
-rw-r--r-- | include/persistence_client_library.h | 15 |
1 files changed, 14 insertions, 1 deletions
diff --git a/include/persistence_client_library.h b/include/persistence_client_library.h index 9328712..c0735ff 100644 --- a/include/persistence_client_library.h +++ b/include/persistence_client_library.h @@ -24,13 +24,26 @@ * */ /** \ingroup GEN_PERS */ -/** \defgroup PERS_CLIENT Client: initialisation access +/** \defgroup PERS_CLIENT Client: initialization access * \{ */ /** \defgroup PERS_CLIENT_INTERFACE API document * \{ */ +/** + * @mainpage The Persistence Client Library documentation + * GENIVI's Persistence Client Library, known as PCL, is responsible for handling persistent data, + * including all data read and modified during a lifetime of an infotainment system.<br> + * "Persistent data" is data stored in a non-volatile storage such as a hard disk drive or FLASH memory. + * <br><br> + * The Persistence Client Library (PCL) provides an API to applications to read and write persistent data + * via a key-value and a file interface.<br> + * It also provide a plugin API to allow users to extend the client library with custom storage solutions. + */ + + + #ifdef __cplusplus extern "C" { #endif |