Commit b4f326cf authored by André Anjos's avatar André Anjos 💬

Fix documentation errors

parent 314068ba
Pipeline #4800 passed with stages
in 16 minutes and 8 seconds
...@@ -55,21 +55,22 @@ the import function: ...@@ -55,21 +55,22 @@ the import function:
Activation Functors Activation Functors
------------------- -------------------
.. cpp:type:: PyBobLearnActivationObject .. c:type:: PyBobLearnActivationObject
The pythonic object representation for a ``bob::machine::Activation`` The pythonic object representation for a
object. It is the base class of all activation functors available in ``bob::learn::activation::Activation`` object. It is the base class of all
|project|. In C/C++ code, we recommend you only manipulate objects like this activation functors available in |project|. In C/C++ code, we recommend you
to keep your code agnostic to the activation type being used. only manipulate objects like this to keep your code agnostic to the
activation type being used.
.. code-block:: cpp .. code-block:: cpp
typedef struct { typedef struct {
PyObject_HEAD PyObject_HEAD
bob::machine::Activation* base; bob::learn::activation::Activation* base;
} PyBobLearnActivationObject; } PyBobLearnActivationObject;
.. cpp:member:: bob::machine::Activation* base .. cpp:member:: bob::learn::activation::Activation* base
A pointer to the activation functor virtual implementation. A pointer to the activation functor virtual implementation.
...@@ -80,13 +81,14 @@ Activation Functors ...@@ -80,13 +81,14 @@ Activation Functors
Returns ``1`` if it is, and ``0`` otherwise. Returns ``1`` if it is, and ``0`` otherwise.
.. cpp:function:: PyObject* PyBobLearnActivation_NewFromActivation(boost::shared_ptr<bob::machine::Activation> a) .. cpp:function:: PyObject* PyBobLearnActivation_NewFromActivation(boost::shared_ptr<bob::learn::activation::Activation> a)
Constructs a new :c:type:`PyBobLearnActivationObject` starting from a shared Constructs a new :c:type:`PyBobLearnActivationObject` starting from a shared
pointer to a pre-allocated `bob::machine::Activation` instance. This API is pointer to a pre-allocated `bob::learn::activation::Activation` instance.
available so that return values from actuall C++ machines can be mapped into This API is available so that return values from actuall C++ machines can be
Python. It is the sole way to build an object of type :py:class:`Activation` mapped into Python. It is the sole way to build an object of type
without recurring to the derived classes. :py:class:`bob.learn.activation.Activation` without recurring to the derived
classes.
.. note:: .. note::
...@@ -100,7 +102,7 @@ Activation Functors ...@@ -100,7 +102,7 @@ Activation Functors
typedef struct { typedef struct {
PyBobLearnActivationObject parent; PyBobLearnActivationObject parent;
bob::machine::<Subtype>Activation* base; bob::learn::activation::<Subtype>Activation* base;
} PyBobLearn<Subtype>ActivationObject; } PyBobLearn<Subtype>ActivationObject;
Presently, ``<Subtype>`` can be one of: Presently, ``<Subtype>`` can be one of:
......
# No documentation exists for these c++ types
cpp:type bob
cpp:type bob::learn
cpp:type bob::learn::activation
cpp:type bob::learn::activation::Activation
cpp:type boost
cpp:type boost::shared_ptr
# These are not c++ types, but c - why Sphinx confuses those?
cpp:type PyObject
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment