ELEC2645 (2019/20) / Mbed 2 deprecated ELEC2645_Project_el18gs

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

Diff: Inventory/Ghost/Ghost.h

Revision:
6:d755c4c56bdd
Parent:
5:27aa2d0891b7
Child:
7:220d3ebf74cf
--- a/Inventory/Ghost/Ghost.h	Mon May 11 17:43:49 2020 +0000
+++ b/Inventory/Ghost/Ghost.h	Mon May 11 18:14:40 2020 +0000
@@ -1,5 +1,6 @@
 /** @file Ghost.h
-*   @brief file that contains Ghost functions
+*   @brief Ghosts library contains the necessary class, enums and typedefs
+*   @brief to genearate and manipulate .ghost files for the game
 */ 
 
 // Ensure that the library is not importated twice
@@ -13,12 +14,13 @@
 #include <iostream>
 
 // Define a stringvec as a vector of strings
-/** @typedef test
+/** @pulic
+* @var test
 */
 typedef std::vector<std::string> stringvec; 
 
-/** @public test
-* Description
+/** @public Enumerated Type called Type
+* Used to illustrate the type or species of a ghost object
 */
 enum Type {BASIC, /**< float for x value */
             ECTO, /**< float for x value */