From 47be05b7d54dc9499382cd58e157a5a005e0722d Mon Sep 17 00:00:00 2001 From: wolf Date: Thu, 12 May 2005 17:59:37 +0000 Subject: [PATCH] Improve wording of docs. git-svn-id: https://svn.dealii.org/trunk@10671 0785d39b-7218-0410-832d-ea1e28bc413d --- deal.II/base/include/base/thread_management.h | 297 ++++++++++-------- 1 file changed, 165 insertions(+), 132 deletions(-) diff --git a/deal.II/base/include/base/thread_management.h b/deal.II/base/include/base/thread_management.h index 5a88433a4f..e4e15b10ed 100644 --- a/deal.II/base/include/base/thread_management.h +++ b/deal.II/base/include/base/thread_management.h @@ -5081,10 +5081,11 @@ namespace Threads * @internal * Overload of the non-const spawn * function for member functions - * with no arguments. This is the - * version of the spawn - * function for the case that - * threading is not enabled. + * with no arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -5097,10 +5098,11 @@ namespace Threads * @internal * Overload of the spawn function * for const member functions with - * no arguments. This is the - * version of the spawn - * function for the case that - * threading is not enabled. + * no arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -5149,10 +5151,11 @@ namespace Threads * @internal * Overload of the non-const spawn * function for member functions with - * 1 argument. This is the - * version of the spawn - * function for the case that - * threading is not enabled. + * 1 argument. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -5165,10 +5168,11 @@ namespace Threads * @internal * Overload of the spawn function for * const member functions with 1 - * argument. This is the - * version of the spawn - * function for the case that - * threading is not enabled. + * argument. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -5220,10 +5224,11 @@ namespace Threads * @internal * Overload of the non-const spawn * function for member functions - * with 2 arguments. This is the - * version of the spawn - * function for the case that - * threading is not enabled. + * with 2 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -5236,10 +5241,11 @@ namespace Threads * @internal * Overload of the spawn function * for const member functions with - * 2 arguments. This is the version - * of the spawn function for - * the case that threading is not - * enabled. + * 2 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -5291,10 +5297,11 @@ namespace Threads /** * Overload of the non-const spawn * function for member functions - * with 3 arguments. This is the - * version of the spawn - * function for the case that - * threading is not enabled. + * with 3 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template @@ -5308,10 +5315,11 @@ namespace Threads /** * Overload of the spawn function * for const member functions with - * 3 arguments. This is the version - * of the spawn function for - * the case that threading is not - * enabled. + * 3 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template @@ -5366,10 +5374,11 @@ namespace Threads /** * Overload of the non-const spawn * function for member functions - * with 4 arguments. This is the - * version of the spawn - * function for the case that - * threading is not enabled. + * with 4 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template @@ -5383,10 +5392,11 @@ namespace Threads /** * Overload of the spawn function * for const member functions with - * 4 arguments. This is the version - * of the spawn function for - * the case that threading is not - * enabled. + * 4 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template @@ -5443,10 +5453,11 @@ namespace Threads /** * Overload of the non-const spawn * function for member functions - * with 5 arguments. This is the - * version of the spawn - * function for the case that - * threading is not enabled. + * with 5 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn function for - * the case that threading is not - * enabled. + * 5 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * with 6 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn function for - * the case that threading is not - * enabled. + * 6 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * with 7 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn function for - * the case that threading is not - * enabled. + * 7 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * with 8 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn function for - * the case that threading is not - * enabled. + * 8 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * with 9 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn function for - * the case that threading is not - * enabled. + * 9 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * with 10 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * 10 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn function for - * the case that threading is not - * enabled. + * arguments. This version of the fun + * ction is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -6027,10 +6050,11 @@ namespace Threads /** * Overload of the spawn function * for non-member or static member - * functions with 1 argument. This - * is the version of the spawn - * function for the case that - * threading is not enabled. + * functions with 1 argument. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -6079,10 +6103,11 @@ namespace Threads /** * Overload of the spawn function * for non-member or static member - * functions with 2 arguments. This - * is the version of the spawn - * function for the case that - * threading is not enabled. + * functions with 2 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template inline @@ -6132,10 +6157,11 @@ namespace Threads /** * Overload of the spawn function * for non-member or static member - * functions with 3 arguments. This - * is the version of the spawn - * function for the case that - * threading is not enabled. + * functions with 3 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template @@ -6188,10 +6214,11 @@ namespace Threads /** * Overload of the spawn function * for non-member or static member - * functions with 4 arguments. This - * is the version of the spawn - * function for the case that - * threading is not enabled. + * functions with 4 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template @@ -6246,10 +6273,11 @@ namespace Threads /** * Overload of the spawn function * for non-member or static member - * functions with 5 arguments. This - * is the version of the spawn - * function for the case that - * threading is not enabled. + * functions with 5 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * functions with 6 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * functions with 7 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * functions with 8 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn - * function for the case that - * threading is not enabled. + * functions with 9 arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template spawn function for - * the case that threading is not - * enabled. + * arguments. This version of the + * function is only visible if + * multithreading is not enabled, but + * it has the exact same interface as + * if multithreading was enabled. */ template