include: A ton of little documentation tweaks, fixes, and improvements.

This is just stuff I noticed while working on the wikiheaders updates. A
thorough pass over all the docs would not be terrible, and maybe a simple
script to check for consistency (does everything have a `\since` on it? etc)
might be nice, too.
This commit is contained in:
Ryan C. Gordon
2024-04-08 22:36:57 -04:00
parent 645073961d
commit ad090d2444
45 changed files with 1565 additions and 833 deletions

View File

@@ -60,7 +60,7 @@ extern "C" {
#define CRC32_POLY 0xEDB88320 /* Perl String::CRC32 compatible */
#endif
/**
/*
* Data structure for CRC32 (checksum) computation
*/
typedef struct SDLTest_Crc32Context {
@@ -69,7 +69,7 @@ extern "C" {
/* ---------- Function Prototypes ------------- */
/**
/*
* Initialize the CRC context
*
* Note: The function initializes the crc table required for all crc calculations.
@@ -82,7 +82,7 @@ extern "C" {
int SDLTest_Crc32Init(SDLTest_Crc32Context *crcContext);
/**
/*
* calculate a crc32 from a data block
*
* \param crcContext pointer to context variable
@@ -101,7 +101,7 @@ int SDLTest_Crc32CalcEnd(SDLTest_Crc32Context *crcContext, CrcUint32 *crc32);
int SDLTest_Crc32CalcBuffer(SDLTest_Crc32Context *crcContext, CrcUint8 *inBuf, CrcUint32 inLen, CrcUint32 *crc32);
/**
/*
* clean up CRC context
*
* \param crcContext pointer to context variable