From 3b24e30b5406b3ff12a6c786eef37b2bda8b0e9c Mon Sep 17 00:00:00 2001
From: Francisco Redondo Marchena <francisco.marchena@codethink.co.uk>
Date: Tue, 7 Aug 2012 17:10:38 +0100
Subject: Document the LUCStarter class

---
 NEWS                                  |  3 ++-
 node-startup-controller/luc-starter.c | 40 ++++++++++++++++++++++++++++++++++-
 2 files changed, 41 insertions(+), 2 deletions(-)

diff --git a/NEWS b/NEWS
index 90497fe..e2ddcb4 100644
--- a/NEWS
+++ b/NEWS
@@ -7,10 +7,11 @@ x.y.z
   GLib)
 * Add documentation for the JobManager class
 * Add documentation for the LAHandlerService class
+* Add documentation for the LUCStarter class
+* Add documentation for the NodeStartupControllerApplication class
 * Add documentation for the ShutdownClient class
 * Add documentation for the TargetStartupMonitor class
 * Add documentation for the WatchdogClient class
-* Add documentation for the NodeStartupControllerApplication class
 * License the reference manual under Creative Commons CC0 1.0
   Universal (CC0 1.0)
 
diff --git a/node-startup-controller/luc-starter.c b/node-startup-controller/luc-starter.c
index 6391a27..6e67f10 100644
--- a/node-startup-controller/luc-starter.c
+++ b/node-startup-controller/luc-starter.c
@@ -81,6 +81,21 @@ static void luc_starter_start_groups_for_real     (LUCStarter   *starter);
 
 
 
+/**
+ * SECTION: luc-starter
+ * @title: LUCStarter
+ * @short_description: Starts the applications registered with the Last User Context
+ * @stability: Internal
+ *
+ * The #LUCStarter starts the Last User Context (LUC) applications. The LUC applications
+ * are started asynchronously and in groups (one group per LUC type).
+ * The #LUCStarter checks with Node State Manager (NSM) if starting the LUC applications
+ * is required. If it is required, the #LUCStarter will start the LUC applications.
+ * Notice that it is possible to cancel the start of the LUC applications.
+ */
+
+
+
 struct _LUCStarterClass
 {
   GObjectClass __parent__;
@@ -611,6 +626,15 @@ luc_starter_start_groups_for_real (LUCStarter *starter)
 
 
 
+/**
+ * luc_starter_new:
+ * @job_manager: A #JobManager object.
+ * @node_startup_controller: A #NodeStartupControllerService object.
+ *
+ * Creates a new #LUCStarter object.
+ *
+ * Returns: A new instance of the #LUCStarter.
+ */
 LUCStarter *
 luc_starter_new (JobManager                   *job_manager,
                  NodeStartupControllerService *node_startup_controller)
@@ -626,6 +650,13 @@ luc_starter_new (JobManager                   *job_manager,
 
 
 
+/**
+ * luc_starter_start_groups:
+ * @starter: A #LUCStarter object.
+ *
+ * Checks with the NSM whether to start the LUC applications or not. If it is required to
+ * start the LUC or the NSM is unavailable, it will start the LUC.
+ */
 void
 luc_starter_start_groups (LUCStarter *starter)
 {
@@ -634,7 +665,7 @@ luc_starter_start_groups (LUCStarter *starter)
   /* check whether the NSMLifecycleProxy is available or not */
   if (starter->nsm_lifecycle_control != NULL)
     {
-      /* check with NSM whether to load the LUC */
+      /* check with NSM whether to start the LUC */
       nsm_lifecycle_control_call_check_luc_required (starter->nsm_lifecycle_control, NULL,
                                                      luc_starter_check_luc_required_finish,
                                                      starter);
@@ -651,6 +682,13 @@ luc_starter_start_groups (LUCStarter *starter)
 
 
 
+/**
+ * luc_starter_cancel:
+ * @starter: A #LUCStarter object.
+ *
+ * Cancel the start of the LUC.
+ *
+ */
 void
 luc_starter_cancel (LUCStarter *starter)
 {
-- 
cgit v1.2.1