[Getfem-commits] [getfem-commits] branch fixmisspell updated: :heavy_plus_sign: cpp:function

[Tetsuo Koyama]

This is an automated email from the git hooks/post-receive script.

tkoyama010 pushed a commit to branch fixmisspell
in repository getfem.

The following commit(s) were added to refs/heads/fixmisspell by this push:
     new 1aafd39  :heavy_plus_sign: cpp:function
1aafd39 is described below

commit 1aafd394be6d5133d04b8538184fc53737ed0ef8
Author: Tetsuo Koyama <address@hidden>
AuthorDate: Tue Mar 24 16:06:47 2020 +0000

    :heavy_plus_sign: cpp:function
---
 doc/sphinx/source/documenting/markup.rst    |  6 +++++
 doc/sphinx/source/project/femdesc.rst       | 16 ++++++------
 doc/sphinx/source/project/libdesc_event.rst |  8 +++---
 doc/sphinx/source/userdoc/export.rst        | 30 +++++++++++------------
 doc/sphinx/source/userdoc/model_object.rst  | 38 ++++++++++++++---------------
 5 files changed, 52 insertions(+), 46 deletions(-)

diff --git a/doc/sphinx/source/documenting/markup.rst 
b/doc/sphinx/source/documenting/markup.rst
index df44530..db10a80 100644
--- a/doc/sphinx/source/documenting/markup.rst
+++ b/doc/sphinx/source/documenting/markup.rst
@@ -107,6 +107,12 @@ index entries more informative.
 
 The directives are:
 
+.. describe:: cpp:function
+
+   Describes a C++ function. The signature should be given as in C++, e.g.::
+
+      .. cpp:function:: bgeot::simplex_structure(dim_type d)
+
 .. describe:: c:function
 
    Describes a C function. The signature should be given as in C, e.g.::
diff --git a/doc/sphinx/source/project/femdesc.rst 
b/doc/sphinx/source/project/femdesc.rst
index 6b855f8..117e028 100644
--- a/doc/sphinx/source/project/femdesc.rst
+++ b/doc/sphinx/source/project/femdesc.rst
@@ -34,19 +34,19 @@ be declared with the type |bg_pcs|
 The following functions give a pointer onto the descriptor of the usual type of
 elements:
 
-.. c:function:: bgeot::simplex_structure(dim_type d)
+.. cpp:function:: bgeot::simplex_structure(dim_type d)
 
    description of a simplex of dimension ``d``.
 
-.. c:function:: bgeot::parallelepiped_structure(dim_type d)
+.. cpp:function:: bgeot::parallelepiped_structure(dim_type d)
 
    description of a parallelepiped of dimension ``d``.
 
