added comments

1 files changed, 13 insertions, 0 deletions

diff --git a/lib/MiddleWare/Reporter.h b/lib/MiddleWare/Reporter.h
index 76680df..87c46db 100644
--- a/lib/MiddleWare/Reporter.h
+++ b/lib/MiddleWare/Reporter.h
@@ -26,10 +26,23 @@
 #include "Plugin.h"
 #include "CrashTypes.h"
 
+/**
+ * An abstract class. The class defines a reporter plugin interface.
+ */
 class CReporter : public CPlugin
 {
     public:
+        /**
+         * A destructor.
+         */
         virtual ~CReporter() {}
+        /**
+         * A method, which reports a crash report to particular receiver.
+         * The plugin can takes arguments, but the plugin  has to parse them
+         * by itself.
+         * @param pCrashReport A crash report.
+         * @param pArgs Plugin's arguments.
+         */
         virtual void Report(const map_crash_report_t& pCrashReport,
                             const std::string& pArgs) = 0;
 };