3/22/2023 0 Comments Doxygen method comment* the rights to use, copy, modify, merge, publish, distribute, sublicense, * to deal in the Software without restriction, including without limitation * copy of this software and associated documentation files (the "Software"), * Permission is hereby granted, free of charge, to any person obtaining a #if defined(_cplusplus) // End C compatible block * Append " is epic!\n" to most recently printed text. * Get seconds since the timer was started. * Stop the second timer and reclaim the cog for other uses. * 1 the number of the cog that the process was launched into. * number of times awesome has been called before it was updated by * countVal is the new value of number of times awesome has been called. * how the (at)param and (at)detail formatters can be used. * Set the number of times awesome has been called to some * 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!\n" 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!\n" and " is epic!\n" 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.
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |