changeset 143:9486cbdc0a2e

Maint: update the documentation
author gedeone-octave <marcovass89@hotmail.it>
date Mon, 09 Sep 2013 22:40:46 +0200
parents ed03c46b70b2
children 3192af07e539
files src/DirichletBC.cc src/Expression.cc src/Function.cc src/Makefile.in src/SubSpace.cc src/assemble.cc src/assemble_system.cc src/plot_func.cc
diffstat 8 files changed, 9 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/src/DirichletBC.cc	Mon Sep 09 22:33:35 2013 +0200
+++ b/src/DirichletBC.cc	Mon Sep 09 22:40:46 2013 +0200
@@ -33,7 +33,7 @@
 sides where the BC is applied\n\
 @end itemize\n\
 The output @var{BC} is an object which contains the boundary conditions\n\
-@seealso{Mesh, FunctionalSpace}\n\
+@seealso{Mesh, FunctionSpace}\n\
 @end deftypefn")
 {
   int nargin = args.length ();
--- a/src/Expression.cc	Mon Sep 09 22:33:35 2013 +0200
+++ b/src/Expression.cc	Mon Sep 09 22:40:46 2013 +0200
@@ -27,7 +27,7 @@
 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\
+@seealso{Constant, Function}\n\
 @end deftypefn")
 {
   int nargin = args.length ();
--- a/src/Function.cc	Mon Sep 09 22:33:35 2013 +0200
+++ b/src/Function.cc	Mon Sep 09 22:40:46 2013 +0200
@@ -26,7 +26,7 @@
 @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\
+@seealso{Constant, Expression, plot, save}\n\
 @end deftypefn")
 {
 
--- a/src/Makefile.in	Mon Sep 09 22:33:35 2013 +0200
+++ b/src/Makefile.in	Mon Sep 09 22:40:46 2013 +0200
@@ -1,9 +1,7 @@
 MKOCTFILE ?= mkoctfile
 FFC ?= ffc
 
-OCTFILES=fem_init_env.oct\
-             Mesh.oct \
-             fem_get_mesh.oct \
+OCTFILES= Mesh.oct \
              DirichletBC.oct \
              Expression.oct \
              Function.oct \
--- a/src/SubSpace.cc	Mon Sep 09 22:33:35 2013 +0200
+++ b/src/SubSpace.cc	Mon Sep 09 22:40:46 2013 +0200
@@ -26,6 +26,7 @@
 should be a positive integer.\n\
 @end itemize \n\
 The output @var{V0} is the SubSpace you need\n\
+@seealso{FunctionSpace}\n\
 @end deftypefn")
 {
   int nargin = args.length ();
--- a/src/assemble.cc	Mon Sep 09 22:33:35 2013 +0200
+++ b/src/assemble.cc	Mon Sep 09 22:40:46 2013 +0200
@@ -37,6 +37,7 @@
 then you should provide as 2nd argument the vector and you will receive it back\n\
 as the second output argument. For an example of this situation, you can look\n\
 the example HyperElasticity.m\n\
+@seealso{BilinearForm, LinearForm, ResidualForm, JacobianForm}\n\
 @end deftypefn")
 {
   int nargin = args.length ();
--- a/src/assemble_system.cc	Mon Sep 09 22:33:35 2013 +0200
+++ b/src/assemble_system.cc	Mon Sep 09 22:40:46 2013 +0200
@@ -37,6 +37,7 @@
 then you should provide as 3rd argument the vector and you will receive it back\n\
 as the third output argument. For an example of this situation, you can look\n\
 the example HyperElasticity.m\n\
+@seealso{BilinearForm, LinearForm, ResidualForm, JacobianForm}\n\
 @end deftypefn")
 {
   int nargin = args.length ();
--- a/src/plot_func.cc	Mon Sep 09 22:33:35 2013 +0200
+++ b/src/plot_func.cc	Mon Sep 09 22:40:46 2013 +0200
@@ -19,10 +19,10 @@
 
 DEFUN_DLD (plot, args, , "-*- texinfo -*-\n\
 @deftypefn {Function File} \
-fem_func (@var{Function})\n\
+plot (@var{Function})\n\
 The input parameter is the object that you want to plot\n\
 It can be either a Function or a Mesh \n\
-@seealso{fem_func, fem_save}\n\
+@seealso{Function, Save}\n\
 @end deftypefn")
 {