Mercurial > fem-fenics-eugenio
changeset 48:c73bca616ca7
Add texinfo description for the DLD functions
| author | gedeone-octave <marco.vassallo@outlook.com> |
|---|---|
| date | Mon, 22 Jul 2013 15:13:30 +0200 |
| parents | fe29ca22b1ec |
| children | a4ef215d1eed |
| files | src/fem_func.cc src/fem_plot.cc src/fem_save.cc |
| diffstat | 3 files changed, 29 insertions(+), 3 deletions(-) [+] |
line wrap: on
line diff
--- a/src/fem_func.cc Mon Jul 22 14:58:35 2013 +0200 +++ b/src/fem_func.cc Mon Jul 22 15:13:30 2013 +0200 @@ -2,7 +2,19 @@ #include "functionspace.h" #include "function.h" -DEFUN_DLD (fem_func, args, , "fem_func: functionspace V, vector u") +DEFUN_DLD (fem_func, args, , "-*- texinfo -*-\n\ +@deftypefn {Function File} {[@var{func}]} = \ +fem_func (@var{Functional Space}, @var{Vector}\n\ +The input parameters are\n\ +@itemize @bullet \n\ +@item @var{Functional Space} is the fem-fenics functional space where\ +the vector is defined\n\ +@item @var{Vector} contains the value of the coefficients\ +for the basis functions of @var{Functional Space}\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\ +@end deftypefn") { int nargin = args.length ();
--- a/src/fem_plot.cc Mon Jul 22 14:58:35 2013 +0200 +++ b/src/fem_plot.cc Mon Jul 22 15:13:30 2013 +0200 @@ -1,7 +1,12 @@ #include <dolfin.h> #include "function.h" -DEFUN_DLD (fem_plot, args, , "fem_plot: functionspace V, vector u") +DEFUN_DLD (fem_plot, args, , "-*- texinfo -*-\n\ +@deftypefn {Function File} \ +fem_func (@var{Function})\n\ +The input parameter is the function that you want to plot\n\ +@seealso{fem_func, fem_save}\n\ +@end deftypefn") { int nargin = args.length ();
--- a/src/fem_save.cc Mon Jul 22 14:58:35 2013 +0200 +++ b/src/fem_save.cc Mon Jul 22 15:13:30 2013 +0200 @@ -1,7 +1,16 @@ #include <dolfin.h> #include "function.h" -DEFUN_DLD (fem_save, args, , "fem_save: function V, string name") +DEFUN_DLD (fem_save, args, , "-*- texinfo -*-\n\ +@deftypefn {Function File} \ +fem_save (@var{Function}, @var{Name}\n\ +The input parameters are\n\ +@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\ +The output is a file in format .pvd\n\ +@seealso{fem_plot, fem_func}\n\ +@end deftypefn") { int nargin = args.length ();