On 07/06/11 14:35, Kristian Ølgaard wrote:
On 6 July 2011 12:42, Marie E. Rognes<m...@simula.no> wrote:
We have a wonderful student (Anders E Johansen) hired for the summer at
Simula, who at the moment is going through the DOLFIN code base and
improving the docstrings and doc-comments.
In that connection, I thought that I'd check that we are still committed to
the current formatting and automatic extraction of docstrings from C++ and
Python as described in
http://www.fenicsproject.org/new/dev/documenting_dolfin_api.html#the-long-story
Yes/No?
Yes, I think this is the only way that we can get the docstrings in
the generated cpp.py module correct.
Also a good way to get (clickable) links in the reference for both
languages.
The disadvantage is that the C++ header files end up containing
substantial amount of markup. I just wanted to check that everyone still
thinks this is acceptable.
Perhaps the text on the above page needs to be updated to fit the new
procedure for actually generating the docs (split of C++ and Python)?
I did not check this.
Yes, there is a warning at the top of this page regarding the text being
restructured ;-)
--
Marie
Kristian
--
Marie
_______________________________________________
Mailing list: https://launchpad.net/~dolfin
Post to : dolfin@lists.launchpad.net
Unsubscribe : https://launchpad.net/~dolfin
More help : https://help.launchpad.net/ListHelp
_______________________________________________
Mailing list: https://launchpad.net/~dolfin
Post to : dolfin@lists.launchpad.net
Unsubscribe : https://launchpad.net/~dolfin
More help : https://help.launchpad.net/ListHelp
