From 871d3afdf473407ed9bd3f965232125910d54ac1 Mon Sep 17 00:00:00 2001
From: Nigel Metheringham <nigel.metheringham@jrtheatre.co.uk>
Date: Thu, 1 Nov 2012 19:16:54 +0000
Subject: [PATCH] Added some documentation to the classes

---
 user | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/user b/user
index 88b20b89b48..0236e3a8e6d 100755
--- a/user
+++ b/user
@@ -165,6 +165,25 @@ except:
 
 
 class User(object):
+    """
+    This is a generic User manipulation class - generic in this case
+    meaning it is aimed at Linuxish platforms using useradd/userdel/usermod
+    On object creation it will load the most appropriate subclass based
+    on the platform and distribution.
+    
+    A subclass may wish to override the following action methods:-
+      - create_user()
+      - remove_user()
+      - modify_user()
+      - ssh_key_gen()
+      - ssh_key_fingerprint()
+
+    The main function also uses the following User methods to decide
+    what to do:-
+      - user_exists()
+
+    All subclasses MUST define platform and distribution (which may be None).
+    """
 
     platform = 'Generic'
     distribution = None
@@ -484,6 +503,16 @@ class User(object):
 # ===========================================
 
 class FreeBSD_User(User):
+    """
+    This is a FreeBSD User manipulation class - it uses the pw command
+    to manipulate the user database, followed by the chpass command
+    to change the password.
+    
+    This overrides the following methods from the generic class:-
+      - create_user()
+      - remove_user()
+      - modify_user()
+    """
 
     platform = 'FreeBSD'
     distribution = None