]> https://gitweb.dealii.org/ - dealii-svn.git/commitdiff
put exceptions in module and documentation on todo list
authorkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 13 Nov 2007 23:43:01 +0000 (23:43 +0000)
committerkanschat <kanschat@0785d39b-7218-0410-832d-ea1e28bc413d>
Tue, 13 Nov 2007 23:43:01 +0000 (23:43 +0000)
git-svn-id: https://svn.dealii.org/trunk@15493 0785d39b-7218-0410-832d-ea1e28bc413d

deal.II/deal.II/include/fe/fe_values.h

index 42840193c7cb4d664228504c05d18dbe26ae6155..b465618baac0986159a1b224fac4f5be8613c379 100644 (file)
@@ -1217,23 +1217,38 @@ class FEValuesBase : protected FEValuesData<dim>,
     unsigned int memory_consumption () const;
 
                                     /**
-                                     * Exception
+                                     * This exception is thrown if
+                                     * FEValuesBase is asked to
+                                     * return the value of a field
+                                     * which was not required by the
+                                     * UpdateFlags for this
+                                     * FEValuesBase.
+                                     *
+                                     * @ingroup Exceptions
                                      */
     DeclException0 (ExcAccessToUninitializedField);
                                     /**
-                                     * Exception
+                                     * @todo Document this
+                                     *
+                                     * @ingroup Exceptions
                                      */
     DeclException0 (ExcCannotInitializeField);
                                     /**
-                                     * Exception
+                                     * @todo Document this
+                                     *
+                                     * @ingroup Exceptions
                                      */
     DeclException0 (ExcInvalidUpdateFlag);
                                     /**
-                                     * Exception
+                                     * @todo Document this
+                                     *
+                                     * @ingroup Exceptions
                                      */
     DeclException0 (ExcFEDontMatch);
                                     /**
-                                     * Exception
+                                     * @todo Document this
+                                     *
+                                     * @ingroup Exceptions
                                      */
     DeclException1 (ExcShapeFunctionNotPrimitive,
                    int,
@@ -1244,7 +1259,9 @@ class FEValuesBase : protected FEValuesData<dim>,
                    << "Maybe you want to use the same function with the "
                    << "_component suffix?");
                                     /**
-                                     * Exception
+                                     * @todo Document this
+                                     *
+                                     * @ingroup Exceptions
                                      */
     DeclException0 (ExcFENotPrimitive);
     
@@ -2415,12 +2432,16 @@ class FESubfaceValues : public FEFaceValuesBase<dim>
     const FESubfaceValues<dim> & get_present_fe_values () const;
 
                                      /**
-                                     * Exception
+                                     * @todo Document this
+                                     *
+                                     * @ingroup Exceptions
                                      */
     DeclException0 (ExcReinitCalledWithBoundaryFace);
 
                                     /**
-                                     * Exception
+                                     * @todo Document this
+                                     *
+                                     * @ingroup Exceptions
                                      */
     DeclException0 (ExcFaceHasNoSubfaces);
 

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.