polishing the code headers to be the same formating across all cpp/h/…

…py files
slaclab · Jul 8, 2024 · d0cbc4b · d0cbc4b
1 parent a8322ae
commit d0cbc4b
Show file tree

Hide file tree

Showing 263 changed files with 683 additions and 982 deletions.
diff --git a/include/rogue/Directives.h b/include/rogue/Directives.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Common Directives
  * ----------------------------------------------------------------------------
- * File       : Directives.h
- * Created    : 2023-02-13
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Common Directives For Rogue

diff --git a/include/rogue/EnableSharedFromThis.h b/include/rogue/EnableSharedFromThis.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Common virtual class to enable shared_from_this() calls.
  * ----------------------------------------------------------------------------
- * File       : EnableSharedFromThis.h
- * Created    : 2019-11-15
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * This is a common parent class that must be used instead of std::enable_shared_from_this

diff --git a/include/rogue/GeneralError.h b/include/rogue/GeneralError.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : General Error
  * ----------------------------------------------------------------------------
- * File       : GeneralError.h
- * Created    : 2017-12-05
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * General exception for Rogue

diff --git a/include/rogue/GilRelease.h b/include/rogue/GilRelease.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Release GIL within scope.
  * ----------------------------------------------------------------------------
- * File       : GilRelease.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Release GIL for the scope of this class.

diff --git a/include/rogue/Helpers.h b/include/rogue/Helpers.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Helpful Functions
  * ----------------------------------------------------------------------------
- * File       : Helpers.h
- * Created    : 2018-11-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Helper functions for Rogue

diff --git a/include/rogue/Logging.h b/include/rogue/Logging.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Logging interface
  * ----------------------------------------------------------------------------
- * File       : Logging.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Logging interface for pyrogue

diff --git a/include/rogue/Queue.h b/include/rogue/Queue.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : General Queue
  * ----------------------------------------------------------------------------
- * File       : Queue.h
- * Created    : 2017-01-18
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * General queue for Rogue

diff --git a/include/rogue/ScopedGil.h b/include/rogue/ScopedGil.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Scoped GIL
  * ----------------------------------------------------------------------------
- * File       : ScopedGil.h
- * Created    : 2017-02-28
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Acquire the GIL for the scope of this class.

diff --git a/include/rogue/Version.h b/include/rogue/Version.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Rogue Version
  * ----------------------------------------------------------------------------
- * File       : Version.h
- * Created    : 2017-05-17
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Version helpers for Rogue

diff --git a/include/rogue/hardware/MemMap.h b/include/rogue/hardware/MemMap.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Raw Memory Mapped Access
  * ----------------------------------------------------------------------------
- * File       : MemMap.h
- * Created    : 2019-11-18
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      Raw Memory Mapped Access
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -13,7 +13,7 @@
  * copied, modified, propagated, or distributed except according to the terms
  * contained in the LICENSE.txt file.
  * ----------------------------------------------------------------------------
- **/
+**/
 #ifndef __ROGUE_HARDWARE_MEM_MAP_H__
 #define __ROGUE_HARDWARE_MEM_MAP_H__
 #include "rogue/Directives.h"

diff --git a/include/rogue/hardware/axi/AxiMemMap.h b/include/rogue/hardware/axi/AxiMemMap.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : AXI Memory Mapped Access
  * ----------------------------------------------------------------------------
- * File       : AxiMemMap.h
- * Created    : 2017-03-21
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      AXI Memory Mapped Access
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -13,7 +13,7 @@
  * copied, modified, propagated, or distributed except according to the terms
  * contained in the LICENSE.txt file.
  * ----------------------------------------------------------------------------
- **/
+**/
 #ifndef __ROGUE_HARDWARE_AXI_MEM_MAP_H__
 #define __ROGUE_HARDWARE_AXI_MEM_MAP_H__
 #include "rogue/Directives.h"

diff --git a/include/rogue/hardware/axi/AxiStreamDma.h b/include/rogue/hardware/axi/AxiStreamDma.h
@@ -1,6 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : AxiStreamDma Interface Class
+ * ----------------------------------------------------------------------------
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      AxiStreamDma Interface Class
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -10,7 +13,7 @@
  * copied, modified, propagated, or distributed except according to the terms
  * contained in the LICENSE.txt file.
  * ----------------------------------------------------------------------------
- **/
+**/
 #ifndef __ROGUE_HARDWARE_AXI_AXI_STREAM_DMA_H__
 #define __ROGUE_HARDWARE_AXI_AXI_STREAM_DMA_H__
 #include "rogue/Directives.h"

diff --git a/include/rogue/hardware/axi/module.h b/include/rogue/hardware/axi/module.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Python Module
  * ----------------------------------------------------------------------------
- * File       : module.h
- * Created    : 2017-03-21
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Python module setup

diff --git a/include/rogue/hardware/module.h b/include/rogue/hardware/module.h
@@ -1,6 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Python Module
+ * ----------------------------------------------------------------------------
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Python module setup

diff --git a/include/rogue/interfaces/ZmqClient.h b/include/rogue/interfaces/ZmqClient.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Rogue ZMQ Control Interface
  * ----------------------------------------------------------------------------
- * File       : ZmqClient.h
- * Created    : 2019-05-02
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      Rogue ZMQ Control Interface
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -13,7 +13,7 @@
  * copied, modified, propagated, or distributed except according to the terms
  * contained in the LICENSE.txt file.
  * ----------------------------------------------------------------------------
- **/
+**/
 #ifndef __ROGUE_ZMQ_CLIENT_H__
 #define __ROGUE_ZMQ_CLIENT_H__
 #include "rogue/Directives.h"

