changeset 181:0de6ca5e31a2

Fix error in the previously modified documentation.
author gedeone-octave <marcovass89@hotmail.it>
date Fri, 08 Nov 2013 00:05:33 +0000
parents 2676200ae226
children b40f22aad4af
files DESCRIPTION INDEX inst/BilinearForm.m inst/FunctionSpace.m inst/import_ufl_BilinearForm.m inst/import_ufl_FunctionSpace.m inst/import_ufl_Functional.m inst/import_ufl_LinearForm.m inst/import_ufl_Problem.m src/Mesh.cc src/SubSpace.cc
diffstat 11 files changed, 30 insertions(+), 13 deletions(-) [+]
line wrap: on
line diff
--- a/DESCRIPTION	Thu Nov 07 23:46:38 2013 +0000
+++ b/DESCRIPTION	Fri Nov 08 00:05:33 2013 +0000
@@ -1,11 +1,11 @@
 Name: fem-fenics
 Version: 0.0.0
-Date: 2013-11-03
+Date: 2013-11-09
 Author: Marco Vassalo <gedeone-octave@users.sourceforge.net>
 Maintainer: Marco Vassallo <gedeone-octave@users.sourceforge.net>
 Title: fem-fenics
 Description: pkg for the resolution of partial differential equation based on fenics
-Depends: octave (>= 3.6.0)
+Depends: octave (>= 3.7.5)
 SystemRequirements: dolfin (>=1.2.0), ffc (>=1.2.0)
 BuildRequirements: dolfin (>=1.2.0), ffc (>=1.2.0)
 Autoload: no
--- a/INDEX	Thu Nov 07 23:46:38 2013 +0000
+++ b/INDEX	Fri Nov 08 00:05:33 2013 +0000
@@ -3,6 +3,7 @@
   import_ufl_BilinearForm
   import_ufl_LinearForm
   import_ufl_Functional
+  import_ufl_FunctioSpace
   import_ufl_Problem
 Problem geometry and FE space
   Mesh
--- a/inst/BilinearForm.m	Thu Nov 07 23:46:38 2013 +0000
+++ b/inst/BilinearForm.m	Fri Nov 08 00:05:33 2013 +0000
@@ -14,7 +14,7 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {a} = BilinearForm (name, U, V, [coefficients])
+## @deftypefn {Function File} {[@var{a}]} = BilinearForm (name, U, V, [coefficients])
 ## This function takes as input the name of the problem that you want to solve 
 ## and the FunctionSpace where it is defined and return a Form defined with
 ## the coefficients passed as optional argument.
--- a/inst/FunctionSpace.m	Thu Nov 07 23:46:38 2013 +0000
+++ b/inst/FunctionSpace.m	Fri Nov 08 00:05:33 2013 +0000
@@ -15,12 +15,16 @@
 
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {@var{V}} = FunctionSpace (@var{myproblem}, 
+## @deftypefn {Function File} {@var{V}} = @
+## FunctionSpace (@var{myproblem}, 
 ## @var{mesh})
+##
 ## Generate a FunctionSpace on a specific mesh.
+##
 ## This function takes as input the name @var{myproblem}of the ufl file where 
 ## the FunctionSpace is defined and the mesh @var{mesh} where it has to be 
 ## created.
+##
 ## @seealso{FunctionSpace, SubSpace, import_ufl_FunctionSpace} 
 ## @end deftypefn
 
--- a/inst/import_ufl_BilinearForm.m	Thu Nov 07 23:46:38 2013 +0000
+++ b/inst/import_ufl_BilinearForm.m	Fri Nov 08 00:05:33 2013 +0000
@@ -14,11 +14,15 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {[]} = import_ufl_BilinearForm (@var{myproblem})
+## @deftypefn {Function File} {} = import_ufl_BilinearForm (@var{myproblem})
 ## Import a BilinearForm from a ufl file.
+##
 ## @var{myproblem} is the name of the ufl file where 
-## the BilinearForm is defined. This function creates in the pwd a file
-## called @var{myproblem_BilinearForm.oct}.
+## the BilinearForm is defined. 
+##
+## This function creates in the pwd a file called 
+## @var{myproblem_BilinearForm.oct}.
+##
 ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm,
 ## Functional} 
 ## @end deftypefn
--- a/inst/import_ufl_FunctionSpace.m	Thu Nov 07 23:46:38 2013 +0000
+++ b/inst/import_ufl_FunctionSpace.m	Fri Nov 08 00:05:33 2013 +0000
@@ -14,11 +14,13 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {[]} = import_ufl_FunctionSpace (@var{myproblem})
+## @deftypefn {Function File} {} = import_ufl_FunctionSpace (@var{myproblem})
 ## Import a FunctionSpace from a ufl file.
+##
 ## @var{myproblem} is the name of the ufl file where 
 ## the FunctionSpace is defined. This function creates in the pwd a file
 ## called @var{myproblem_FunctionSpace.oct}.
+##
 ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, 
 ## Functional} 
 ## @end deftypefn
--- a/inst/import_ufl_Functional.m	Thu Nov 07 23:46:38 2013 +0000
+++ b/inst/import_ufl_Functional.m	Fri Nov 08 00:05:33 2013 +0000
@@ -14,11 +14,13 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {[]} = import_ufl_Functional (@var{myproblem})
+## @deftypefn {Function File} {} = import_ufl_Functional (@var{myproblem})
 ## Import a Functional from a ufl file.
+##
 ## @var{myproblem} is the name of the ufl file where 
 ## the Functional is defined. This function creates in the pwd a file
 ## called @var{myproblem_Functional.oct}.
+##
 ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm,
 ## Functional} 
 ## @end deftypefn
--- a/inst/import_ufl_LinearForm.m	Thu Nov 07 23:46:38 2013 +0000
+++ b/inst/import_ufl_LinearForm.m	Fri Nov 08 00:05:33 2013 +0000
@@ -14,11 +14,13 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {[]} = import_ufl_LinearForm (@var{myproblem})
+## @deftypefn {Function File} {} = import_ufl_LinearForm (@var{myproblem})
 ## Import a LinearForm from a ufl file.
+##
 ## @var{myproblem} is the name of the ufl file where 
 ## the LinearForm is defined. This function creates in the pwd a file
 ## called @var{myproblem_LinearForm.oct}.
+##
 ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, 
 ## Functional} 
 ## @end deftypefn
--- a/inst/import_ufl_Problem.m	Thu Nov 07 23:46:38 2013 +0000
+++ b/inst/import_ufl_Problem.m	Fri Nov 08 00:05:33 2013 +0000
@@ -14,10 +14,12 @@
 ## this program; if not, see <http://www.gnu.org/licenses/>.
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {[]} = import_ufl_Problem (@var{myproblem})
+## @deftypefn {Function File} {} = import_ufl_Problem (@var{myproblem})
 ## Import a Variational Problem from a ufl file.
+##
 ## @var{myproblem} is the name of the ufl file where 
 ## the BilinearForm, the LinearForm and the FunctionSpace are defined.
+##
 ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, 
 ## Functional} 
 ## @end deftypefn
--- a/src/Mesh.cc	Thu Nov 07 23:46:38 2013 +0000
+++ b/src/Mesh.cc	Fri Nov 08 00:05:33 2013 +0000
@@ -32,7 +32,7 @@
 The output @var{mesh_out} is a representation of the\
 @var{mesh_in} which is compatible with fem-fenics.\n\
 The easiest way for dealing with meshes is using the msh pkg. \n\
-@seealso{fem_get_mesh}\n\
+@seealso{FunctionSpace}\n\
 @end deftypefn")
 {
   int nargin = args.length ();
--- a/src/SubSpace.cc	Thu Nov 07 23:46:38 2013 +0000
+++ b/src/SubSpace.cc	Fri Nov 08 00:05:33 2013 +0000
@@ -18,7 +18,7 @@
 
 DEFUN_DLD (SubSpace, args, , "-*- texinfo -*-\n\
 @deftypefn {Function File} {[@var{V1}]} = \
-SubSpace (@var{Space V}, @var{index}(Optional)) \n\
+SubSpace (@var{Space V}, @var{index}) \n\
 Extract a SubSpace from an object of type FunctionSpace. \n\
 The input arguments are\n\
 @itemize @bullet\n\