museum-digital/MDMailer
33
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Fix code comments

Browse Source
This commit is contained in:
Joshua Ramon Enslin 2020-10-21 15:05:59 +02:00 committed by Stefan Rohde-Enslin
parent 12c4a0abf8
commit ae2d83172d
Signed by: jrenslin
GPG Key ID: 46016F84501B70AE
2 changed files with 17 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

27
src/MDMailFormat.php
View File

@ -1,11 +1,12 @@
<?PHP
/**
* Wrapper class around mysqli.
* Formats a mail.
*/
declare(strict_types = 1);
/**
* MD mysqli wrapper.
* MDMailFormat formats a mail by offering functions to simultaneously editing
* its HTML and Plain Text representations.
*/
final class MDMailFormat {
@ -49,7 +50,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for adding a second level headline.
*
* @param string $input Input string.
*
@ -65,7 +66,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for adding a paragraph.
*
* @param string $input Input string.
*
@ -81,7 +82,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for adding a button.
*
* @param string $href Input link.
* @param string $input Input text.
@ -98,7 +99,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for adding an inline link.
*
* @param string $href Input link.
* @param string $input Input text.
@ -113,7 +114,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for starting an unordered list.
*
* @return void
*/
@ -124,7 +125,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for ending an unordered list.
*
* @return void
*/
@ -135,7 +136,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for opening an ordered list.
*
* @return void
*/
@ -146,7 +147,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for ending an ordered list.
*
* @return void
*/
@ -157,7 +158,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for starting a list item in an unordered list.
*
* @return void
*/
@ -168,7 +169,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for starting a list item in an ordered list.
*
* @param integer $counter Counter of the list item.
*
@ -181,7 +182,7 @@ final class MDMailFormat {
}
/**
* Function for adding a headline.
* Function for ending a list item.
*
* @return void
*/

6
src/MDMailerHelper.php
View File

@ -1,6 +1,6 @@
<?PHP
/**
* Wrapper class around mysqli.
* Contains a class MDMailerHelper for improved handling of mails in the md ecosystem.
*/
declare(strict_types = 1);
@ -9,12 +9,12 @@ use PHPMailer\PHPMailer\SMTP;
use PHPMailer\PHPMailer\Exception;
/**
* MD mysqli wrapper.
* Class containing static functions for an easier handling of mails.
*/
final class MDMailerHelper {
/**
* PHP-encrypts a message to a given email address.
* PGP-encrypts a message to a given email address.
*
* @param string $to Recipient email address.
* @param string $msg Message contents.