# HG changeset patch # User Eugenio Gianniti # Date 1408031732 -7200 # Node ID f4d6ae912a08d731774f3b3b199f88cd8f6033a2 # Parent 897e312cb44061df122d892a228c2ecac98c95d8 Correct typos in the doc-strings diff -r 897e312cb440 -r f4d6ae912a08 inst/Constant.m --- a/inst/Constant.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/Constant.m Thu Aug 14 17:55:32 2014 +0200 @@ -16,7 +16,7 @@ ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{c}]} = Constant (@var{name}, @var{value}) ## -## Creates a constatnt object over all the mesh elements with the value +## Creates a constant object over all the mesh elements with the value ## specified. ## ## This function take as input the @var{name} of the Constant that has diff -r 897e312cb440 -r f4d6ae912a08 inst/LinearForm.m --- a/inst/LinearForm.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/LinearForm.m Thu Aug 14 17:55:32 2014 +0200 @@ -13,6 +13,7 @@ ## You should have received a copy of the GNU General Public License along with ## this program; if not, see . + ## -*- texinfo -*- ## @deftypefn {Function File} {[@var{L}]} = @ ## LinearForm (@var{my_problem}, @var{U}, @var{coefficient_1}, @ diff -r 897e312cb440 -r f4d6ae912a08 inst/import_meshfunction_type.m --- a/inst/import_meshfunction_type.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/import_meshfunction_type.m Thu Aug 14 17:55:32 2014 +0200 @@ -13,9 +13,10 @@ ## You should have received a copy of the GNU General Public License along with ## this program; if not, see . + ## -*- texinfo -*- ## @deftypefn {Function File} {} import_meshfunction_type (@var{typename}) -## Add a wrapper for dolfin::MeshFunction <@var{typename}> +## Compile a wrapper for dolfin::MeshFunction <@var{typename}> ## @seealso {MeshFunction} ## @end deftypefn diff -r 897e312cb440 -r f4d6ae912a08 inst/import_ufl_BilinearForm.m --- a/inst/import_ufl_BilinearForm.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/import_ufl_BilinearForm.m Thu Aug 14 17:55:32 2014 +0200 @@ -21,7 +21,7 @@ ## @var{myproblem} is the name of the ufl file where ## the BilinearForm is defined. ## -## This function creates in the pwd a file called +## This function creates in the working directory a file called ## @var{myproblem_BilinearForm.oct}. ## ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, diff -r 897e312cb440 -r f4d6ae912a08 inst/import_ufl_FunctionSpace.m --- a/inst/import_ufl_FunctionSpace.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/import_ufl_FunctionSpace.m Thu Aug 14 17:55:32 2014 +0200 @@ -19,8 +19,8 @@ ## 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}. +## the FunctionSpace is defined. This function creates in the working directory +## a file called @var{myproblem_FunctionSpace.oct}. ## ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, ## Functional} diff -r 897e312cb440 -r f4d6ae912a08 inst/import_ufl_Functional.m --- a/inst/import_ufl_Functional.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/import_ufl_Functional.m Thu Aug 14 17:55:32 2014 +0200 @@ -19,8 +19,8 @@ ## 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}. +## the Functional is defined. This function creates in the working directory +## a file called @var{myproblem_Functional.oct}. ## ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, ## Functional} diff -r 897e312cb440 -r f4d6ae912a08 inst/import_ufl_LinearForm.m --- a/inst/import_ufl_LinearForm.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/import_ufl_LinearForm.m Thu Aug 14 17:55:32 2014 +0200 @@ -19,8 +19,8 @@ ## 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}. +## the LinearForm is defined. This function creates in the working directory +## a file called @var{myproblem_LinearForm.oct}. ## ## @seealso{import_ufl_Problem, FunctionSpace, BilinearForm, LinearForm, ## Functional} diff -r 897e312cb440 -r f4d6ae912a08 inst/linear_algebra_backend.m --- a/inst/linear_algebra_backend.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/linear_algebra_backend.m Thu Aug 14 17:55:32 2014 +0200 @@ -20,7 +20,7 @@ ## ## Query or set the internal variable that specifies the linear algebra back-end ## to use when assembling systems, matrices or vectors. It defaults to "PETSc". -## uBLAS and PETSc are currently available. +## "uBLAS" and "PETSc" are currently available. ## ## @end deftypefn @@ -41,4 +41,4 @@ endif endif -endfunction \ No newline at end of file +endfunction diff -r 897e312cb440 -r f4d6ae912a08 inst/ufl.m --- a/inst/ufl.m Thu Aug 14 17:10:29 2014 +0200 +++ b/inst/ufl.m Thu Aug 14 17:55:32 2014 +0200 @@ -20,7 +20,7 @@ ## Writes the given line to a ufl file. Optional commands are: ## @itemize @bullet ## @item start: opens an ufl file. It is possible to specify a name for it, -## otherwise 'default.ufl' will be used. +## otherwise "default.ufl" will be used. ## @item end: closes the ufl file and compiles it. It is possible to ## specify its @var{content}, otherwise a complete problem is assumed. ## Possible options are: BilinearForm, Functional, FunctionSpace, LinearForm diff -r 897e312cb440 -r f4d6ae912a08 src/Function.cc --- a/src/Function.cc Thu Aug 14 17:10:29 2014 +0200 +++ b/src/Function.cc Thu Aug 14 17:55:32 2014 +0200 @@ -41,14 +41,14 @@ @item @var{FunctionSpace} is the fem-fenics function space where \ the vector is defined\n\ @item @var{Vector} specifies the values of the coefficients\ -for each basisc function of the @var{FunctioSpace}\n\ +for each basis function of the @var{FunctioSpace}\n\ @end itemize\n\ @item To extract a scalar field from a vectorial one\n\ @itemize @bullet \n\ @item @var{name} is a string representing the name of the function\n\ @item @var{Function} is the vector valued Function\n\ @item @var{Index} contains the index of the scalar field to extract.\ -Index starts from 1. \n\ +Indices start from 1. \n\ @end itemize\n\ @end itemize \n\ The output @var{func} is an object which contains a representation of the \ diff -r 897e312cb440 -r f4d6ae912a08 src/MeshFunction.cc --- a/src/MeshFunction.cc Thu Aug 14 17:10:29 2014 +0200 +++ b/src/MeshFunction.cc Thu Aug 14 17:55:32 2014 +0200 @@ -27,16 +27,16 @@ MeshFunction (@var{type}, @var{Mesh}, @var{filename})\n\ @deftypefnx {Function File} {[@var{meshfunc}]} = \ MeshFunction (@var{type}, @var{Mesh}, @var{dim}, @var{value}) \n\ -Initialize a meshfunction with the values contained in a file.\n\ +Initialize a MeshFunction with the values contained in a file.\n\ The output @var{meshfunc} is an object which contains a representation of the \ -meshfunction in @var{filename} which can be used to mark subdomains or \ +mesh function in @var{filename} which can be used to mark subdomains or \ facets where Dirichlet boundary conditions are to be applied.\n\ Optionally, you can set a label identifying the @var{type} of markers, \ in order to use @var{meshfunc} to mark subdomains in BilinearForm or \ LinearForm. Three labels are recognized: ""dx"" for cell markers, \ ""ds"" for exterior facets and ""dS"" for interior facets.\n\ With the third invocation listed above it is possible to initialize \ -a meshfunction of topological dimension @var{dim} on @var{Mesh}, setting all \ +a mesh function of topological dimension @var{dim} on @var{Mesh}, setting all \ of its values to @var{value}, which is an integer.\n\ @seealso{DirichletBC, save, BilinearForm, LinearForm, mark}\n\ @end deftypefn") diff -r 897e312cb440 -r f4d6ae912a08 src/SubDomain.cc --- a/src/SubDomain.cc Thu Aug 14 17:10:29 2014 +0200 +++ b/src/SubDomain.cc Thu Aug 14 17:55:32 2014 +0200 @@ -22,9 +22,9 @@ "-*- texinfo -*-\n\ @deftypefn {Function File} {[@var{subdomain}]} = \ SubDomain (@var{inside}, @var{boundary})\n\ -Initialize a subdomain with a function handle, @var{inside}, and a binary \ +Initialize a SubDomain with a function handle, @var{inside}, and a binary \ flag. When the latter is true, @var{subdomain} will only contain boundary \ -entities. @var{subdomain} can be used to mark a meshfunction. \n\ +entities. @var{subdomain} can be used to mark a MeshFunction. \n\ @seealso{mark, MeshFunction}\n\ @end deftypefn") { @@ -53,4 +53,4 @@ } return retval; -} \ No newline at end of file +} diff -r 897e312cb440 -r f4d6ae912a08 src/assemble.cc --- a/src/assemble.cc Thu Aug 14 17:10:29 2014 +0200 +++ b/src/assemble.cc Thu Aug 14 17:55:32 2014 +0200 @@ -40,8 +40,8 @@ @item @var{A} is a Vector if @var{form_a} is a linear form\n\ @item @var{A} is a Double if @var{form_a} is a functional\n\ @end itemize \n\ -If boundary condition has to be applied to a vector for a nonlinear problem \ -then it should be provide as 2nd argument and it will be given back \ +If boundary conditions have to be applied to a vector for a nonlinear problem \ +then it should be provided as second argument and it will be given back \ as the second output argument. For an example of this situation, please refer \ to the HyperElasticity example. \n\ @seealso{BilinearForm, LinearForm, ResidualForm, JacobianForm, Functional}\n\ diff -r 897e312cb440 -r f4d6ae912a08 src/assemble_system.cc --- a/src/assemble_system.cc Thu Aug 14 17:10:29 2014 +0200 +++ b/src/assemble_system.cc Thu Aug 14 17:55:32 2014 +0200 @@ -35,8 +35,8 @@ The output @var{A} is a matrix representing the @var{form_a} while \ @var{b} represents @var{form_L}. \n\ If boundary conditions have to be applied to a vector for a nonlinear problem \ -then it should be provide as 3rd argument and it will be given back \ -as the 3rd output argument. For an example of this situation, please refer \ +then it should be provided as third argument and it will be given back \ +as the third output argument. For an example of this situation, please refer \ to the HyperElasticity example. \n\ @seealso{BilinearForm, LinearForm, ResidualForm, JacobianForm, Functional}\n\ @end deftypefn") diff -r 897e312cb440 -r f4d6ae912a08 src/is_master_node.cc --- a/src/is_master_node.cc Thu Aug 14 17:10:29 2014 +0200 +++ b/src/is_master_node.cc Thu Aug 14 17:55:32 2014 +0200 @@ -22,7 +22,7 @@ DEFUN_DLD (is_master_node, args, nargout, "-*- texinfo -*-\n\ @deftypefn {Function File} {} \ -is_master_process ()\n\ +is_master_node ()\n\ Return true if called on node zero.\n\ @end deftypefn") {