From 34f7525f311f6865b234e357de030d73f6658458 Mon Sep 17 00:00:00 2001 From: Matt Kohls Date: Wed, 5 Dec 2018 21:16:27 -0500 Subject: Adding comments --- fungi.cpp | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/fungi.cpp b/fungi.cpp index bb3a4b4..3aa70c0 100644 --- a/fungi.cpp +++ b/fungi.cpp @@ -88,8 +88,16 @@ public: ~Fungus() {} + /** + * Get the location of the fungus + * @return The location of the fungus + */ Location getLocation() const { return local; } + /** + * Get the color of the fungus + * @return The color of the fungus + */ Color getColor() const { return color; } }; @@ -115,7 +123,8 @@ private: /** * Brings up all the SDL objects we will need to draw our window - * + * @param winpos The position we want for the window + * @param winsize The size we want for the window */ void init(const Window_Pos& winpos, const Window_Size& winsize) { if (SDL_Init(SDL_INIT_EVERYTHING) != 0){ @@ -146,7 +155,7 @@ private: /** * Draws a fungus on the screen - * + * @param f The fungus we want to draw */ void drawFungus(const Fungus& f) { Color color = f.getColor(); -- cgit v1.2.3