From 0b2d0e302e9560dc1b55ec5c29293fefcb612ea8 Mon Sep 17 00:00:00 2001
From: Niko Ehrenfeuchter <nikolaus.ehrenfeuchter@unibas.ch>
Date: Mon, 18 Dec 2017 16:46:59 +0100
Subject: [PATCH] Add parameter description to SendEmail documentation.
---
AutoTx/Email.cs | 6 +++---
1 file changed, 3 insertions(+), 3 deletions(-)
diff --git a/AutoTx/Email.cs b/AutoTx/Email.cs
index cb90c15..ee424a3 100644
--- a/AutoTx/Email.cs
+++ b/AutoTx/Email.cs
@@ -12,9 +12,9 @@ namespace AutoTx
/// <summary>
/// Send an email using the configuration values.
/// </summary>
- /// <param name="recipient"></param>
- /// <param name="subject"></param>
- /// <param name="body"></param>
+ /// <param name="recipient">A full email address OR a valid ActiveDirectory account.</param>
+ /// <param name="subject">The subject, might be prefixed with a configurable string.</param>
+ /// <param name="body">The email body.</param>
public void SendEmail(string recipient, string subject, string body) {
subject = _config.EmailPrefix + subject;
if (string.IsNullOrEmpty(_config.SmtpHost)) {
--
GitLab