@@ -68,25 +68,54 @@ class DSString
6868 };
6969
7070public:
71- // default constructor
71+ /* *
72+ * @brief DSString - default constructor
73+ */
7274 DSString ();
73- // constructor - paramaters: const char* otherData
75+
76+ /* *
77+ * @brief DSString - constructor
78+ * @param data - c-string to turn into string
79+ */
7480 DSString (const char * data);
75- // constructor - paramaters: const DSString& otherData
81+
82+ /* *
83+ * @brief DSString - copy constructor
84+ * @param other - string to copy
85+ */
7686 DSString (const DSString& other);
7787
78- // returns the location of the passed char - parameters: const char searchChar
88+ /* *
89+ * @brief findChar - find the first instance of a character in string
90+ * @param searchChar - character to find
91+ * @return
92+ */
7993 int findChar (const char searchChar) const ;
80- // returns the location of the numInstance instance of the passed char - parameters: const char searchChar, const int numInstance
94+
95+ /* *
96+ * @brief findChar - finds the location of the numInstance instance of the passed char
97+ * @param searchChar - character to search for
98+ * @param numInstance - n'th instance to search for
99+ * @return index of found char
100+ */
81101 int findChar (const char searchChar, const int numInstance) const ;
82102
83- // removes a char from the given index
103+ /* *
104+ * @brief deleteIndex - removes character from given index
105+ * @param index - index in which to remove
106+ */
84107 void deleteIndex (const int index);
85108
86- // default destructor
109+ /* *
110+ * @brief ~DSString - Default destructor
111+ */
87112 ~DSString ();
88113
89- // assignment operator - params: const char* data
114+ /* *
115+ * @brief operator = : assignment operator
116+ * @param data - character array to set this equal to
117+ * @return
118+ */
90119 DSString& operator =(const char * data);
91120 // assignment operator - params: const DSString& other
92121 DSString& operator =(const DSString& other);
0 commit comments