diff --git a/include/ADIOS.h b/include/ADIOS.h
index fdace75ad93863396116cb726d4d4f1b9d795d7b..8129d0a1153d5ba92b48d7b026c5d5b8dd8ca7f7 100644
--- a/include/ADIOS.h
+++ b/include/ADIOS.h
@@ -42,13 +42,11 @@ class Engine;
*/
class ADIOS
{
-
-public
- : // PUBLIC Constructors and Functions define the User Interface with ADIOS
+public:
MPI_Comm m_MPIComm = MPI_COMM_SELF; ///< only used as reference to MPI
- ///communicator passed from parallel
- ///constructor, MPI_Comm is a pointer
- ///itself. Public as called from C
+ /// communicator passed from parallel
+ /// constructor, MPI_Comm is a pointer
+ /// itself. Public as called from C
int m_RankMPI = 0; ///< current MPI rank process
int m_SizeMPI = 1; ///< current MPI processes size
@@ -293,15 +291,15 @@ protected: // no const to allow default empty and copy constructors
std::map<unsigned int, VariableCompound> m_Compound;
std::string m_ConfigFile; ///< XML File to be read containing configuration
- ///information
+ /// information
bool m_DebugMode = false; ///< if true will do more checks, exceptions,
- ///warnings, expect slower code
+ /// warnings, expect slower code
// Variables
std::map<std::string, std::pair<std::string, unsigned int>>
m_Variables; ///< Makes variable name unique, key: variable name, value:
- ///pair.first = type, pair.second = index in corresponding
- ///vector of Variable
+ /// pair.first = type, pair.second = index in corresponding
+ /// vector of Variable
std::vector<std::shared_ptr<Transform>>
m_Transforms; ///< transforms associated with ADIOS run
diff --git a/include/capsule/heap/STLVector.h b/include/capsule/heap/STLVector.h
index 440e31179f5c631e620b96107645494b276bfbbb..e272ec628894306fbe01c7d4298f2d7d66acd845 100644
--- a/include/capsule/heap/STLVector.h
+++ b/include/capsule/heap/STLVector.h
@@ -27,9 +27,9 @@ class STLVector : public Capsule
public:
std::vector<char> m_Data; ///< data buffer allocated using the STL in heap
- ///memory, default size = 16 Mb
+ /// memory, default size = 16 Mb
std::vector<char> m_Metadata; ///< metadata buffer allocated using the STL in
- ///heap memory, default size = 100 Kb
+ /// heap memory, default size = 100 Kb
/**
* Unique constructor
diff --git a/include/capsule/shmem/ShmSystemV.h b/include/capsule/shmem/ShmSystemV.h
index 7766edfbe70dcbb56370a0b2e08f7deed4b8929a..33f60fe8f30e1ef9d601384ec399bd47d69e00f2 100644
--- a/include/capsule/shmem/ShmSystemV.h
+++ b/include/capsule/shmem/ShmSystemV.h
@@ -46,16 +46,16 @@ private:
int m_DataShmID; ///< data shared memory buffer id
char *m_Metadata = nullptr; ///< reference to a shared memory metadata buffer
- ///created with shmget
+ /// created with shmget
const std::size_t
m_MetadataSize; ///< size of the allocated shared memory segment
key_t m_MetadataKey; ///< key associated with the metadata buffer, created
- ///with ftok
+ /// with ftok
int m_MetadataShmID; ///< metadata shared memory buffer id
void CheckShm() const; ///< checks if all shared memory allocations are
- ///correct, throws std::bad_alloc, called from
- ///constructor if debug mode is true
+ /// correct, throws std::bad_alloc, called from
+ /// constructor if debug mode is true
};
} // end namespace
diff --git a/include/core/Capsule.h b/include/core/Capsule.h
index 004d6d9a5d5a60ac42f626da60ebddf153f522d1..5c7eedf40aa1e2f87e144212605da3bb04fe311c 100644
--- a/include/core/Capsule.h
+++ b/include/core/Capsule.h
@@ -28,7 +28,7 @@ public:
const std::string m_AccessMode; ///< 'w': write, 'r': read, 'a': append
std::size_t m_DataPosition = 0; ///< position in current data buffer (not
- ///included data flushed to transports)
+ /// included data flushed to transports)
std::size_t m_DataAbsolutePosition =
0; ///< includes the data flushed to transports
diff --git a/include/core/Engine.h b/include/core/Engine.h
index 3e3a900ef29c9d023dc7c3aaff022f5f86ba3b88..99cdde1ba719ffdf3cd27fb9b4c4e9810e397ad4 100644
--- a/include/core/Engine.h
+++ b/include/core/Engine.h
@@ -458,21 +458,21 @@ public:
protected:
ADIOS
- &m_ADIOS; ///< reference to ADIOS object that creates this Engine at Open
+ &m_ADIOS; ///< reference to ADIOS object that creates this Engine at Open
std::vector<std::shared_ptr<Transport>> m_Transports; ///< transports managed
const bool m_DebugMode =
false; ///< true: additional checks, false: by-pass checks
unsigned int m_nThreads = 0;
const std::string m_EndMessage; ///< added to exceptions to improve debugging
std::set<std::string> m_WrittenVariables; ///< contains the names of the
- ///variables that are being written
+ /// variables that are being written
virtual void
Init(); ///< Initialize m_Capsules and m_Transports, called from constructor
virtual void InitParameters(); ///< Initialize parameters from Method, called
- ///from Initi in constructor
+ /// from Initi in constructor
virtual void InitTransports(); ///< Initialize transports from Method, called
- ///from Init in constructor
+ /// from Init in constructor
/**
* Used to verify parameters in m_Method containers
@@ -488,8 +488,8 @@ protected:
const std::string parameterName, const std::string hint) const;
bool TransportNamesUniqueness() const; ///< checks if transport names are
- ///unique among the same types (file
- ///I/O)
+ /// unique among the same types (file
+ /// I/O)
/**
* Throws an exception in debug mode if transport index is out of range.
diff --git a/include/core/Method.h b/include/core/Method.h
index e90e026ded37ee2e2bab43653a834cc94f205480..71e0e783505aa2c1daaa49a4469a72a970af16d6 100644
--- a/include/core/Method.h
+++ b/include/core/Method.h
@@ -41,14 +41,14 @@ class Method
public:
const std::string m_Name; ///< Method name (as defined in XML)
const bool m_DebugMode = false; ///< true: on, throws exceptions and do
- ///additional checks, false: off, faster, but
- ///unsafe
+ /// additional checks, false: off, faster, but
+ /// unsafe
int m_nThreads;
std::string m_Type; ///< Method's engine type
std::map<std::string, std::string> m_Parameters; ///< method parameters
std::vector<std::map<std::string, std::string>>
m_TransportParameters; ///< each is a separate Transport containing their
- ///own parameters
+ /// own parameters
/**
* Constructor
diff --git a/include/core/Support.h b/include/core/Support.h
index fb7811e45a00c27e08fc4b60e7c940319980c3af..3adf2ab3e33b8e17a58ac9c6f8974130834d458a 100644
--- a/include/core/Support.h
+++ b/include/core/Support.h
@@ -30,11 +30,11 @@ struct Support
Transforms; ///< supported data transform methods
static const std::map<std::string, std::set<std::string>>
Datatypes; ///< supported data types, key: host language, value: all
- ///supported types
+ /// supported types
static const std::map<std::string, std::set<std::string>>
DatatypesAliases; ///< all supported int aliases, key: C++ type (e.g.
- ///int), value: aliases to type in key (e.g. int,
- ///integer)
+ /// int), value: aliases to type in key (e.g. int,
+ /// integer)
static const std::set<std::string> FileTransports; ///< file I/O transports
diff --git a/include/core/Transport.h b/include/core/Transport.h
index 2d5be92bd92c0dfd4360e71bc9caf4c3f50d3522..8b92971bccfe8647ea906cfeba949ecc81d25ad0 100644
--- a/include/core/Transport.h
+++ b/include/core/Transport.h
@@ -71,10 +71,10 @@ public:
virtual void Write(const char *buffer, std::size_t size) = 0;
virtual void Flush(); ///< flushes current contents to physical medium without
- ///closing the transport
+ /// closing the transport
virtual void Close(); ///< closes current transport and flushes everything,
- ///transport becomes unreachable
+ /// transport becomes unreachable
virtual void InitProfiler(const std::string accessMode,
const Support::Resolutions resolution);
diff --git a/include/core/Variable.h b/include/core/Variable.h
index 9a636909e6295c05edcd09dac94f1235bb3d3036..b9294bbfc583ef8ae00ffec6f763d5a650212c8d 100644
--- a/include/core/Variable.h
+++ b/include/core/Variable.h
@@ -38,13 +38,13 @@ template <class T> class Variable : public VariableBase
public:
const T *m_AppValues = nullptr; ///< pointer to values passed from user in
- ///ADIOS Write, it might change in ADIOS Read
+ /// ADIOS Write, it might change in ADIOS Read
std::vector<TransformData> m_Transforms; ///< associated transforms, sequence
- ///determines application order, e.g.
- ///first Transforms[0] then
- ///Transforms[1]. Pointer used as
- ///reference (no memory management).
+ /// determines application order, e.g.
+ /// first Transforms[0] then
+ /// Transforms[1]. Pointer used as
+ /// reference (no memory management).
Variable<T>(const std::string name, const Dims dimensions,
const Dims globalDimensions, const Dims globalOffsets,
diff --git a/include/engine/adios1/ADIOS1Reader.h b/include/engine/adios1/ADIOS1Reader.h
index a5e0c071dd0eb6d5bd8e67fad54d9bba0dac422c..eade47f8fca46ce656e4e9d681362a44eb59838a 100644
--- a/include/engine/adios1/ADIOS1Reader.h
+++ b/include/engine/adios1/ADIOS1Reader.h
@@ -95,7 +95,7 @@ private:
// BP functionality to be applied on m_Buffer and m_Transports
void Init(); ///< calls InitCapsules and InitTransports based on Method,
- ///called from constructor
+ /// called from constructor
void InitCapsules();
void InitTransports(); ///< from Transports
diff --git a/include/engine/adios1/ADIOS1Writer.h b/include/engine/adios1/ADIOS1Writer.h
index 990d7fbd6012e724e190849b74d420e0ddf74af5..c581db8edb26893c0c4f7545b17487a575cfd36d 100644
--- a/include/engine/adios1/ADIOS1Writer.h
+++ b/include/engine/adios1/ADIOS1Writer.h
@@ -96,11 +96,11 @@ public:
private:
const char *m_groupname; ///< ADIOS1 group name created from the method's
- ///name. Must be a unique group name.
+ /// name. Must be a unique group name.
const char *m_filename; ///< Save file name from constructor for Advance()
- ///when we re-open in ADIOS1
+ /// when we re-open in ADIOS1
MPI_Comm m_comm; ///< Save MPI communicator from constructor for Advance()
- ///when we re-open in ADIOS1
+ /// when we re-open in ADIOS1
bool m_initialized = false; ///< set to true after calling adios_init()
int64_t m_adios_file = 0; ///< ADIOS1 file handler returned by adios_open()
diff --git a/include/engine/bp/BPFileReader.h b/include/engine/bp/BPFileReader.h
index 3cfdc39dc86b85ec3250c53a2fee6800819fb076..2b2e5c1e0ed82929b3179a885a24fb6ba4aa4d76 100644
--- a/include/engine/bp/BPFileReader.h
+++ b/include/engine/bp/BPFileReader.h
@@ -93,7 +93,7 @@ private:
// BP functionality to be applied on m_Buffer and m_Transports
void Init(); ///< calls InitCapsules and InitTransports based on Method,
- ///called from constructor
+ /// called from constructor
void InitCapsules();
void InitTransports(); ///< from Transports
diff --git a/include/engine/bp/BPFileWriter.h b/include/engine/bp/BPFileWriter.h
index ac9f5d008ee977bb23f5ea3047cd6113b3befc7d..dabd62cd06b5a2c22272cd1b48e11faf7dfd3ede 100644
--- a/include/engine/bp/BPFileWriter.h
+++ b/include/engine/bp/BPFileWriter.h
@@ -96,25 +96,25 @@ public:
private:
capsule::STLVector m_Buffer; ///< heap capsule using STL std::vector<char>
format::BP1Writer m_BP1Writer; ///< format object will provide the required BP
- ///functionality to be applied on m_Buffer and
- ///m_Transports
+ /// functionality to be applied on m_Buffer and
+ /// m_Transports
format::BP1MetadataSet m_MetadataSet; ///< metadata set accompanying the heap
- ///buffer data in bp format. Needed by
- ///m_BP1Writer
+ /// buffer data in bp format. Needed by
+ /// m_BP1Writer
format::BP1Aggregator m_BP1Aggregator;
- bool m_IsFirstClose = true; ///< set to false after first Close is reached so
- ///metadata doesn't have to be accommodated for a
- ///subsequent Close
+ bool m_IsFirstClose = true; ///< set to false after first Close is reached so
+ /// metadata doesn't have to be accommodated for a
+ /// subsequent Close
std::size_t m_MaxBufferSize; ///< maximum allowed memory to be allocated
float m_GrowthFactor = 1.5; ///< capsule memory growth factor, new_memory =
- ///m_GrowthFactor * current_memory
+ /// m_GrowthFactor * current_memory
bool m_TransportFlush =
false; ///< true: transport flush happened, buffer must be reset
bool m_CloseProcessGroup = false; ///< set to true if advance is called, this
- ///prevents flattening the data and metadata
- ///in Close
+ /// prevents flattening the data and metadata
+ /// in Close
void Init();
void InitParameters();
diff --git a/include/engine/dataman/DataManReader.h b/include/engine/dataman/DataManReader.h
index 0f8d66a5502190ace000d40783cce853d6a73cee..455d9e06fc76365f7360ef3182edf21ed4d82b1a 100644
--- a/include/engine/dataman/DataManReader.h
+++ b/include/engine/dataman/DataManReader.h
@@ -102,8 +102,8 @@ private:
capsule::STLVector
m_Buffer; ///< heap capsule, contains data and metadata buffers
format::BP1Writer m_BP1Writer; ///< format object will provide the required BP
- ///functionality to be applied on m_Buffer and
- ///m_Transports
+ /// functionality to be applied on m_Buffer and
+ /// m_Transports
bool m_DoRealTime = false;
DataManager m_Man;
@@ -111,7 +111,7 @@ private:
m_CallBack; ///< call back function
void Init(); ///< calls InitCapsules and InitTransports based on Method,
- ///called from constructor
+ /// called from constructor
void InitCapsules();
void InitTransports(); ///< from Transports
diff --git a/include/engine/dataman/DataManWriter.h b/include/engine/dataman/DataManWriter.h
index ea5b8f6dc73c2b740d192151d7a3e417e7e4fc44..f13419db9f8ca948071526750d0560b1525ba3fa 100644
--- a/include/engine/dataman/DataManWriter.h
+++ b/include/engine/dataman/DataManWriter.h
@@ -96,8 +96,8 @@ private:
capsule::STLVector
m_Buffer; ///< heap capsule, contains data and metadata buffers
format::BP1Writer m_BP1Writer; ///< format object will provide the required BP
- ///functionality to be applied on m_Buffer and
- ///m_Transports
+ /// functionality to be applied on m_Buffer and
+ /// m_Transports
bool m_DoRealTime = false;
bool m_DoMonitor = false;
@@ -106,7 +106,7 @@ private:
m_CallBack; ///< call back function
void Init(); ///< calls InitCapsules and InitTransports based on Method,
- ///called from constructor
+ /// called from constructor
void InitCapsules();
void InitTransports(); ///< from Transports
diff --git a/include/format/BP1.h b/include/format/BP1.h
index 3ff8f18b30d961d8a7169a83478da85de9bb1333..2668b52bd269f0d113c95322285c48b26976b171 100644
--- a/include/format/BP1.h
+++ b/include/format/BP1.h
@@ -53,8 +53,8 @@ struct BP1Index
struct BP1MetadataSet
{
std::uint32_t TimeStep; ///< current time step, updated with advance step, if
- ///append it will be updated to last, starts with one
- ///in ADIOS1
+ /// append it will be updated to last, starts with one
+ /// in ADIOS1
BP1Index PGIndex = BP1Index(0); ///< single buffer for PGIndex
@@ -62,23 +62,23 @@ struct BP1MetadataSet
std::unordered_map<std::string, BP1Index>
VarsIndices; ///< key: variable name, value: bp metadata variable index
std::unordered_map<std::string, BP1Index> AttributesIndices; ///< key:
- ///attribute
- ///name, value:
- ///bp metadata
- ///attribute
- ///index
+ /// attribute
+ /// name, value:
+ /// bp metadata
+ /// attribute
+ /// index
const unsigned int MiniFooterSize = 28; ///< from bpls reader
// PG (relative) positions in Data buffer to be updated
std::uint64_t DataPGCount = 0;
std::size_t DataPGLengthPosition = 0; ///< current PG initial ( relative )
- ///position, needs to be updated in
- ///every advance step or init
- std::uint32_t DataPGVarsCount = 0; ///< variables in current PG
+ /// position, needs to be updated in
+ /// every advance step or init
+ std::uint32_t DataPGVarsCount = 0; ///< variables in current PG
std::size_t DataPGVarsCountPosition =
0; ///< current PG variable count ( relative ) position, needs to be
- ///updated in every advance step or init
+ /// updated in every advance step or init
bool DataPGIsOpen = false;
Profiler Log; ///< object that takes buffering profiling info
diff --git a/include/format/BP1Writer.h b/include/format/BP1Writer.h
index 6b2ff4a13296a087e071e96e8bedf6db8e76d0d6..298bc0c21df6529de98bd930ec73707f894c6689 100644
--- a/include/format/BP1Writer.h
+++ b/include/format/BP1Writer.h
@@ -511,7 +511,7 @@ private:
void FlattenMetadata(BP1MetadataSet &metadataSet,
capsule::STLVector &buffer) const
noexcept; ///< sets the metadata buffer in capsule with indices and
- ///minifooter
+ /// minifooter
};
} // end namespace format