diff --git a/include/rogue/interfaces/ZmqServer.h b/include/rogue/interfaces/ZmqServer.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Rogue ZMQ Control Interface
  * ----------------------------------------------------------------------------
- * File       : ZmqServer.h
- * Created    : 2019-05-02
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      Rogue ZMQ Control Interface
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -13,7 +13,7 @@
  * copied, modified, propagated, or distributed except according to the terms
  * contained in the LICENSE.txt file.
  * ----------------------------------------------------------------------------
- **/
+**/
 #ifndef __ROGUE_ZMQ_SERVER_H__
 #define __ROGUE_ZMQ_SERVER_H__
 #include "rogue/Directives.h"

diff --git a/include/rogue/interfaces/api/Bsp.h b/include/rogue/interfaces/api/Bsp.h
@@ -1,9 +1,9 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : C++ API Bsp
  * ----------------------------------------------------------------------------
- * File       : Bsp.h
- * Created    : 2023-04-17
+ * Company    : SLAC National Accelerator Laboratory
+ * ----------------------------------------------------------------------------
+ * Description:
+ *      C++ API BSP (Board Support Package)
  * ----------------------------------------------------------------------------
  * This file is part of the rogue software platform. It is subject to
  * the license terms in the LICENSE.txt file found in the top-level directory
@@ -13,7 +13,7 @@
  * copied, modified, propagated, or distributed except according to the terms
  * contained in the LICENSE.txt file.
  * ----------------------------------------------------------------------------
- **/
+**/
 #ifndef __ROGUE_INTERFACE_API_BSP_H__
 #define __ROGUE_INTERFACE_API_BSP_H__
 

diff --git a/include/rogue/interfaces/memory/Block.h b/include/rogue/interfaces/memory/Block.h
@@ -1,8 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Block
  * ----------------------------------------------------------------------------
- * File       : Block.h
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Interface between RemoteVariables and lower level memory transactions.

diff --git a/include/rogue/interfaces/memory/Constants.h b/include/rogue/interfaces/memory/Constants.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Master
  * ----------------------------------------------------------------------------
- * File       : Constants.h
- * Created    : 2016-12-05
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Memory error and transaction constants.

diff --git a/include/rogue/interfaces/memory/Emulate.h b/include/rogue/interfaces/memory/Emulate.h
@@ -1,8 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory slave emulator
  * ----------------------------------------------------------------------------
- * File       : Emulator.h
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * A memory space emulator. Allows user to test a Rogue tree without real hardware.

diff --git a/include/rogue/interfaces/memory/Hub.h b/include/rogue/interfaces/memory/Hub.h
@@ -1,10 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Hub Hub
  * ----------------------------------------------------------------------------
- * File       : Hub.h
- * Author     : Ryan Herbst, [email protected]
- * Created    : 2016-09-20
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * A memory interface hub. Accepts requests from multiple masters and forwards

diff --git a/include/rogue/interfaces/memory/Master.h b/include/rogue/interfaces/memory/Master.h
@@ -1,10 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Master
  * ----------------------------------------------------------------------------
- * File       : Master.h
- * Author     : Ryan Herbst, [email protected]
- * Created    : 2016-09-20
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Memory master interface.

diff --git a/include/rogue/interfaces/memory/Slave.h b/include/rogue/interfaces/memory/Slave.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Slave
  * ----------------------------------------------------------------------------
- * File       : Slave.h
- * Created    : 2016-09-20
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Memory slave interface.

diff --git a/include/rogue/interfaces/memory/TcpClient.h b/include/rogue/interfaces/memory/TcpClient.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Client Network Bridge
  * ----------------------------------------------------------------------------
- * File       : TcpClient.h
- * Created    : 2019-01-30
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Memory Client Network Bridge

diff --git a/include/rogue/interfaces/memory/TcpServer.h b/include/rogue/interfaces/memory/TcpServer.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Server Network Bridge
  * ----------------------------------------------------------------------------
- * File       : TcpServer.h
- * Created    : 2019-01-30
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Memory Server Network Bridge

diff --git a/include/rogue/interfaces/memory/Transaction.h b/include/rogue/interfaces/memory/Transaction.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Transaction
  * ----------------------------------------------------------------------------
- * File       : Transaction.h
- * Created    : 2019-03-08
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Memory Transaction

diff --git a/include/rogue/interfaces/memory/TransactionLock.h b/include/rogue/interfaces/memory/TransactionLock.h
@@ -1,9 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Transaction Lock
  * ----------------------------------------------------------------------------
- * File       : TransactionLock.h
- * Created    : 2018-03-16
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Memory Transaction lock

diff --git a/include/rogue/interfaces/memory/Variable.h b/include/rogue/interfaces/memory/Variable.h
@@ -1,8 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Memory Variable
  * ----------------------------------------------------------------------------
- * File       : Variable.h
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Base class for RemoteVariable as well as direct C++ access

diff --git a/include/rogue/interfaces/memory/module.h b/include/rogue/interfaces/memory/module.h
@@ -1,6 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Python Module For Memory Interface
+ * ----------------------------------------------------------------------------
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Python module setup

diff --git a/include/rogue/interfaces/module.h b/include/rogue/interfaces/module.h
@@ -1,6 +1,6 @@
 /**
- *-----------------------------------------------------------------------------
- * Title      : Python Module
+ * ----------------------------------------------------------------------------
+ * Company    : SLAC National Accelerator Laboratory
  * ----------------------------------------------------------------------------
  * Description:
  * Python module setup