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: ...@@ -128,7 +128,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -203,7 +203,7 @@ public: ...@@ -203,7 +203,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -250,7 +250,7 @@ public: ...@@ -250,7 +250,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -288,7 +288,7 @@ public: ...@@ -288,7 +288,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -401,7 +401,7 @@ public: ...@@ -401,7 +401,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -434,7 +434,7 @@ public: ...@@ -434,7 +434,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -467,7 +467,7 @@ public: ...@@ -467,7 +467,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -500,7 +500,7 @@ public: ...@@ -500,7 +500,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -533,7 +533,7 @@ public: ...@@ -533,7 +533,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -566,7 +566,7 @@ public: ...@@ -566,7 +566,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -599,7 +599,7 @@ public: ...@@ -599,7 +599,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -632,7 +632,7 @@ public: ...@@ -632,7 +632,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -665,7 +665,7 @@ public: ...@@ -665,7 +665,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -698,7 +698,7 @@ public: ...@@ -698,7 +698,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -731,7 +731,7 @@ public: ...@@ -731,7 +731,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -764,7 +764,7 @@ public: ...@@ -764,7 +764,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -954,6 +954,7 @@ public: ...@@ -954,6 +954,7 @@ public:
* @param source The core data will be recieved from * @param source The core data will be recieved from
* @param data The pointer where the recieved data will be stored * @param data The pointer where the recieved data will be stored
* @param aLength The length of the data transmitted * @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 aAddress The location where the data will be written on the data buffer
* @param comm The comunicator over which the data transfer will occur * @param comm The comunicator over which the data transfer will occur
*/ */
...@@ -989,7 +990,7 @@ public: ...@@ -989,7 +990,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1026,7 +1027,7 @@ public: ...@@ -1026,7 +1027,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1068,7 +1069,7 @@ public: ...@@ -1068,7 +1069,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1111,7 +1112,7 @@ public: ...@@ -1111,7 +1112,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1123,6 +1124,7 @@ public: ...@@ -1123,6 +1124,7 @@ public:
* @param dest The core that the data will be sent to * @param dest The core that the data will be sent to
* @param data A pointer to the location of the data being sent * @param data A pointer to the location of the data being sent
* @param aLength The length 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 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 * @param comm The communicator over which the data transfer will take place
*/ */
...@@ -1148,7 +1150,7 @@ public: ...@@ -1148,7 +1150,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline Section * @skipline Section
...@@ -1189,7 +1191,7 @@ public: ...@@ -1189,7 +1191,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1222,7 +1224,7 @@ public: ...@@ -1222,7 +1224,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1255,7 +1257,7 @@ public: ...@@ -1255,7 +1257,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1289,7 +1291,7 @@ public: ...@@ -1289,7 +1291,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1323,7 +1325,7 @@ public: ...@@ -1323,7 +1325,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -1357,7 +1359,7 @@ public: ...@@ -1357,7 +1359,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
......
...@@ -82,7 +82,7 @@ public: ...@@ -82,7 +82,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -121,7 +121,7 @@ public: ...@@ -121,7 +121,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -160,7 +160,7 @@ public: ...@@ -160,7 +160,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -202,7 +202,7 @@ public: ...@@ -202,7 +202,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -239,7 +239,7 @@ public: ...@@ -239,7 +239,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -275,7 +275,7 @@ public: ...@@ -275,7 +275,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline Section * @skipline Section
...@@ -314,7 +314,7 @@ public: ...@@ -314,7 +314,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -350,7 +350,7 @@ public: ...@@ -350,7 +350,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -385,7 +385,7 @@ public: ...@@ -385,7 +385,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline Section * @skipline Section
...@@ -419,7 +419,7 @@ public: ...@@ -419,7 +419,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -454,7 +454,7 @@ public: ...@@ -454,7 +454,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -489,7 +489,7 @@ public: ...@@ -489,7 +489,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -524,7 +524,7 @@ public: ...@@ -524,7 +524,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -559,7 +559,7 @@ public: ...@@ -559,7 +559,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -597,7 +597,7 @@ public: ...@@ -597,7 +597,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -637,7 +637,7 @@ public: ...@@ -637,7 +637,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
......
...@@ -104,7 +104,7 @@ public: ...@@ -104,7 +104,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -141,7 +141,7 @@ public: ...@@ -141,7 +141,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -174,7 +174,7 @@ public: ...@@ -174,7 +174,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -213,7 +213,7 @@ public: ...@@ -213,7 +213,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -249,7 +249,7 @@ public: ...@@ -249,7 +249,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py
* @skipline total * @skipline total
* @until exampleWriter * @until exampleWriter
* @skipline if * @skipline if
...@@ -282,7 +282,7 @@ public: ...@@ -282,7 +282,7 @@ public:
* *
* Python * Python
* *
* @dontinclude XdmfExampleDSMNoThread.cpp * @dontinclude XdmfExampleDSMNoThread.py