Commit 058ce901 authored by Andrew J. Burns (Cont's avatar Andrew J. Burns (Cont

made some fixes to the documentation

parent 75b28f55
......@@ -128,7 +128,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -203,7 +203,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -250,7 +250,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -288,7 +288,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -401,7 +401,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -434,7 +434,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -467,7 +467,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -500,7 +500,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -533,7 +533,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -566,7 +566,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -599,7 +599,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -632,7 +632,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -665,7 +665,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -698,7 +698,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -731,7 +731,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -764,7 +764,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -954,6 +954,7 @@ public:
* @param source The core data will be recieved from
* @param data The pointer where the recieved data will be stored
* @param aLength The length of the data transmitted
* @param tag The communication tag to be used for the transmission
* @param aAddress The location where the data will be written on the data buffer
* @param comm The comunicator over which the data transfer will occur
*/
......@@ -989,7 +990,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1026,7 +1027,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1068,7 +1069,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1111,7 +1112,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1123,6 +1124,7 @@ public:
* @param dest The core that the data will be sent to
* @param data A pointer to the location of the data being sent
* @param aLength The length of the data being sent
* @param tag The communication tag to be used for the transmission
* @param aAddress The address on the recieveing core's buffer that the data is to be placed in
* @param comm The communicator over which the data transfer will take place
*/
......@@ -1148,7 +1150,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline Section
......@@ -1189,7 +1191,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1222,7 +1224,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1255,7 +1257,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1289,7 +1291,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1323,7 +1325,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -1357,7 +1359,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......
......@@ -82,7 +82,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -121,7 +121,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -160,7 +160,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -202,7 +202,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -239,7 +239,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -275,7 +275,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline Section
......@@ -314,7 +314,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -350,7 +350,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -385,7 +385,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline Section
......@@ -419,7 +419,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -454,7 +454,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -489,7 +489,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -524,7 +524,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -559,7 +559,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -597,7 +597,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -637,7 +637,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......
......@@ -104,7 +104,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -141,7 +141,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -174,7 +174,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -213,7 +213,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -249,7 +249,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -282,7 +282,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -315,7 +315,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -347,7 +347,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -379,7 +379,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -411,7 +411,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -443,7 +443,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -475,7 +475,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -507,7 +507,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -539,7 +539,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -573,7 +573,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -608,7 +608,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -641,7 +641,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -675,7 +675,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -708,7 +708,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -743,7 +743,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -777,7 +777,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......
......@@ -201,7 +201,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -226,7 +226,7 @@ public:
const std::vector<unsigned int> & start,
const std::vector<unsigned int> & stride,
const std::vector<unsigned int> & dimensions,
const std::vector<unsigned int> & datspaceDimensions,
const std::vector<unsigned int> & dataspaceDimensions,
XdmfDSMBuffer * const dsmBuffer,
int startCoreIndex,
int endCoreIndex);
......@@ -246,7 +246,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -272,7 +272,7 @@ public:
const std::vector<unsigned int> & start,
const std::vector<unsigned int> & stride,
const std::vector<unsigned int> & dimensions,
const std::vector<unsigned int> & datspaceDimensions,
const std::vector<unsigned int> & dataspaceDimensions,
MPI_Comm comm,
unsigned int bufferSize,
int startCoreIndex,
......@@ -402,7 +402,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -436,7 +436,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -469,7 +469,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -504,7 +504,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -538,7 +538,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -612,7 +612,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -689,7 +689,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -724,7 +724,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -759,7 +759,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -792,7 +792,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -825,7 +825,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......@@ -859,7 +859,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until workerComm
* @skipline exampleController
......
......@@ -168,7 +168,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -200,7 +200,7 @@ public:
*
* Python
*
* @dontinclude ExampleXdmfDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline size
* @until MPI_Comm_size
* @skipline exampleWriter
......@@ -344,7 +344,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -374,7 +374,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -404,7 +404,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -434,7 +434,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -463,7 +463,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -532,7 +532,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -604,7 +604,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -634,7 +634,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -665,7 +665,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -695,7 +695,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total
* @until exampleWriter
* @skipline if
......@@ -724,7 +724,7 @@ public:
*
* Python
*
* @dontinclude XdmfExampleDSMNoThread.cpp
* @dontinclude XdmfExampleDSMNoThread.py
* @skipline total