mirror of
https://github.com/libsdl-org/SDL.git
synced 2026-03-20 15:51:07 +01:00
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:
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user