From c61058dcf3cc472da20939520d5ebe452e930043 Mon Sep 17 00:00:00 2001
From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch>
Date: Fri, 19 Jan 2018 15:06:27 +0100
Subject: [PATCH] Add missing docstring.
---
ATXCommon/Serializables/ServiceConfig.cs | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/ATXCommon/Serializables/ServiceConfig.cs b/ATXCommon/Serializables/ServiceConfig.cs
index 7e967dc..a489427 100644
--- a/ATXCommon/Serializables/ServiceConfig.cs
+++ b/ATXCommon/Serializables/ServiceConfig.cs
@@ -263,6 +263,10 @@ namespace ATXCommon.Serializables
Log.Warn(">>> Non-optimal setting detected: <{0}> [{1}] {2}", attribute, value, msg);
}
+ /// <summary>
+ /// Generate a human-readable sumary of the current configuration.
+ /// </summary>
+ /// <returns>A string with details on the configuration.</returns>
public string Summary() {
var msg =
"HostAlias: " + HostAlias + "\n" +
--
GitLab