Improve class documentation a bit
authorJannis Pohlmann <jannis.pohlmann@codethink.co.uk>
Tue, 7 Aug 2012 13:51:46 +0000 (14:51 +0100)
committerJannis Pohlmann <jannis.pohlmann@codethink.co.uk>
Tue, 7 Aug 2012 13:51:46 +0000 (14:51 +0100)
node-startup-controller/job-manager.c
node-startup-controller/la-handler-service.c
node-startup-controller/target-startup-monitor.c

index b2ee7ad..b8a654c 100644 (file)
@@ -26,8 +26,8 @@
  * @stability: Internal
  * 
  * The Job Manager simplifies starting and stopping systemd units by handling all the
- * JobRemoved signals internally, so units can be started and stopped using
- * job_manager_start() and job_manager_stop().
+ * D-Bus communication with the systemd manager internally. Units can be started and
+ * stopped using job_manager_start() and job_manager_stop().
  */
 
 
index b2d8856..ec7dc6b 100644 (file)
@@ -33,8 +33,8 @@
  * @short_description: Handles registration of legacy apps with the Node State Manager
  * @stability: Internal
  * 
- * The la-handler service provides an internal D-Bus interface for the #legacy-app-handler
- * helper binary to interface with.
+ * The #LAHandlerService class provides an internal D-Bus interface for the
+ * #legacy-app-handler helper binary to interface with.
  * From this, it communicates with the Node State Manager to register shutdown clients
  * with the Node State Manager, and shuts down those shutdown clients when the Node State
  * Manager tells it to.
index 2597505..4a425cf 100644 (file)
  * @short_description: Listens to JobRemoved signals and sets the node state.
  * @stability: Internal
  * 
- * The TargetStartupMonitor is responsible for setting the state of the Node State
- * Manager using states from #NSMNodeState. It sets the node state under the following
- * circumstances:
+ * The #TargetStartupMonitor class is responsible for setting the state of the
+ * Node State Manager using states from #NSMNodeState. It sets the node state
+ * under the following * circumstances:
  * 
- * The TargetStartupMonitor has started up - set the state to
+ * The Node Startup Controller is starting up. In the GENIVI lifecycle subsystem,
+ * this means that all mandatory applications have been started - set the state to
  * %NSM_NODE_STATE_BASE_RUNNING.
  * 
  * The systemd unit %focussed.target has started - set the state to