improve documentation

git-svn-id: https://svn.dealii.org/trunk@32601 0785d39b-7218-0410-832d-ea1e28bc413d

diff --git a/deal.II/include/deal.II/base/mpi.h b/deal.II/include/deal.II/base/mpi.h
index cb88fcc2ec199fa6530d1d9acca28f33f373dcfb..4aa290c0b2c4b2a2e355a1e2fc1d6e2356d39a27 100644 (file)
--- a/deal.II/include/deal.II/base/mpi.h
+++ b/deal.II/include/deal.II/base/mpi.h
@@ -350,6 +350,10 @@ namespace Utilities
        * parameter. If set to numbers::invalid_unsigned_int, the number
        * of threads is determined by TBB. When in doubt, set this value
        * to 1.
+       *
+       * This will call MultithreadInfo::set_thread_limit() with @p
+       * max_num_threads, so the environment variable DEAL_II_NUM_THREADS will
+       * be respected.
        */
       MPI_InitFinalize (int    &argc,
                         char ** &argv,