Commit e513babc authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Add some remarks on the origin of parts of the code

parent 59e385b3
Pipeline #1061918 passed with stages
in 16 minutes and 57 seconds
......@@ -70,4 +70,6 @@ This software is distributed under the terms of the MIT license. A copy of this
The documentation is distributed under the terms of the CC-BY-4.0 license. This license can be found in [doc/COPYING.md](doc/COPYING.md).
This project strongly profits from the developments done for the [Allpix Squared project](https://cern.ch/allpix-squared) which is released under the MIT license. Especially the configuration class, the module instantiation logic and the file reader and writer modules have profited heavily by their corresponding framework components in Allpix Squared.
The LaTeX and Pandoc CMake modules used by Corryvreckan are licensed under the BSD 3-Clause License.
/**
* @file
* @brief Collection of simple file system utilities
* @copyright Copyright (c) 2017-2018 CERN and the Allpix Squared authors.
* @copyright Copyright (c) 2017 CERN and the Corryvreckan authors.
* This software is distributed under the terms of the MIT License, copied verbatim in the file "LICENSE.md".
* In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an
......
......@@ -5,6 +5,7 @@
* This software is distributed under the terms of the MIT License, copied verbatim in the file "LICENSE.md".
* In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an
* Intergovernmental Organization or submit itself to any jurisdiction.
* @remarks The implementation of this module is based on the ROOTObjectReader module of the Allpix Squared project
*/
#include "FileReader.h"
......
......@@ -20,6 +20,7 @@ namespace corryvreckan {
/**
* @ingroup Modules
* @brief Module to read data stored in ROOT file back to the Corryvreckan clipboard
* @remarks The implementation of this module is based on the ROOTObjectReader module of the Allpix Squared project
*
* Reads the tree of objects in the data format of the \ref FileWriter module. Copies all stored objects that are
* supported back to the clipboard.
......
......@@ -5,6 +5,7 @@
* This software is distributed under the terms of the MIT License, copied verbatim in the file "LICENSE.md".
* In applying this license, CERN does not waive the privileges and immunities granted to it by virtue of its status as an
* Intergovernmental Organization or submit itself to any jurisdiction.
* @remarks The implementation of this module is based on the ROOTObjectWriter module of the Allpix Squared project
*/
#include "FileWriter.h"
......
......@@ -19,6 +19,7 @@ namespace corryvreckan {
/**
* @ingroup Modules
* @brief Module to write object data to ROOT trees in file for persistent storage
* @remarks The implementation of this module is based on the ROOTObjectWriter module of the Allpix Squared project
*
* Reads the whole clipboard. Creates a tree as soon as a new type of object is encountered and
* saves the data in those objects to tree for every event. The tree name is the class name of the object. A separate
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment