Skip to content

Instantly share code, notes, and snippets.

@fnoble
Last active August 29, 2015 14:16
Show Gist options
  • Save fnoble/09e69946867ad02f02ba to your computer and use it in GitHub Desktop.
Save fnoble/09e69946867ad02f02ba to your computer and use it in GitHub Desktop.
Swift Navigation Doxygen style example
/** Brief description which ends at this dot.
* Details follow here.
*
* \todo Fix the bugs
*
* \param a Description of first argument
* \param b Description of second argument
* \return Descripton of the return value
*/
float lolz(int a, int b)
{
...
}
/** Description of this global. */
int teh_global = 22;
typedef struct {
double x; /**< The x coordinate, in meters */
double y; /**< The y coordinate, in meters */
} point;
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment