From 1387f0a8548b2078acb7741aaa303dc174d00f54 Mon Sep 17 00:00:00 2001
From: Lochan Babani <lochan212@gmail.com>
Date: Fri, 11 Jan 2019 07:03:31 +0000
Subject: [PATCH] Add description of base classes.

---
 skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py | 4 +++-
 skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py       | 2 +-
 skabase/SKACapability/SKACapability/SKACapability.py       | 2 +-
 skabase/SKALogger/SKALogger/SKALogger.py                   | 3 ++-
 skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py          | 3 ++-
 skabase/SKASubarray/SKASubarray/SKASubarray.py             | 3 ++-
 6 files changed, 11 insertions(+), 6 deletions(-)

diff --git a/skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py b/skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py
index cf419693..7f575aab 100644
--- a/skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py
+++ b/skabase/SKAAlarmHandler/SKAAlarmHandler/SKAAlarmHandler.py
@@ -7,7 +7,9 @@
 
 """ SKAAlarmHandler
 
-A generic base device for Alarms for SKA.
+A generic base device for Alarms for SKA. It exposes SKA alarms and SKA alerts as TANGO attributes.
+SKA Alarms and SKA/Element Alerts are rules-based configurable conditions that can be defined over multiple
+attribute values and quality factors, and are separate from the "built-in" TANGO attribute alarms.
 """
 
 # tango imports
diff --git a/skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py b/skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py
index 859400c4..425e4305 100644
--- a/skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py
+++ b/skabase/SKABaseDevice/SKABaseDevice/SKABaseDevice.py
@@ -7,7 +7,7 @@
 
 """ SKABASE
 
-A generic base device for SKA.
+A generic base device for SKA. It exposes the generic attributes, properties and commands of an SKA device.
 """
 
 # tango imports
diff --git a/skabase/SKACapability/SKACapability/SKACapability.py b/skabase/SKACapability/SKACapability/SKACapability.py
index e9658eca..2c1f3625 100644
--- a/skabase/SKACapability/SKACapability/SKACapability.py
+++ b/skabase/SKACapability/SKACapability/SKACapability.py
@@ -23,7 +23,7 @@ __all__ = ["SKACapability", "main"]
 
 class SKACapability(SKAObsDevice):
     """
-    Subarray handling device
+    A Subarray handling device. It exposes the instances of configured capabilities.
     """
     __metaclass__ = DeviceMeta
     # PROTECTED REGION ID(SKACapability.class_variable) ENABLED START #
diff --git a/skabase/SKALogger/SKALogger/SKALogger.py b/skabase/SKALogger/SKALogger/SKALogger.py
index 78ae83c6..5a1c30f3 100644
--- a/skabase/SKALogger/SKALogger/SKALogger.py
+++ b/skabase/SKALogger/SKALogger/SKALogger.py
@@ -8,7 +8,8 @@
 
 """ SKALogger
 
-A generic base device for Logging for SKA.
+A generic base device for Logging for SKA. It enables to view on-line logs through the TANGO Logging Services
+ and to store logs using Python logging. It configures the log levels of remote logging for selected devices.
 """
 
 # tango imports
diff --git a/skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py b/skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py
index 5034d641..d0044568 100644
--- a/skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py
+++ b/skabase/SKAObsDevice/SKAObsDevice/SKAObsDevice.py
@@ -7,7 +7,8 @@
 
 """ SKAObsDevice
 
-A generic base device for Observations for SKA.
+A generic base device for Observations for SKA. It inherits SKABaseDevice class. Any device implementing
+and obsMode will inherit from SKAObsDevice instead of just SKABaseDevice.
 """
 
 # tango imports
diff --git a/skabase/SKASubarray/SKASubarray/SKASubarray.py b/skabase/SKASubarray/SKASubarray/SKASubarray.py
index 8297abb0..a52e11b8 100644
--- a/skabase/SKASubarray/SKASubarray/SKASubarray.py
+++ b/skabase/SKASubarray/SKASubarray/SKASubarray.py
@@ -7,7 +7,8 @@
 
 """ SKASubarray
 
-SubArray handling device
+A SubArray handling device. It allows the assigning/releasing of resources into/from Subarray, configuring
+capabilities, and exposes the related information like assigned resources, configured capabilities, etc.
 """
 
 # tango imports
-- 
GitLab