Diff: headers/StatusReg.h

Revision:

6:424e225d2a91

Parent:

0:c5607b31fb07

--- a/headers/StatusReg.h	Thu Oct 06 07:58:31 2016 +0000
+++ b/headers/StatusReg.h	Thu Oct 06 08:04:34 2016 +0000
@@ -1,11 +1,34 @@
-// ******************
-// * iQ_StatusReg.h *
-// ******************
-//
-// Created: 2016/03/24
-// By: Damien Frost
-//
-// Status register class
+/**
+* @author Damien Frost
+*
+* @section LICENSE
+*
+*   Copyright (c) 2016 Damien Frost
+*
+*   Permission is hereby granted, free of charge, to any person obtaining a copy
+*   of this software and associated documentation files (the "Software"), to deal
+*   in the Software without restriction, including without limitation the rights
+*   to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+*   copies of the Software, and to permit persons to whom the Software is
+*   furnished to do so, subject to the following conditions:
+*
+*   The above copyright notice and this permission notice shall be included in
+*   all copies or substantial portions of the Software.
+*
+*   THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+*   IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+*   FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+*   AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+*   LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+*   OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+*   THE SOFTWARE.
+*
+* @file "StatusRep.h"
+*
+* @section DESCRIPTION
+*   StatusReg implementation. A register to hold bit-wise status flags.
+*
+*/
  
 #ifndef STATUSREG_H_
 #define STATUSREG_H_