REFACTOR: Expanded many parameter names for functions.

DOCS: Corrected comments to match new parameters.
CHORE: Moved some variable definition to top of function call.

include/image/imgio.h

@@ -5,67 +5,66 @@
 
 /**
  * @brief Open and Fill buffer from .ppm file
- * @param [in] file Char pointer use to locate the image to be modified lays.
- * @param [in,out] m_attr PPM pointer to store image information
+ * @param [in] filename Location of the image to be modified
+ * @param [in,out] metadata PPM pointer to store image information
  */
 unsigned int*
-read_ppm(const char* file, PPM* m_attr);
+read_ppm(const char* filename, PPM* metadata);
 
 /**
  * @brief Open and write buffer to file
- * @param [in] buf Information of pixels
- * @param [in] img PPM pointer to store image information
- * @param [in] char Name/Location for file
+ * @param [in] buffer Information of pixels
+ * @param [in] metadata PPM pointer to store image information
+ * @param [in] filename Name/Location for file
  */
 int
-write_ppm(const unsigned int* buf, const PPM img, const char* name);
+write_ppm(const unsigned int* buffer, const PPM metadata, const char* filename);
 
 /**
  * @brief Open and Fill buffer from .jpg file
  * @details Opens a .jpg file, creates a new buffer and extracts the pixels into
  * said buffer as integers.
- * @param [in] file Char pointer use to locate the image to be modified lays.
- * @param [in,out] m_attr JPEG pointer to store image information
+ * @param [in,out] metadata JPEG pointer to store image information
  */
 unsigned int*
-read_jpeg(JPEG* m_attr);
+read_jpeg(JPEG* metadata);
 
 /**
  * @brief Open and write buffer to file
  * @param [in] buf Information of pixels
- * @param [in] attr JPEG pointer to store image information
- * @param [in] char Name/Location for file
+ * @param [in] metadata JPEG pointer to store image information
+ * @param [in] filename Name/Location for file
  */
 int
-write_jpeg(const unsigned int* src_buf, const JPEG* attr, const char* name);
+write_jpeg(const unsigned int* buf, const JPEG* metadata, const char* filename);
 
 /**
  * @brief Converts PPM to JPEG
- * @param [in] in Pointer to PPM container
+ * @param [in] location points to file to use
  */
 void
-transcode_to_jpeg(PPM* in);
+transcode_to_jpeg(const char* location);
 
 /**
  * @brief Converts JPEG to PPM
- * @param [in] in Pointer to JPEG container
+ * @param [in] location Pointer to JPEG container
  */
 void
-transcode_to_ppm(JPEG* in);
+transcode_to_ppm(const char* location);
 
 /**
  * @brief Inherits the attributes from JPEG container
- * @param [in] in Pointer to JPEG container
+ * @param [in] metadata Pointer to JPEG container
  * @param [in] fmt Character for type of PPM image, binary or raw
  */
 PPM
-inherit_from_jpeg(const JPEG* in, const char fmt);
+inherit_from_jpeg(const JPEG* metadata, const char fmt);
 
 /**
  * @brief Inherits the attributes from PPM container
- * @param [in] in Pointer to PPM container
+ * @param [in] metadata Pointer to PPM container
  */
 JPEG
-inherit_from_ppm(const PPM* in);
+inherit_from_ppm(const PPM* metadata);
 
 #endif