Fixed doxygen tags in header file documentation comments.
authorPhilipp Wiesemann <philipp.wiesemann@arcor.de>
Sun, 23 Nov 2014 20:46:34 +0100
changeset 9233b8eaf9623c0b
parent 9232 6ab4ae85c41e
child 9234 199baca091f9
Fixed doxygen tags in header file documentation comments.
include/SDL_test_crc32.h
include/SDL_test_fuzzer.h
include/SDL_test_md5.h
     1.1 --- a/include/SDL_test_crc32.h	Sun Nov 23 20:40:48 2014 +0100
     1.2 +++ b/include/SDL_test_crc32.h	Sun Nov 23 20:46:34 2014 +0100
     1.3 @@ -70,27 +70,27 @@
     1.4  /* ---------- Function Prototypes ------------- */
     1.5  
     1.6  /**
     1.7 - * /brief Initialize the CRC context
     1.8 + * \brief Initialize the CRC context
     1.9   *
    1.10   * Note: The function initializes the crc table required for all crc calculations.
    1.11   *
    1.12 - * /param crcContext        pointer to context variable
    1.13 + * \param crcContext        pointer to context variable
    1.14   *
    1.15 - * /returns 0 for OK, -1 on error
    1.16 + * \returns 0 for OK, -1 on error
    1.17   *
    1.18   */
    1.19   int SDLTest_Crc32Init(SDLTest_Crc32Context * crcContext);
    1.20  
    1.21  
    1.22  /**
    1.23 - * /brief calculate a crc32 from a data block
    1.24 + * \brief calculate a crc32 from a data block
    1.25   *
    1.26 - * /param crcContext         pointer to context variable
    1.27 - * /param inBuf              input buffer to checksum
    1.28 - * /param inLen              length of input buffer
    1.29 - * /param crc32              pointer to Uint32 to store the final CRC into
    1.30 + * \param crcContext         pointer to context variable
    1.31 + * \param inBuf              input buffer to checksum
    1.32 + * \param inLen              length of input buffer
    1.33 + * \param crc32              pointer to Uint32 to store the final CRC into
    1.34   *
    1.35 - * /returns 0 for OK, -1 on error
    1.36 + * \returns 0 for OK, -1 on error
    1.37   *
    1.38   */
    1.39  int SDLTest_crc32Calc(SDLTest_Crc32Context * crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32);
    1.40 @@ -102,11 +102,11 @@
    1.41  
    1.42  
    1.43  /**
    1.44 - * /brief clean up CRC context
    1.45 + * \brief clean up CRC context
    1.46   *
    1.47 - * /param crcContext        pointer to context variable
    1.48 + * \param crcContext        pointer to context variable
    1.49   *
    1.50 - * /returns 0 for OK, -1 on error
    1.51 + * \returns 0 for OK, -1 on error
    1.52   *
    1.53  */
    1.54  
     2.1 --- a/include/SDL_test_fuzzer.h	Sun Nov 23 20:40:48 2014 +0100
     2.2 +++ b/include/SDL_test_fuzzer.h	Sun Nov 23 20:46:34 2014 +0100
     2.3 @@ -57,7 +57,7 @@
     2.4  /**
     2.5   * Initializes the fuzzer for a test
     2.6   *
     2.7 - * /param execKey Execution "Key" that initializes the random number generator uniquely for the test.
     2.8 + * \param execKey Execution "Key" that initializes the random number generator uniquely for the test.
     2.9   *
    2.10   */
    2.11  void SDLTest_FuzzerInit(Uint64 execKey);
     3.1 --- a/include/SDL_test_md5.h	Sun Nov 23 20:40:48 2014 +0100
     3.2 +++ b/include/SDL_test_md5.h	Sun Nov 23 20:46:34 2014 +0100
     3.3 @@ -78,9 +78,9 @@
     3.4  /* ---------- Function Prototypes ------------- */
     3.5  
     3.6  /**
     3.7 - * /brief initialize the context
     3.8 + * \brief initialize the context
     3.9   *
    3.10 - * /param  mdContext        pointer to context variable
    3.11 + * \param  mdContext        pointer to context variable
    3.12   *
    3.13   * Note: The function initializes the message-digest context
    3.14   *       mdContext. Call before each new use of the context -
    3.15 @@ -90,11 +90,11 @@
    3.16  
    3.17  
    3.18  /**
    3.19 - * /brief update digest from variable length data
    3.20 + * \brief update digest from variable length data
    3.21   *
    3.22 - * /param  mdContext       pointer to context variable
    3.23 - * /param  inBuf           pointer to data array/string
    3.24 - * /param  inLen           length of data array/string
    3.25 + * \param  mdContext       pointer to context variable
    3.26 + * \param  inBuf           pointer to data array/string
    3.27 + * \param  inLen           length of data array/string
    3.28   *
    3.29   * Note: The function updates the message-digest context to account
    3.30   *       for the presence of each of the characters inBuf[0..inLen-1]
    3.31 @@ -105,10 +105,10 @@
    3.32                   unsigned int inLen);
    3.33  
    3.34  
    3.35 -/*
    3.36 - * /brief complete digest computation
    3.37 +/**
    3.38 + * \brief complete digest computation
    3.39   *
    3.40 - * /param mdContext     pointer to context variable
    3.41 + * \param mdContext     pointer to context variable
    3.42   *
    3.43   * Note: The function terminates the message-digest computation and
    3.44   *       ends with the desired message digest in mdContext.digest[0..15].