Skip to content

Commit

Permalink
Running spellchecker on Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
a-monsch authored Jan 15, 2025
1 parent 3cb8e7d commit a0861e6
Showing 1 changed file with 8 additions and 7 deletions.
15 changes: 8 additions & 7 deletions docs/sphinx_source/cpp_addons.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
C++ Addons
C++ Add-ons
==========

In some cases, the core codebase of CROWN (CROWNLIB) may not include all the features required for an analysis. To address this, users can add custom C++ code within their analysis configurations. These addons are automatically integrated to the C++ code during the code generation process.
In some cases, the core codebase of CROWN (CROWNLIB) may not include all the features required for an analysis. To address this, users can add custom C++ code within their analysis configurations. These add-ons are automatically integrated to the C++ code during the code generation process.

Location and directory structure
--------------------------------
Expand Down Expand Up @@ -30,9 +30,9 @@ If an analysis does not require any additional C++ code and can rely solely on C

This functionality considers files in ``analysis_configuration/<analysis>/cpp_addons/src`` and ``analysis_configuration/<analysis>/cpp_addons/include`` during compilation. The following points should be followed when adding and using custom C++ code:

* Use unique guards for each ``.cxx`` file you introduce, especially concerning CROWNLIB. For the correpsonding ``.hxx`` file(s), the same unique guard(s) should be applied.
* Use a unique function name or function signature if the custom function needs to reside in a namespace that allready exists in CROWNLIB
* Use ``../../../../include/<filename>.hxx`` if you explicetly want to import functionality from CROWNLIB. Importing CROWNLIB files using different relative paths can lead to unexpected behaviour.
* Use unique guards for each ``.cxx`` file you introduce, especially concerning CROWNLIB. For the corresponding ``.hxx`` file(s), the same unique guard(s) should be applied.
* Use a unique function name or function signature if the custom function needs to reside in a namespace that already exists in CROWNLIB
* Use ``../../../../include/<filename>.hxx`` if you explicitly want to import functionality from CROWNLIB. Importing CROWNLIB files using different relative paths can lead to unexpected behavior.

A example ``.cxx`` file could have the following structure:

Expand All @@ -42,14 +42,14 @@ A example ``.cxx`` file could have the following structure:
#ifndef UNIQUE_GUARD_NAME_H // unique w.r.t. CROWNLIB and other files in cpp_addons
#define UNIQUE_GUARD_NAME_H
// Include CROWNLIB funtionalities
// Include CROWNLIB functionalities
#include "../../../../include/utility/CorrectionManager.hxx"
#include "../../../../include/utility/Logger.hxx"
// Feature.hxx file defined in cpp_addons
#include "../Feature.hxx"
// Globally present i.e. from the ROOT framework
// Globally present, i.e. from the ROOT framework
#include "ROOT/RDataFrame.hxx"
#include "correction.h"
Expand All @@ -58,3 +58,4 @@ A example ``.cxx`` file could have the following structure:
// End of the file
#endif // UNIQUE_GUARD_NAME_H

0 comments on commit a0861e6

Please sign in to comment.