diff options
| author | Jannis Pohlmann <jannis.pohlmann@codethink.co.uk> | 2012-08-07 14:51:46 +0100 |
|---|---|---|
| committer | Jannis Pohlmann <jannis.pohlmann@codethink.co.uk> | 2012-08-07 14:51:46 +0100 |
| commit | 89d902aabd109633a3fed7abdbe1f2cfe19f6928 (patch) | |
| tree | 11fb58bdcfed9cf74cb736ea36a103c5e1998e21 | |
| parent | bddbe4bf80aba9a3e01559275d61df5c6a389848 (diff) | |
| download | node-startup-controller-89d902aabd109633a3fed7abdbe1f2cfe19f6928.tar.gz | |
Improve class documentation a bit
| -rw-r--r-- | node-startup-controller/job-manager.c | 4 | ||||
| -rw-r--r-- | node-startup-controller/la-handler-service.c | 4 | ||||
| -rw-r--r-- | node-startup-controller/target-startup-monitor.c | 9 |
3 files changed, 9 insertions, 8 deletions
diff --git a/node-startup-controller/job-manager.c b/node-startup-controller/job-manager.c index b2ee7ad..b8a654c 100644 --- a/node-startup-controller/job-manager.c +++ b/node-startup-controller/job-manager.c @@ -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(). */ diff --git a/node-startup-controller/la-handler-service.c b/node-startup-controller/la-handler-service.c index b2d8856..ec7dc6b 100644 --- a/node-startup-controller/la-handler-service.c +++ b/node-startup-controller/la-handler-service.c @@ -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. diff --git a/node-startup-controller/target-startup-monitor.c b/node-startup-controller/target-startup-monitor.c index 2597505..4a425cf 100644 --- a/node-startup-controller/target-startup-monitor.c +++ b/node-startup-controller/target-startup-monitor.c @@ -30,11 +30,12 @@ * @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 |