From 93f64d63dd67cc32443db7d9dc5a4ea652282464 Mon Sep 17 00:00:00 2001
From: Nicolas Marsic <nicolas.marsic@gmail.com>
Date: Mon, 26 Nov 2012 17:25:02 +0000
Subject: [PATCH] Doc...

---
 FunctionSpace/BasisGenerator.h       |  4 +--
 FunctionSpace/EvaluatedBasis.h       | 10 ++++++
 FunctionSpace/EvaluatedBasisScalar.h |  7 +++++
 FunctionSpace/EvaluatedBasisVector.h |  7 +++++
 FunctionSpace/FunctionSpaceScalar.h  | 46 ++++++++++++++++++++++++++++
 5 files changed, 72 insertions(+), 2 deletions(-)

diff --git a/FunctionSpace/BasisGenerator.h b/FunctionSpace/BasisGenerator.h
index 6d3351c319..3858bf284f 100644
--- a/FunctionSpace/BasisGenerator.h
+++ b/FunctionSpace/BasisGenerator.h
@@ -60,7 +60,7 @@ class BasisGenerator{
    Deletes this BasisGenerator
    **
 
-   @fn BasisGenerator::generate
+   @fn BasisGenerator::generate(int, int, int, std::string)
    @param elementType The type of the element,
    on which the requested Basis will be created
    @param basisType The Basis type
@@ -93,7 +93,7 @@ class BasisGenerator{
    @li @c lagrange for Lagrange's Basis Functions   
    **
 
-   @fn BasisGenerator::generate
+   @fn BasisGenerator::generate(int, int, int)
    @param elementType The type of the element,
    on which the requested Basis will be created
    @param basisType The Basis type
diff --git a/FunctionSpace/EvaluatedBasis.h b/FunctionSpace/EvaluatedBasis.h
index 0ef0950410..6967d21065 100644
--- a/FunctionSpace/EvaluatedBasis.h
+++ b/FunctionSpace/EvaluatedBasis.h
@@ -1,6 +1,16 @@
 #ifndef _EVALUATEDBASIS_H_
 #define _EVALUATEDBASIS_H_
 
+/**
+   @interface EvaluatedBasis
+   @brief Common Interface for Evaluated Basis
+
+   This class is the @em common @em interface for all EvaluatedBasis.@n
+
+   An EvaluatedBasis is a @em Basis that has been @em Evaluated at
+   some points.@n
+ */
+
 class EvaluatedBasis{
  protected:
   bool scalar;
diff --git a/FunctionSpace/EvaluatedBasisScalar.h b/FunctionSpace/EvaluatedBasisScalar.h
index 4ecdeb0f4f..c3a5aff88a 100644
--- a/FunctionSpace/EvaluatedBasisScalar.h
+++ b/FunctionSpace/EvaluatedBasisScalar.h
@@ -6,6 +6,13 @@
 #include "BasisScalar.h"
 #include "EvaluatedBasis.h"
 
+/**
+   @class EvaluatedBasisScalar
+   @brief A @em Scalar EvaluatedBasis 
+
+   This class is a @em Scalar EvaluatedBasis.@n
+*/
+
 class EvaluatedBasisScalar: public EvaluatedBasis{
  protected:
   std::vector            <std::vector<double>*>*   node;
diff --git a/FunctionSpace/EvaluatedBasisVector.h b/FunctionSpace/EvaluatedBasisVector.h
index b9b686df74..c5e8c0afaa 100644
--- a/FunctionSpace/EvaluatedBasisVector.h
+++ b/FunctionSpace/EvaluatedBasisVector.h
@@ -6,6 +6,13 @@
 #include "BasisVector.h"
 #include "EvaluatedBasis.h"
 
+/**
+   @class EvaluatedBasisVector
+   @brief A @em Vectorial EvaluatedBasis 
+
+   This class is a @em Vectorial EvaluatedBasis.@n
+*/
+
 class EvaluatedBasisVector: public EvaluatedBasis{
  protected:
   std::vector            <std::vector<fullVector<double> >*>*   node;
diff --git a/FunctionSpace/FunctionSpaceScalar.h b/FunctionSpace/FunctionSpaceScalar.h
index de7c3ababf..f20368aa46 100644
--- a/FunctionSpace/FunctionSpaceScalar.h
+++ b/FunctionSpace/FunctionSpaceScalar.h
@@ -126,6 +126,52 @@ class FunctionSpaceScalar : public FunctionSpace{
    @return Returns the @em gradient 
    of the basis functions associated
    to the given element (with correct @em closure)
+   **
+
+   @fn FunctionSpaceScalar::preEvaluateLocalFunctions
+   @param points A set of @c 3D Points
+
+   Precomputes the Local Functions of this FunctionSpace
+   at the given Points.
+
+   @note Each row of @c point is a new Point,
+   and each column is a coordinate (for a total of
+   3 columns)
+   **
+
+   @fn FunctionSpaceScalar::preEvaluateGradLocalFunctions
+   @param points A set of @c 3D Points
+
+   Precomputes the @em Gradient of the Local Functions 
+   of this FunctionSpace at the given Points.
+
+   @note Each row of @c point is a new Point,
+   and each column is a coordinate (for a total of
+   3 columns)
+   **
+
+   @fn FunctionSpaceScalar::getEvaluatedLocalFunctions
+   @param element A MElement
+   @return Returns the @em values of the @em precomputed 
+   Basis Functions associated
+   to the given element (with correct @em closure)
+   
+   @note
+   The returned values must be computed by
+   FunctionSpaceScalar::preEvaluateLocalFunctions(), 
+   if not an Exception will be thrown
+   **
+
+   @fn FunctionSpaceScalar::getEvaluatedGradLocalFunctions
+   @param element A MElement
+   @return Returns the @em values of the @em precomputed 
+   @em Gradients of the Basis Functions associated
+   to the given element (with correct @em closure)
+   
+   @note
+   The returned values must be computed by
+   FunctionSpaceScalar::preEvaluateGradLocalFunctions(), 
+   if not an Exception will be thrown
  */
 
 //////////////////////
-- 
GitLab