Commit 90daed5c authored by Emilia Juda's avatar Emilia Juda
Browse files

sample doxygen

parent 186ad576
...@@ -10,6 +10,13 @@ using namespace Nektar::LibUtilities; ...@@ -10,6 +10,13 @@ using namespace Nektar::LibUtilities;
typedef std::shared_ptr<Points<double> > PointsSharedPtr; typedef std::shared_ptr<Points<double> > PointsSharedPtr;
typedef std::shared_ptr<NekMatrix<NekDouble> > MatrixSharedPtrType; typedef std::shared_ptr<NekMatrix<NekDouble> > MatrixSharedPtrType;
// DocString: foo
/**
* @brief Foo doc
* @param i an integer
* @return something
*
*/
PointsSharedPtr Points_Create(const PointsKey &pts) PointsSharedPtr Points_Create(const PointsKey &pts)
{ {
return PointsManager()[pts]; return PointsManager()[pts];
...@@ -61,7 +68,7 @@ void export_Points() ...@@ -61,7 +68,7 @@ void export_Points()
"Points", "Points",
"docstring", "docstring",
py::no_init) py::no_init)
.def("Create", &Points_Create) .def("Create", &Points_Create, "@DocString(foo)")
.staticmethod("Create") .staticmethod("Create")
.def("Initialise", &Points<double>::Initialize) .def("Initialise", &Points<double>::Initialize)
......
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