Adding comments to modules

diff --git a/modules/lastseen.cpp b/modules/lastseen.cpp
index 88a9d8800e973bd4d26381ab444b96a954f6ebb6..b8b384b59bdbaf7a5113aee6f46d9cc95bc7985b 100644 (file)
--- a/modules/lastseen.cpp
+++ b/modules/lastseen.cpp
@@ -47,6 +47,7 @@ class CLastSeenMod : public CModule {
     typedef multimap<time_t, CUser*> MTimeMulti;
     typedef map<CString, CUser*> MUsers;
 
+    // Shows all users as well as the time they were last seen online
     void ShowCommand(const CString& sLine) {
         if (!GetUser()->IsAdmin()) {
             PutModule("Access denied");
@@ -95,6 +96,7 @@ class CLastSeenMod : public CModule {
     bool WebRequiresAdmin() override { return true; }
     CString GetWebMenuTitle() override { return "Last Seen"; }
 
+    // Provides GUI to configure this module by adding a widget to user page in webadmin.
     bool OnWebRequest(CWebSock& WebSock, const CString& sPageName,
                       CTemplate& Tmpl) override {
         if (sPageName == "index") {

diff --git a/modules/sample.cpp b/modules/sample.cpp
index c4e69853679cd40a563ff629f0458a053d8de10c..2fc06f92d2ce2baad3cde9102117c501bd07cb49 100644 (file)
--- a/modules/sample.cpp
+++ b/modules/sample.cpp
@@ -273,14 +273,15 @@ class CSampleMod : public CModule {
 
         return CONTINUE;
     }
-
+    // Appends "Sample:" to an outgoing message and colors it red.
     EModRet OnUserMsg(CString& sTarget, CString& sMessage) override {
         PutModule("[" + sTarget + "] usermsg [" + sMessage + "]");
         sMessage = "Sample: \0034" + sMessage + "\003";
 
         return CONTINUE;
     }
-
+    
+    // Bolds an incoming message.
     EModRet OnPrivMsg(CNick& Nick, CString& sMessage) override {
         PutModule("[" + Nick.GetNick() + "] privmsg [" + sMessage + "]");
         sMessage = "\002" + sMessage + "\002";