From ab68a3ba74dbc03bf7267b106ab93dca1bcbbc16 Mon Sep 17 00:00:00 2001
From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch>
Date: Tue, 13 Feb 2018 00:06:14 +0100
Subject: [PATCH] Add method docstring.

---
 ATxCommon/Serializables/ServiceConfig.cs | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/ATxCommon/Serializables/ServiceConfig.cs b/ATxCommon/Serializables/ServiceConfig.cs
index 98cd024..9cfffd6 100644
--- a/ATxCommon/Serializables/ServiceConfig.cs
+++ b/ATxCommon/Serializables/ServiceConfig.cs
@@ -24,6 +24,9 @@ namespace ATxCommon.Serializables
             EnforceInheritedACLs = true;
         }
 
+        /// <summary>
+        /// Dummy method raising an exception (this class must not be serialized).
+        /// </summary>
         public static void Serialize(string file, ServiceConfig c) {
             // the config is never meant to be written by us, therefore:
             throw new SettingsPropertyIsReadOnlyException("The config file must not be written by the service!");
-- 
GitLab