![]() * Configures and initializes some device. Serial.print("Device value: ") Serial.println(value) * The standard Arduino loop function used for repeating tasks. PinMode(Button, INPUT_PULLUP) // utilize microprocessor's internal pull-up resistor While (!Serial) // wait for serial connection Initialize serial bus (Serial Monitor) * The standard Arduino setup function used for setup and configuration tasks. Unsigned long previousTime = 0 ///< The last time something happened. Int buttonCount = 0 ///< The number of times the button was pressed. String name ///< The name of the sensor.įloat value ///< The value of the sensor.Ĭonst byte RedLED = 2 ///< The pin connected to the red LED.Ĭonst byte Button = 3 ///< The pin connected to the momentary push button.Ĭonst float EulersNumber = 2.71828 ///< Euler's number (e). #define SAMPLE_RATE 1 ///< The sensor sampling rate in Hz. #define DEBUG 1 ///< The mode of operation 0 = normal, 1 = debug. * - Don't use Doxygen style formatting inside the body of a function. * - Momentary push button connected to pin D3. * generating source code documentation with Doxygen. * An example sketch demonstrating how to use Doxygen style comments for It contains various types of elements that are common to Arduino sketches, e.g. It is not meant to actually run anything useful on the Arduino itself. This is just an example sketch showing how to go about commenting your source code so that it can be parsed properly by the Doxygen utility. Create and save a sketch named DoxygenExample with the code shown below. In order to generate source code based documentation using Doxygen, we need to have source code for it to use. Test that it is installed correctly by executing the following command within a terminal or command window that will simply print its version number. Once the program is installed, either make sure that it can be found within your executable path or prepend the full directory path upon execution. This installed the doxygen executable into the /usr/local/bin directory on my Mac. Since I am using a Mac and do not plan to use the GUI front end, I chose an alternative approach and installed Doxygen from the command line via the Homebrew package manager using the following command. Please see the Doxygen downloads and installation pages for general installation instructions for your computer platform. ino file extension to the list)įor those of you that would like more detailed instruction, please continue reading. INPUT = (specify sketch directory location). ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |