changeset 180:2676200ae226

Improve documentation for pkg release.
author gedeone-octave <marcovass89@hotmail.it>
date Thu, 07 Nov 2013 23:46:38 +0000
parents 8190736845fe
children 0de6ca5e31a2
files inst/FunctionSpace.m src/Mesh.cc src/SubSpace.cc
diffstat 3 files changed, 19 insertions(+), 14 deletions(-) [+]
line wrap: on
line diff
--- a/inst/FunctionSpace.m	Thu Nov 07 23:31:05 2013 +0000
+++ b/inst/FunctionSpace.m	Thu Nov 07 23:46:38 2013 +0000
@@ -15,10 +15,13 @@
 
 
 ## -*- texinfo -*-
-## @deftypefn {Function File} {V} = FunctionSpace (name, mesh)
-## This function take as input the name of the ufl file where the FunctionSpace 
-## is defined and the mesh where you want to create it.
-## @seealso{Expression, Function} 
+## @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
 
 function V = FunctionSpace (name, mesh)
--- a/src/Mesh.cc	Thu Nov 07 23:31:05 2013 +0000
+++ b/src/Mesh.cc	Thu Nov 07 23:46:38 2013 +0000
@@ -20,17 +20,18 @@
 DEFUN_DLD (Mesh, args, ,"-*- texinfo -*-\n\
 @deftypefn {Function File} {[@var{mesh_out}]} = \
 Mesh (@var{mesh_in}) \n\
+Construct a mesh from file or from (p, e, t) format.\n\
 The @var{mesh_in} should be either\n\
 @itemize @bullet \n\
-@item a string containing the name of the file where the mesh \n\
-is stored in .xml file\
-If the file is not a .xml file you can try to use the command\n\
+@item a string containing the name of the file where the mesh \
+is stored in .xml file\n\
+If the file is not a .xml file you can try to use the command\
 dolfin-convert directly from the terminal. \n\
-@item a a PDE-tool like structure with matrix fields (p,e,t)\n\
+@item a a PDE-tool like structure with matrix fields (p,e,t)\
 @end itemize\n\
-The output @var{mesh_out} is a representation of the\n\
+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 mesh is using the msh pkg. \n\
+The easiest way for dealing with meshes is using the msh pkg. \n\
 @seealso{fem_get_mesh}\n\
 @end deftypefn")
 {
--- a/src/SubSpace.cc	Thu Nov 07 23:31:05 2013 +0000
+++ b/src/SubSpace.cc	Thu Nov 07 23:46:38 2013 +0000
@@ -19,13 +19,14 @@
 DEFUN_DLD (SubSpace, args, , "-*- texinfo -*-\n\
 @deftypefn {Function File} {[@var{V1}]} = \
 SubSpace (@var{Space V}, @var{index}(Optional)) \n\
+Extract a SubSpace from an object of type FunctionSpace. \n\
 The input arguments are\n\
 @itemize @bullet\n\
-@item @var{Space V} which is a mixed FunctionalSpace\n\
-@item @var{index} represents the subSpace which you want to extract; index\
-should be a positive integer.\n\
+@item @var{Space V} which is a FunctionalSpace\n\
+@item @var{index} is a positive integer number which represents the SubSpace \
+which has to be extracted.\n\
 @end itemize \n\
-The output @var{V0} is the SubSpace you need\n\
+The output @var{V0} is the SubSpace needed.\n\
 @seealso{FunctionSpace}\n\
 @end deftypefn")
 {