Comments

src/GC/lib/event.cpp

@@ -7,27 +7,54 @@
 
 namespace GC
 {
-
+    /**
+     * @returns The type of the event
+    */
     GCEventType GCEvent::get_type()
     {
         return m_type;
     }
 
+    /**
+     * @returns The time the event happened in
+     *          the form of time_t.
+    */
     std::time_t GCEvent::get_time_stamp()
     {
         return m_timestamp;
     }
 
+    /**
+     * If the event is related to a chunk, this
+     * function returns the chunk that it is
+     * related to. If the event is independent
+     * of a chunk, it returns the nullptr.
+     * 
+     * @returns A chunk pointer or the nullptr.
+    */
     const Chunk *GCEvent::get_chunk()
     {
         return m_chunk;
     }
     
+    /**
+     * If the event is an AllocStart event, this
+     * returns the size of the alloc() request.
+     * otherwise this returns 0.
+     * 
+     * @returns A number representing the number
+     *          of bytes requested to alloc()
+     *          or 0 if the event is not an
+     *          AllocStart event.
+    */
     size_t GCEvent::get_size()
     {
         return m_size;
     }
 
+    /**
+     * @returns The string conversion of the event type.
+    */
     const char *GCEvent::type_to_string()
     {
         switch (m_type)