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:
5:27aa2d0891b7
Parent:
4:2e8d7c6d2953
Child:
6:d755c4c56bdd
--- a/Inventory/Ghost/Ghost.h	Mon May 11 17:17:20 2020 +0000
+++ b/Inventory/Ghost/Ghost.h	Mon May 11 17:43:49 2020 +0000
@@ -1,3 +1,7 @@
+/** @file Ghost.h
+*   @brief file that contains Ghost functions
+*/ 
+
 // Ensure that the library is not importated twice
 #ifndef GHOST_H
 #define GHOST_H
@@ -9,9 +13,19 @@
 #include <iostream>
 
 // Define a stringvec as a vector of strings
-typedef std::vector<std::string> stringvec;
+/** @typedef test
+*/
+typedef std::vector<std::string> stringvec; 
 
-enum Type {BASIC, ECTO, POLTER, ORB, FUNNEL};
+/** @public test
+* Description
+*/
+enum Type {BASIC, /**< float for x value */
+            ECTO, /**< float for x value */
+            POLTER, /**< float for x value */
+            ORB, /**< float for x value */
+            FUNNEL /**< float for x value */
+            };
 
 /** Ghost Class
  * @brief revision 0.9