Mercurial > fem-fenics-eugenio
changeset 50:fcfecdd3a9b5
Maint: improve the documentation
| author | gedeone-octave <marco.vassallo@outlook.com> |
|---|---|
| date | Thu, 25 Jul 2013 09:04:36 +0200 |
| parents | a4ef215d1eed |
| children | 54cca651760e |
| files | src/fem_bc.cc src/fem_coeff.cc src/fem_func.cc src/fem_lhs.cc src/fem_rhs.cc src/fem_save.cc |
| diffstat | 6 files changed, 6 insertions(+), 0 deletions(-) [+] |
line wrap: on
line diff
--- a/src/fem_bc.cc Mon Jul 22 15:32:27 2013 +0200 +++ b/src/fem_bc.cc Thu Jul 25 09:04:36 2013 +0200 @@ -31,6 +31,7 @@ that we want to apply on the BC\n\ @item @var{Boundary} is an Array which specify the label of the \ sides where the BC is applied\n\ +@end itemize\n\ The output @var{BC} is an object which contains the boundary conditions\n\ @seealso{fem_init_mesh, fem_fs}\n\ @end deftypefn")
--- a/src/fem_coeff.cc Mon Jul 22 15:32:27 2013 +0200 +++ b/src/fem_coeff.cc Thu Jul 25 09:04:36 2013 +0200 @@ -25,6 +25,7 @@ @item @var{name} is the name of the coefficient declared in the .ufl file\n\ @item @var{Functio handle} is a function handle which contains the expression\ that we want to apply for our coefficient\n\ +@end itemize\n\ The output @var{f} is an object which contains a representation of the function\n\ @seealso{fem_init_mesh, fem_fs}\n\ @end deftypefn")
--- a/src/fem_func.cc Mon Jul 22 15:32:27 2013 +0200 +++ b/src/fem_func.cc Thu Jul 25 09:04:36 2013 +0200 @@ -11,6 +11,7 @@ the vector is defined\n\ @item @var{Vector} contains the value of the coefficients\ for the basis functions of @var{Functional Space}\n\ +@end itemize\n\ The output @var{func} is an object which contain a representation of the\ function @var{Vector} which can be plotted or saved.\n\ @seealso{fem_plot, fem_save}\n\
--- a/src/fem_lhs.cc Mon Jul 22 15:32:27 2013 +0200 +++ b/src/fem_lhs.cc Thu Jul 25 09:04:36 2013 +0200 @@ -33,6 +33,7 @@ we want to apply to the Bilinear Form\n\ @item @var{Coefficient} is a variable of type coefficient which contains\ the value of the coefficient for the bilinear form\n\ +@end itemize\n\ The output @var{A} is a sparse matrix which represents the bilinear form\n\ @seealso{fem_init_mesh, fem_fs}\n\ @end deftypefn")
--- a/src/fem_rhs.cc Mon Jul 22 15:32:27 2013 +0200 +++ b/src/fem_rhs.cc Thu Jul 25 09:04:36 2013 +0200 @@ -33,6 +33,7 @@ we want to apply to the Bilinear Form\n\ @item @var{Coefficient} is a variable of type coefficient which contains\ the value of the coefficient for the bilinear form\n\ +@end itemize\n\ The output @var{A} is a sparse matrix which represents the bilinear form\n\ @seealso{fem_init_mesh, fem_fs}\n\ @end deftypefn")
--- a/src/fem_save.cc Mon Jul 22 15:32:27 2013 +0200 +++ b/src/fem_save.cc Thu Jul 25 09:04:36 2013 +0200 @@ -8,6 +8,7 @@ @itemize @bullet \n\ @item @var{Function} is the parameter of type function that you want to save\n\ @item @var{Name} is a string for the output name\n\ +@end itemize\n\ The output is a file in format .pvd\n\ @seealso{fem_plot, fem_func}\n\ @end deftypefn")