diff src/DirichletBC.cc @ 182:b40f22aad4af

Improve the documentation for the pkg release.
author gedeone-octave <marcovass89@hotmail.it>
date Fri, 08 Nov 2013 00:29:56 +0000
parents 9e944b0d0fc8
children 536ee96a8cd0
line wrap: on
line diff
--- a/src/DirichletBC.cc	Fri Nov 08 00:05:33 2013 +0000
+++ b/src/DirichletBC.cc	Fri Nov 08 00:29:56 2013 +0000
@@ -22,18 +22,19 @@
 DEFUN_DLD (DirichletBC, args, ,
 "-*- texinfo -*-\n\
 @deftypefn {Function File} {[@var{bc}]} = \
-DirichletBC (@var{Functional Space}, @var{Boundary Label},\
-             @var{Function handle}) \n\
+DirichletBC (@var{FunctionSpace}, @var{Boundary_Label},\
+             @var{Function_handle}) \n\
+Specify essential boundary condition on a specific side.\n\
 The input parameters are\n\
 @itemize @bullet \n\
-@item @var{Functional Space} is a fem-fenics functional space where\
+@item @var{FunctionSpace} is the fem-fenics space where \
 we want to apply the BC\n\
-@item @var{Function handle} is a function handle which contains the expression\
-that we want to apply as BC. If we have a Vector field, we can just use a\n\
-vector of function handle: \
-@var{Function handle} = ['@'(x, y) f1, '@'(x, y) f2, ...]\n\
-@item @var{Boundary} is an Array which contains the labels of the \
-sides where the BC is applied\n\
+@item @var{Function_handle} is a function handle which contains the expression \
+that we want to apply as a BC. If we have a Vector field, we can just use a\n\
+vector of function handles: \
+@var{Function handle} = [''@''(x, y) f1, ''@''(x, y) f2, ...]\n\
+@item @var{Boundary} is an Array which contains the label(s) of the \
+side(s) where the BC has to be applied.\n\
 @end itemize\n\
 The output @var{BC} is an object which contains the boundary conditions\n\
 @seealso{Mesh, FunctionSpace}\n\