Add documentation for the NodeStartupControllerApplication class

2 files changed, 32 insertions, 0 deletions

diff --git a/NEWS b/NEWS
index 2ad63ed..5b80c9a 100644
--- a/NEWS
+++ b/NEWS
@@ -9,6 +9,7 @@ x.y.z
 * Add documentation for the LAHandlerService 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/node-startup-controller-application.c b/node-startup-controller/node-startup-controller-application.c
index e3684fa..18f1c01 100644
--- a/node-startup-controller/node-startup-controller-application.c
+++ b/node-startup-controller/node-startup-controller-application.c
@@ -80,6 +80,22 @@ static void     node_startup_controller_application_unregister_shutdown_consumer
 
 
 
+/**
+ * SECTION: node-startup-controller-application
+ * @title: NodeStartupControllerApplication
+ * @short_description: the main class that integrates all other components
+ * @stability: Internal
+ *
+ * The #NodeStartupControllerApplication is the main class, it is the place where all
+ * internal components of the Node Startup Controller are integrated.
+ * It manages the life time of the main loop. When it starts, it restores the LUC if this
+ * is required. When it shuts down or receives a SIGTERM signal, it cancels the LUC
+ * startup and deregisters the shutdown consumers. Notice that it registers/unregisters
+ * itself as a shutdown consumer within Node State Manager.
+ */
+
+
+
 struct _NodeStartupControllerApplicationClass
 {
   GObjectClass __parent__;
@@ -597,6 +613,21 @@ node_startup_controller_application_unregister_shutdown_consumer (NodeStartupCon
 
 
 
+/**
+ * node_startup_controller_application_new:
+ * @main_loop: The application's main loop.
+ * @connection: A connection to the system bus.
+ * @job_manager: A #JobManager object.
+ * @la_handler: A #LAHandlerService object.
+ * @node_startup_controller: A #NodeStartupControllerService object.
+ *
+ * Creates a new #NodeStartupControllerApplication object.
+ *
+ * Returns: A new instance of the #NodeStartupControllerApplication.
+ */
+
+
+
 NodeStartupControllerApplication *
 node_startup_controller_application_new (GMainLoop                    *main_loop,
                                          GDBusConnection              *connection,