| commit | author | age | ||
| d7639a | 1 | /** @file doxygentest.c |
| SP | 2 | @author Samo Penic |
| 3 | @date 4.3.2010 | |
| 4 | */ | |
| 5 | ||
| 6 | #include<stdio.h> | |
| 7 | ||
| 8 | ||
| 9 | /** Defines the number of n/a items */ | |
| 10 | #define N_A 10 | |
| 11 | ||
| 12 | /** @brief Structure that holds some info on three members | |
| 13 | * | |
| 14 | * This detailed description describes the structure more precisely. | |
| 15 | * One member is also extra documented! | |
| 16 | */ | |
| 17 | typedef struct{ | |
| 18 | int i; | |
| 19 | char *a; /**< If you think you don't understand this, add a note to member | |
| 20 | */ | |
| 21 | long *ptr; | |
| 22 | } test; | |
| 23 | ||
| 24 | //typedef t_test test; | |
| 25 | ||
| 26 | /** @brief This is a dummy function to test doxygen documentation | |
| 27 | * | |
| 28 | * Some further explanation of the testfunction comes in the next lines | |
| 29 | * when the brief has been satisfied. | |
| 30 | * @param param1 is an integer | |
| 31 | * @param param2 is a float | |
| 32 | * @return function returns nothing | |
| 33 | * | |
| 34 | * TODO: Still not fully functional algorithm | |
| 35 | */ | |
| 36 | void testfunction(int param1, float param2){ | |
| 37 | ||
| 38 | ||
| 39 | int i; /** This will add an extra line in the documentation block */ | |
| 40 | ||
| 41 | ||
| 42 | } | |
| 43 | ||
| 44 | void main(){ | |
| 45 | test i; | |
| 46 | } | |
