]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Add/copy comments so that the documentation doesn't look all that empty.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 12 May 2005 18:13:29 +0000 (18:13 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Thu, 12 May 2005 18:13:29 +0000 (18:13 +0000)
git-svn-id: https://svn.dealii.org/trunk@10675 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/base/include/base/thread_management.h

index 674fd225cacaf5cb0774204ae8543a3781206181..0b03caa979ea164fe9a6f224b1123a049bc77792 100644 (file)
@@ -517,7 +517,21 @@ namespace Threads
                                     * the library.
                                     */
   typedef PosixThreadMutex     ThreadMutex;
+
+                                   /**
+                                    * If using POSIX functions, then
+                                    * alias the POSIX wrapper classes
+                                    * to the names we use throughout
+                                    * the library.
+                                    */
   typedef PosixThreadCondition ThreadCondition;  
+
+                                   /**
+                                    * If using POSIX functions, then
+                                    * alias the POSIX wrapper classes
+                                    * to the names we use throughout
+                                    * the library.
+                                    */
   typedef PosixThreadBarrier   Barrier;
 
 #  else
@@ -534,7 +548,27 @@ namespace Threads
                                    * barrier class.
                                    */
   typedef DummyThreadMutex     ThreadMutex;
+
+                                  /**
+                                   * In non-multithread mode, the
+                                   * mutex and thread management
+                                   * classes are aliased to dummy
+                                   * classes that actually do
+                                   * nothing, in particular not lock
+                                   * objects. Likewise for the
+                                   * barrier class.
+                                   */
   typedef DummyThreadCondition ThreadCondition;  
+
+                                  /**
+                                   * In non-multithread mode, the
+                                   * mutex and thread management
+                                   * classes are aliased to dummy
+                                   * classes that actually do
+                                   * nothing, in particular not lock
+                                   * objects. Likewise for the
+                                   * barrier class.
+                                   */
   typedef DummyBarrier         Barrier;
 #endif
   

In the beginning the Universe was created. This has made a lot of people very angry and has been widely regarded as a bad move.

Douglas Adams


Typeset in Trocchi and Trocchi Bold Sans Serif.