dolfin team mailing list archive

[Kristian Ølgaard <k.b.oelgaard@xxxxxxxxx>]

On 19 October 2010 16:52, Anders Logg <logg@xxxxxxxxx> wrote:
> Kristian, is it time to move things over from newdoc to doc (and remove
> newdoc)?

Yes, I think we can do that. I was just looking at one of the last
issues which is translating type info from C++ syntax to Python.

I think we handle all the DOLFIN classes in a nice way using e.g.,
_Mesh_ to create links, but for the built-in types, I think that we
should perhaps do the following:

For the *Returns* section, the first line should only contain the type
such that for the Mesh::coordinates() function we will have:

    /// *Returns*
    ///     double*
    ///         Coordinates of all vertices.

instead of what we have now:

    /// *Returns*
    ///     An array of doubles
    ///         Coordinates of all vertices.

Then the 'double*' will be mapped to 'numpy.array(float)' (or similar)
for the Python programmer's reference, 'int* --> 'numpy.array(int)'
and 'std::vec<double>' --> 'list of floats' etc.

For the *Arguments* section we can include the argument type
information in parenthesis just after the argument name such that for
the Mesh::num_entities(uint d) function we will have:

    /// *Arguments*
    ///     d (integer)
    ///         Topological dimension.

instead of what we have now:

    /// *Arguments*
    ///     d
    ///         An integer, topological dimension.

For the former it will be easy to do search and replace to handle the mapping.
What do you think?

Kristian

> I see there have been a couple of important bug fixes, including the
> template parse error.
>
> If so, could Johannes update the cronjob to fix this?
>
> --
> Anders
>
> _______________________________________________
> Mailing list: https://launchpad.net/~dolfin
> Post to     : dolfin@xxxxxxxxxxxxxxxxxxx
> Unsubscribe : https://launchpad.net/~dolfin
> More help   : https://help.launchpad.net/ListHelp
>