-.. c:function:: bgeot::convex_product_structure(bgeot::pconvex_structure p1, 
bgeot::pconv$
+.. cpp:function:: bgeot::convex_product_structure(bgeot::pconvex_structure p1, 
bgeot::pconv$
 
    description of the direct product of ``p1`` and ``p2``.
 
-.. c:function:: bgeot::prism_P1_structure(dim_type d)
+.. cpp:function:: bgeot::prism_P1_structure(dim_type d)
 
    description of a prism of dimension ``d``.
 
@@ -86,20 +86,20 @@ descriptor.
 
 The following functions build the descriptions:
 
-.. c:function:: bgeot::simplex_of_reference(dim_type d)
+.. cpp:function:: bgeot::simplex_of_reference(dim_type d)
 
    description of the simplex of reference of dimension ``d``.
 
-.. c:function:: bgeot::simplex_of_reference(dim_type d, short_type k)
+.. cpp:function:: bgeot::simplex_of_reference(dim_type d, short_type k)
 
    description of the simplex of reference of dimension ``d`` with degree ``k``
    Lagrange grid.
 
-.. c:function:: bgeot::convex_ref_product(pconvex_ref a, pconvex_ref b)
+.. cpp:function:: bgeot::convex_ref_product(pconvex_ref a, pconvex_ref b)
 
    description of the direct product of two convexes of reference.
 
-.. c:function:: bgeot::parallelepiped_of_reference(dim_type d)
+.. cpp:function:: bgeot::parallelepiped_of_reference(dim_type d)
 
    description of the parallelepiped of reference of dimension ``d``.
 
diff --git a/doc/sphinx/source/project/libdesc_event.rst 
b/doc/sphinx/source/project/libdesc_event.rst
index e6d9f1b..229a45a 100644
--- a/doc/sphinx/source/project/libdesc_event.rst
+++ b/doc/sphinx/source/project/libdesc_event.rst
@@ -36,23 +36,23 @@ order to deal with the dependencies of an object, the object
 ``context_dependencies`` needs to be a parent class of this object. It adds the
 following methods to the object:
 
-.. c:function:: add_dependency(ct)
+.. cpp:function:: add_dependency(ct)
 
    Add an object (which has to have ``context_dependencies`` as a parent class)
    to the list of objects from which the current object depend.
 
-.. c:function:: touch()
+.. cpp:function:: touch()
 
    Indicates to the dependent objects that something has change in the object.
 
-.. c:function:: context_check()
+.. cpp:function:: context_check()
 
    Check if the object has to be updated. if it is the case it makes first a
    check to the dependency list and call the update function of the object. 
(the
    update function of the dependencies are called before the update function of
    the current object).
 
-.. c:function:: context_valid()
+.. cpp:function:: context_valid()
 
    Says if the object has still a valid context, i.e. if the object in the
    dependency list still exist.
diff --git a/doc/sphinx/source/userdoc/export.rst 
b/doc/sphinx/source/userdoc/export.rst
index f3331a8..38ddc5d 100644
--- a/doc/sphinx/source/userdoc/export.rst
+++ b/doc/sphinx/source/userdoc/export.rst
@@ -70,74 +70,74 @@ All slicer operation inherit from |gf_sl_a|, it is very 
easy to create a new
 slicer. Example of slicers are (some of them use a |gf_sl_ddb| which is just a
 reference to a |mf| ``mf`` and a field ``U`` on this |mf|).
 
-.. c:function:: getfem::slicer_none()
+.. cpp:function:: getfem::slicer_none()
 
    empty slicer.
 
-.. c:function:: getfem::slicer_boundary(const mesh &m, \ldots)
+.. cpp:function:: getfem::slicer_boundary(const mesh &m, \ldots)
 
    extract the boundary of a mesh.
 
-.. c:function:: getfem::slicer_apply_deformation(mesh_slice_cv_dof_data_base &)
+.. cpp:function:: getfem::slicer_apply_deformation(mesh_slice_cv_dof_data_base 
&)
 
    apply a deformation to the mesh , the deformation field is defined on a 
|mf|.
 
-.. c:function:: getfem::slicer_half_space(base_node x0, base_node n, int 
orient)
+.. cpp:function:: getfem::slicer_half_space(base_node x0, base_node n, int 
orient)
 
    cut the mesh with a half space (if ``orient`` = -1 or +1), or a plane (if
    ``orient`` = 0), ``x0`` being a node of the plane, and ``n`` being a normal
    of the plane.
 
-.. c:function::  getfem::slicer_sphere(base_node x0, scalar_type R, int orient)
+.. cpp:function::  getfem::slicer_sphere(base_node x0, scalar_type R, int 
orient)
 
    cut with the interior (``orient``=-1), boundary (``orient``=0) or exterior
    (``orient``=+1) or a sphere of center ``x0`` and radius ``R``.
 
-.. c:function:: getfem::slicer_cylinder(base_node x0, base_node x1, 
scalar_type R, int orient)
+.. cpp:function:: getfem::slicer_cylinder(base_node x0, base_node x1, 
scalar_type R, int orient)
 
    slice with the interior/boundary/exterior of a cylinder of axis ``(x0,x1)``
    and radius ``R``.
 
-.. c:function:: getfem::slicer_isovalues(const mesh_slice_cv_dof_data_base& 
mfU, scalar_type val, int orient)
+.. cpp:function:: getfem::slicer_isovalues(const mesh_slice_cv_dof_data_base& 
mfU, scalar_type val, int orient)
 
    cut with the isosurface defined by the scalar field ``mfU`` and ``val``.
    Keep only simplices where ::math:`u(x)<val` (``orient``=-1), 
:math:`u(x)=val`
    (``orient=0`` or :math:`u(x)>val`.
 
-.. c:function:: getfem::slicer_mesh_with_mesh(const mesh& m2)
+.. cpp:function:: getfem::slicer_mesh_with_mesh(const mesh& m2)
 
    cut the convexes with the convexes of the mesh ``m2``.
 
-.. c:function:: getfem::slicer_union(const slicer_action &sA, const 
slicer_action &sB)
+.. cpp:function:: getfem::slicer_union(const slicer_action &sA, const 
slicer_action &sB)
 
    merges the output of two slicer operations.
 
-.. c:function:: getfem::slicer_intersect(slicer_action &sA, slicer_action &sB)
+.. cpp:function:: getfem::slicer_intersect(slicer_action &sA, slicer_action 
&sB)
 
    intersect the output of two slicer operations.
 
-.. c:function:: getfem::slicer_complementary(slicer_action &s)
+.. cpp:function:: getfem::slicer_complementary(slicer_action &s)
 
    return the complementary of a slicer operation.
 
-.. c:function:: getfem::slicer_build_edges_mesh(mesh& edges_m)
+.. cpp:function:: getfem::slicer_build_edges_mesh(mesh& edges_m)
 
    slicer whose side-effect is to build the mesh ``edges_m`` with the edges of
    the sliced mesh.
 
-.. c:function:: getfem::slicer_build_mesh(mesh &m)
+.. cpp:function:: getfem::slicer_build_mesh(mesh &m)
 
    in some (rare) occasions , it might be useful to build a mesh from a slice.
    Note however that there is absolutely no guaranty that the mesh will be
    conformal (although it is often the case).
 
-.. c:function:: getfem::slicer_build_stored_mesh_slice(stored_mesh_slice& sl)
+.. cpp:function:: getfem::slicer_build_stored_mesh_slice(stored_mesh_slice& sl)
 
    record the output of the slicing operation into a |smsl| object. Note that 
it
    is often more convenient to use the ``stored_mesh_slice::build(...)`` 
method to
    achieve the same result.
 
-.. c:function:: getfem::slicer_explode(c)
+.. cpp:function:: getfem::slicer_explode(c)
 
    shrink or expand each convex with respect to its gravity center.
 
diff --git a/doc/sphinx/source/userdoc/model_object.rst 
b/doc/sphinx/source/userdoc/model_object.rst
index 139fae0..58f1d10 100644
--- a/doc/sphinx/source/userdoc/model_object.rst
+++ b/doc/sphinx/source/userdoc/model_object.rst
@@ -58,49 +58,49 @@ different bricks added to the model.
 
 The main useful methods on a |mo| object are
 
-.. c:function:: m.is_complex()
+.. cpp:function:: m.is_complex()
 
    A boolean which says if the model deals with real or complex unknowns and 
data.
 
-.. c:function:: add_fixed_size_variable(name, size, niter=1)
+.. cpp:function:: add_fixed_size_variable(name, size, niter=1)
 
    Add a variable of fixed size. ``name`` is a string which designate the
    variable. ``niter`` is the number of copy of the variable.
 
-.. c:function:: add_fixed_size_variable(name, sizes, niter=1)
+.. cpp:function:: add_fixed_size_variable(name, sizes, niter=1)
 
    Add a variable of fixed size. ``name`` is a string which designate the
    variable. ``sizes`` is a vector of dimension for matrix or tensor fixed
    size variables. ``niter`` is the number of copy of the variable.
 
-.. c:function:: add_fixed_size_data(name, size, niter=1)
+.. cpp:function:: add_fixed_size_data(name, size, niter=1)
 
    Add a data of fixed size. ``name`` is a string which designate the data.
    ``niter`` is the number of copy of the data.
 
-.. c:function:: add_fixed_size_data(name, sizes, niter=1)
+.. cpp:function:: add_fixed_size_data(name, sizes, niter=1)
 
    Add a data of fixed size. ``name`` is a string which designate the data.
    ``sizes`` is a vector of dimension for matrix or tensor fixed
    size variables. ``niter`` is the number of copy of the data.
 
-.. c:function:: add_initialized_fixed_size_data(name, V)
+.. cpp:function:: add_initialized_fixed_size_data(name, V)
 
    Add a data of fixed size initialized with the given vector ``V``. ``name`` 
is a
    string which designate the data.
 
-.. c:function:: add_initialized_scalar_data(name, e)
+.. cpp:function:: add_initialized_scalar_data(name, e)
 
    Add a data of size 1 initialized with the given scalar value ``e``. 
``name`` is
    a string which designate the data.
 
-.. c:function:: add_fem_variable(name, mf, niter=1)
+.. cpp:function:: add_fem_variable(name, mf, niter=1)
 
    Add a variable being the dofs of a finite element method ``mf``. ``name`` 
is a
    string which designate the variable. ``niter`` is the number of copy of the
    variable.
 
-.. c:function:: add_filtered_fem_variable(name, mf, region)
+.. cpp:function:: add_filtered_fem_variable(name, mf, region)
 
    Add a variable being the dofs of a finite element method ``mf`` only
    specific to a given region.
@@ -111,18 +111,18 @@ The main useful methods on a |mo| object are
    object will be used. The method ``mesh_fem_of_variable('name')`` allows to
    access to the ``partial_mesh_fem`` built. 
 
-.. c:function:: add_fem_data(name, mf, niter=1)
+.. cpp:function:: add_fem_data(name, mf, niter=1)
 
    Add a data being the dofs of a finite element method ``mf``. ``name`` is a
    string which designate the data. ``niter`` is the number of copy of the 
data.
 
-.. c:function:: add_initialized_fem_data(name, mf, V, niter=1)
+.. cpp:function:: add_initialized_fem_data(name, mf, V, niter=1)
 
    Add a data being the dofs of a finite element method ``mf`` initialized with
    the given vector ``V``. ``name`` is a string which designate the data.
    ``niter`` is the number of copy of the data.
 
-.. c:function:: add_multiplier(name, mf, primal_name, niter=1)
+.. cpp:function:: add_multiplier(name, mf, primal_name, niter=1)
 
    Add a special variable linked to the finite element method ``mf`` and being 
a
    multiplier for certain constraints (Dirichlet condition for instance) on a
@@ -136,35 +136,35 @@ The main useful methods on a |mo| object are
    variable. Note that for complex terms, only
    the real part is considered to filter the multiplier.
 
-.. c:function:: real_variable(name, niter=1)
+.. cpp:function:: real_variable(name, niter=1)
 
    Gives the access to the vector value of a variable or data. Real version.
 
-.. c:function:: complex_variable(name, niter=1)
+.. cpp:function:: complex_variable(name, niter=1)
 
    Gives the access to the vector value of a variable or data. Complex version.
 
-.. c:function:: mesh_fem_of_variable(name)
+.. cpp:function:: mesh_fem_of_variable(name)
 
    Gives a reference on the |mf| on which the variable is defined. Throw an
    exception if this is not a fem variable.
 
-.. c:function:: real_tangent_matrix()
+.. cpp:function:: real_tangent_matrix()
 
    Gives the access to tangent matrix. Real version. A computation of the 
tangent
    system have to be done first.
 
-.. c:function:: complex_tangent_matrix()
+.. cpp:function:: complex_tangent_matrix()
 
    Gives the access to tangent matrix. Complex version. A computation of the
    tangent system have to be done first.
 
-.. c:function:: real_rhs()
+.. cpp:function:: real_rhs()
 
    Gives the access to right hand side vector of the linear system. real 
version.
    A computation of the tangent system have to be done first.
 
-.. c:function:: complex_rhs()
+.. cpp:function:: complex_rhs()
 
    Gives the access to right hand side vector of the linear system. Complex
    version. A computation of the tangent system have to be done first.