// *** Select any of the comment styles below for structures ********** /*! * @brief A simple structure typedef for storing a 2-D vector * * Add a longer description after the brief statement if needed. * (Be sure to separate it from the brief statement with a blank line.) * Notice how the structure elements are described. You can use the C++ * comment style, or go with the C comment style. * * In this example, a structure is used to define a new data type * "COORDINATE_T" */ typedef struct coordinate { float x, //!< The x-coordinate float y //!< The y-coordinate. I think these //!< comments can span multiple lines. } COORDINATE_T; /*! * @brief A structure for storing a color * * Here's a second example using C-style comments to describe the * parameters. (This detailed part of the comment block is optional, * and probably isn't needed for all structures. */ typedef struct mycolor { float red, /*!< The red component of the color described here with an multi-line description */ float green, /*!< Green intensity */ float blue /*!< Blue intensity */ } COLOR_T; /*! * @brief Structure for a single pixel at some location */ struct My_pixel { COORDINATE_T where, //!< Pixel Location COLOR_T whatcolor //!< Pixel value };