From 055bdab4f515b1e93155fccbe03fac43a007aa0e Mon Sep 17 00:00:00 2001
From: "Suren A. Chilingaryan" <csa@dside.dyndns.org>
Date: Mon, 18 Jul 2005 22:00:54 +0000
Subject: Documentation     - Some small doxygen descriptions are added

---
 ui/librccui.h | 43 +++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 43 insertions(+)

(limited to 'ui/librccui.h')

diff --git a/ui/librccui.h b/ui/librccui.h
index e526c0a..cb17649 100644
--- a/ui/librccui.h
+++ b/ui/librccui.h
@@ -72,14 +72,49 @@ typedef void *rcc_ui_box;
 typedef void *rcc_ui_frame;
 typedef void *rcc_ui_page;
 
+/**
+  * Init RCC User Interface Library. This function should be called prior to any other UI functions 
+  */
 int rccUiInit();
+/**
+  * Free resources used by UI library. 
+  *
+  * @return non-zero value in the case of error.
+  */
 void rccUiFree();
 
+/**
+  * Create UI context and attach it to RCC working context. It isn't permited to attach to single
+  * working context several UI's.
+  * 
+  * @param rccctx is pointer on the RCC working context.
+  * @return pointer on newly created UI context or NULL in the case of errors.
+  */
 rcc_ui_context rccUiCreateContext(rcc_context rccctx);
+/**
+  * Destroy UI context and free all memory used. 
+  *
+  * @param ctx is UI context to be destroyed.
+  */
 void rccUiFreeContext(rcc_ui_context ctx);
 
+/**
+  * Restores current language UI menu values from #rcc_context.
+  *
+  * @param ctx is UI context.
+  */
 int rccUiRestoreLanguage(rcc_ui_context ctx);
+/**
+  * Restores complete UI configuration from #rcc_context.
+  *
+  * @param ctx is UI context.
+  */
 int rccUiRestore(rcc_ui_context ctx);
+/**
+  * Updates #rcc_context with user adjusted options from UI configuration.
+  *
+  * @param ctx is UI context.
+  */
 int rccUiUpdate(rcc_ui_context ctx);
 
 rcc_ui_widget rccUiGetLanguageMenu(rcc_ui_context ctx);
@@ -96,6 +131,14 @@ rcc_ui_frame rccUiGetLanguageFrame(rcc_ui_context ctx, rcc_ui_language_frame_nam
 rcc_ui_frame rccUiGetCharsetsFrame(rcc_ui_context ctx, rcc_ui_charset_frame_name *name);
 rcc_ui_frame rccUiGetEngineFrame(rcc_ui_context ctx, rcc_ui_engine_frame_name *name);
 
+/**
+  * Get UI option page which can be integrated in application GUI. It is up on the caller
+  * to use and destroy returned page.
+  *
+  * @param ctx is UI context.
+  * @param name provides titles which should be used on the page or NULL to use defaults.
+  * @result is created UI page or NULL in the case of errors.
+  */
 rcc_ui_page rccUiGetPage(rcc_ui_context ctx, rcc_ui_page_name *name);
 
 #ifdef __cplusplus
-- 
cgit v1.2.3