From 032fba8bd45009aa2d806f5bf9a962ed17e9ef5c Mon Sep 17 00:00:00 2001
From: Jonathan Youett <youett@math.fu-berlin.de>
Date: Mon, 8 Jan 2018 14:56:55 +0100
Subject: [PATCH] Add some documentation

---
 dune/fufem/improvegrid.hh | 5 +++++
 1 file changed, 5 insertions(+)

diff --git a/dune/fufem/improvegrid.hh b/dune/fufem/improvegrid.hh
index 46aa8692..c040958c 100644
--- a/dune/fufem/improvegrid.hh
+++ b/dune/fufem/improvegrid.hh
@@ -62,6 +62,11 @@ double aspectRatio(const EntityType& entity)
 
 }
 
+/** \brief Improve maximal aspect ratio of the grid by moving vertices.
+ *
+ *  \param grid The grid
+ *  \param threshold The threshold on the aspect ratio that determines which elements should be refined.
+ */
 template <class GridType>
 void improveGrid(GridType& grid, double threshold)
 {
-- 
GitLab