From d332bffd291ce321e1d0577afb2c9ad4fe25e2a5 Mon Sep 17 00:00:00 2001
From: Andreas Suter <andreas.suter@psi.ch>
Date: Wed, 18 Aug 2021 19:17:18 +0200
Subject: [PATCH] added some docu.

---
 src/external/Nonlocal/prog/dump_nonlocal_field.cpp | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/external/Nonlocal/prog/dump_nonlocal_field.cpp b/src/external/Nonlocal/prog/dump_nonlocal_field.cpp
index 4efd46bc..299a7623 100644
--- a/src/external/Nonlocal/prog/dump_nonlocal_field.cpp
+++ b/src/external/Nonlocal/prog/dump_nonlocal_field.cpp
@@ -48,6 +48,10 @@
 #include "git-revision.h"
 #endif
 
+//-----------------------------------------------------------------------------
+/**
+ * <p>dump_nonlocal_field synatx console output.
+ */
 void dnlf_syntax()
 {
   std::cout << std::endl;
@@ -60,6 +64,15 @@ void dnlf_syntax()
   std::cout << std::endl << std::endl;
 }
 
+//-----------------------------------------------------------------------------
+/**
+ * <p> reads the msr-file and estracts the necessary parameter information.
+ *
+ * @param fln msr-file name
+ * @param param parameter vector needed to calculate the magnetic field
+ *
+ * @return true, if everything went smoothly, false otherwise.
+ */
 bool dnlf_read_msr(const std::string fln, std::vector<double> &param)
 {
   std::ifstream fin(fln.c_str(), std::ifstream::in);