From 5c9a361c155471019988b29a2653b06d22d2340a Mon Sep 17 00:00:00 2001
From: Elias Pipping <elias.pipping@fu-berlin.de>
Date: Wed, 12 Oct 2011 17:04:37 +0200
Subject: [PATCH] Docstrings
---
src/duneevaluate.cc | 4 +++-
src/duneminimise.cc | 4 +++-
2 files changed, 6 insertions(+), 2 deletions(-)
diff --git a/src/duneevaluate.cc b/src/duneevaluate.cc
index 4af3f5ff..6f4d9059 100644
--- a/src/duneevaluate.cc
+++ b/src/duneevaluate.cc
@@ -11,7 +11,9 @@
#include <cassert>
-DEFUN_DLD(duneevaluate, args, nargout, "the help string") {
+DEFUN_DLD(duneevaluate, args, nargout, "duneevaluate(y)\n\
+\n\
+Evaluate x -> 1/2<Ax,x> - <b,x> + H(|x|) at y using DUNE\n") {
assert(args.length() == 1);
ColumnVector point(args(0).matrix_value());
diff --git a/src/duneminimise.cc b/src/duneminimise.cc
index e0b19bbf..7b8b3bd3 100644
--- a/src/duneminimise.cc
+++ b/src/duneminimise.cc
@@ -11,7 +11,9 @@
#include <cassert>
-DEFUN_DLD(duneminimise, args, nargout, "the help string") {
+DEFUN_DLD(duneminimise, args, nargout, "duneminimise(y)\n\
+\n\
+Make a minimisation step of x -> 1/2<Ax,x> - <b,x> + H(|x|) using DUNE starting at x\n") {
assert(args.length() == 1);
ColumnVector current(args(0).matrix_value());
--
GitLab