X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=include%2Fpersistence_client_library.h;h=b63ff0f155a246450016c6c3c60a6285384f5db2;hb=b13802972ee82370c33a14150e480220761cac75;hp=c0735ff72290ddb39fe71be21cb03b45aa615ac0;hpb=a543d9192faae6d54941eb2bc683808a234acfd4;p=profile%2Fivi%2Fpersistence-client-library.git
diff --git a/include/persistence_client_library.h b/include/persistence_client_library.h
index c0735ff..b63ff0f 100644
--- a/include/persistence_client_library.h
+++ b/include/persistence_client_library.h
@@ -40,6 +40,52 @@
* The Persistence Client Library (PCL) provides an API to applications to read and write persistent data
* via a key-value and a file interface.
* It also provide a plugin API to allow users to extend the client library with custom storage solutions.
+ *
+ * @section doc Further documentation
+ * @subsection docUser User Manual
+ * There is a a user manual for the client library available,
+ * see: http://docs.projects.genivi.org/persistence-client-library/1.0/GENIVI_Persistence_Client_Library_UserManual.pdf
+ *
+ * @subsection docArch Architecture Manual
+ * For more information about the persistence architecture,
+ * see: http://docs.projects.genivi.org/persistence-client-library/1.0/GENIVI_Persistence_ArchitectureDocumentation.pdf
+ *
+ *
+ * @section plugin Custom plugin configuration file
+ * @attention
+ * The plugin configuration file has been changed!
+ *
+ * The configuration file has now the following format
+ * <predefinedPluginName> <pathAndLibraryName> <loadingType> <initType>
+ *
+ * Predefined plugin name
+ * Use one of the following names:
+ * - early => predefined custom library for early persistence
+ * - secure => predefined custom library for secure persistence
+ * - emergency => predefined custom library for emengency persistence
+ * - hwinfo => predefined custom library for hw information
+ * - custom1 => custom library 1
+ * - custom2 => custom library 2
+ * - custom3 => custom library 3
+ *
+ * Path and library name:
+ * The name and path of the library
+ *
+ * Valid loading type:
+ * - "init" ==> if the plugin must be laoding during the pclInitLibrary function
+ * - "on" ==> if on demand laoding of the plugin is requested. The plugin will be loaded
+ * when a plugin function will be loaded the first time
+ *
+ * Init Type:
+ * - sync ==> use the "plugin_init" function for plugin initialization
+ * - async ==> use the "plugin_init_async" function for plugin initialization
+ *
+ * Example:
+ * hwinfo /usr/local/lib/libhwinfoperscustom.so init async
+ *
+ * @note
+ * Make sure that there is only ONE blank between each entry and no blank at the end of the file.
+ * The parser has been optimized for speed, so there is less error checking.
*/
@@ -89,7 +135,7 @@ extern "C" {
*
* @return positive value: success;
* On error a negative value will be returned with the following error codes:
- * ::EPERS_NOT_INITIALIZED, ::EPERS_INIT_DBUS_MAINLOOP,
+ * ::EPERS_NOT_INITIALIZED, ::EPERS_DBUS_MAINLOOP,
* ::EPERS_REGISTER_LIFECYCLE, ::EPERS_REGISTER_ADMIN
*/
int pclInitLibrary(const char* appname, int shutdownMode);
@@ -123,12 +169,12 @@ int pclDeinitLibrary(void);
* In the next lifecycle the application can store data again until the limit above
* has been reached.
*
- * @parm PCL_SHUTDOWN for write back data when shutdown is requested,
- * and PCL_SHUTDOWN_CANEL when shutdown cancel request has been received.
+ * @param shutdown PCL_SHUTDOWN for write back data when shutdown is requested,
+ * and PCL_SHUTDOWN_CANEL when shutdown cancel request has been received.
*
* @return positive value: success;
* On error a negative value will be returned with the following error codes:
- * ::EPERS_COMMON, :.EPERS_MAX_CANCEL_SHUTDOWN, ::EPERS_SHTDWN_NO_PERMIT
+ * ::EPERS_COMMON, ::EPERS_SHUTDOWN_MAX_CANCEL, ::EPERS_SHUTDOWN_NO_PERMIT
*/
int pclLifecycleSet(int shutdown);