From 9246e2b3af9130f8a9ca32aa361565ba38c1b449 Mon Sep 17 00:00:00 2001
From: heister <heister@0785d39b-7218-0410-832d-ea1e28bc413d>
Date: Thu, 27 Sep 2012 18:26:37 +0000
Subject: [PATCH] improve documentation for make_periodicity_constraints

git-svn-id: https://svn.dealii.org/trunk@26801 0785d39b-7218-0410-832d-ea1e28bc413d
---
 deal.II/include/deal.II/dofs/dof_tools.h | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/deal.II/include/deal.II/dofs/dof_tools.h b/deal.II/include/deal.II/dofs/dof_tools.h
index 2820c3a8a9..3565e81af0 100644
--- a/deal.II/include/deal.II/dofs/dof_tools.h
+++ b/deal.II/include/deal.II/dofs/dof_tools.h
@@ -1001,6 +1001,12 @@ namespace DoFTools
                                     * function will be used for which the
                                     * respective flag was set in the component
                                     * mask.
+                                    *
+                                    * @note This function will not work
+                                    * for DoFHandler objects that are
+                                    * built on a
+                                    * parallel::distributed::Triangulation
+                                    * object.
                                     */
   template<typename FaceIterator>
   void
@@ -1079,6 +1085,12 @@ namespace DoFTools
                                     * function will be used for which the
                                     * respective flag was set in the component
                                     * mask.
+                                    *
+                                    * @note This function will not work
+                                    * for DoFHandler objects that are
+                                    * built on a
+                                    * parallel::distributed::Triangulation
+                                    * object.
                                     */
   template<typename DH>
   void
@@ -1099,6 +1111,12 @@ namespace DoFTools
                                     * corresponding vertices of the 'right'
                                     * boundary. This can be used to implement
                                     * conditions such as $u(0,y)=u(1,y+1)$.
+                                    *
+                                    * @note This function will not work
+                                    * for DoFHandler objects that are
+                                    * built on a
+                                    * parallel::distributed::Triangulation
+                                    * object.
                                     */
   template<typename DH>
   void
-- 
2.39.5