* number of times awesome has been called since the * Get the number of times awesome has been called.

* count can be accessed by calling awesome_getCount. * append an internal count of number of times awesome was called. * Append ' is awesome! ' to most recently printed text. #if defined(_cplusplus) // Keeps declarations #define AWESOME_H // forward declarations * point is to provide example code for going step-by-step through creating * with some second counting features that run in another cog. * what has been printed last with ' is awesome! ' and ' is epic! ' along * isn’t really all that useful otherwise. * This library was created for the Library Studies tutorial, and Used together, they format the web page so it is easier to read and understand how to use each function in the library.įor a full list of Doxygen formatting flags, see: /** If you have a comment that’s not intended for converting to web documentation, simply start it with /* and Doxygen will ignore it. The /** tells Doxygen to expect keywards with signs in front of them to guide its web page formatting. Each documentation block comment has to start with /**, and end with the customary */. Void awesome(void) // Forward declarationsīelow is the header, revised with comments for the programmer using the library. #include 'simpletools.h' // Requires simpletools

#if defined(_cplusplus) // If compiling for C++ Here is the awesome.h header file we’ve been working with, reorganized alphabetically. This activity demonstrates how to document the functions in the header file so that a software package called Doxygen can automatically create the web page. Each Simple Library comes with a web page that documents its features.

Doxygen example header