DOCS: Added proper documentation to filters(.h, .c)

This commit is contained in:
2026-09-02 14:27:01 -04:00
parent 9310b9c1f2
commit ff25fad5ae
4 changed files with 206 additions and 19 deletions
+3 -3
View File
@@ -115,7 +115,8 @@ typedef struct
/**
* @brief Converts an int to long
* @details Takes in 32-Bit packed color and separates the 4 color values into a
* 64-Bit packed color for JPEG translations.
* 64-Bit packed color. Used for bigger image calculations with one channel and
* then dividing later.
* @param[in] clr Takes a packed color, unsigned int
* @return unsigned long Packed color in 4 ints instead of one
* */
@@ -124,8 +125,7 @@ u32to_u64(const unsigned int clr);
/**
* @brief Converts a long to int
* @details Takes in a full packed color and compresses it back into 1 ints for
* ppm translations.
* @details Takes in a full packed color and compresses it to 1 Byte
* @param[in] clr Takes a packed color, unsigned long
* @param[in] u64_div Takes a divisor to break down to raw color
* @return unsigned int Packed color in 1 int instead of 4