]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
Add some docs.
authorwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 14 Aug 2001 09:47:52 +0000 (09:47 +0000)
committerwolf <wolf@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 14 Aug 2001 09:47:52 +0000 (09:47 +0000)
git-svn-id: https://svn.dealii.org/trunk@4881 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/fe_update_flags.h

index 5cbf01d3a0b1dc19044dd621928e5bfcf88086f9..5be06a2f9337312ec267a4460fb8f3abe8bd447f 100644 (file)
@@ -206,33 +206,62 @@ enum UpdateFlags
 };
 
 
+
+/**
+ * Global operator which sets the bits from the second argument also
+ * in the first one.
+ */
 inline
 UpdateFlags &
-operator |= (UpdateFlags& f1, const UpdateFlags& f2)
+operator |= (UpdateFlags &f1, const UpdateFlags &f2)
 {
   f1 = static_cast<UpdateFlags> (f1 | f2);
   return f1;
 }
 
 
+
+/**
+ * Global operator which returns an object in which all bits are set
+ * which are either set in the first or the second argument. This
+ * operator exists since if it did not then the result of the bit-or
+ * @p{operator |} would be an integer which would in turn trigger a
+ * compiler warning when we tried to assign it to an object of type
+ * @ref{UpdateFlags}.
+ */
 inline
 UpdateFlags
-operator | (const UpdateFlags& f1, const UpdateFlags& f2)
+operator | (const UpdateFlags &f1, const UpdateFlags &f2)
 {
   UpdateFlags result = f1;
   result |= f2;
   return result;
 }
 
+
+
+/**
+ * Global operator which clears all the bits in the first argument if
+ * they are not also set in the second argument.
+ */
 inline
 UpdateFlags &
-operator &= (UpdateFlags& f1, const UpdateFlags& f2)
+operator &= (UpdateFlags &f1, const UpdateFlags &f2)
 {
   f1 = static_cast<UpdateFlags> (f1 & f2);
   return f1;
 }
 
 
+
+/**
+ * Global operator which returns an object in which all bits are set
+ * which are set in the first as well as the second argument. This
+ * operator exists since if it did not then the result of the bit-and
+ * @p{operator &} would be an integer which would in turn trigger a
+ * compiler warning when we tried to assign it to an object of type
+ * @ref{UpdateFlags}.
+ */
 inline
 UpdateFlags
 operator & (const UpdateFlags& f1, const UpdateFlags& f2)

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.