Index: ffmpeg_wrapper/ffmpeg_wrapper.module
===================================================================
RCS file: /cvs/drupal-contrib/contributions/modules/ffmpeg_wrapper/ffmpeg_wrapper.module,v
retrieving revision 1.1.2.24
diff -u -r1.1.2.24 ffmpeg_wrapper.module
--- ffmpeg_wrapper/ffmpeg_wrapper.module	30 Oct 2008 19:33:08 -0000	1.1.2.24
+++ ffmpeg_wrapper/ffmpeg_wrapper.module	4 Nov 2008 16:23:59 -0000
@@ -2,9 +2,11 @@
 
 /* $Id: ffmpeg_wrapper.module,v 1.1.2.24 2008/10/30 19:33:08 arthuregg Exp $ */
 
-// This implements a wrapper for FFmpeg so that we don't have to reinvent the 
-// the wheel everytime we want to do soemthing with video, audio, or images
-
+/**
+ * @file
+ * This implements a wrapper for FFmpeg so that we don't have to reinvent the 
+ * the wheel everytime we want to do soemthing with video, audio, or images
+ */
 
 /* ************************************************ */
 /* DRUPAL HOOKS */
@@ -142,11 +144,16 @@
 /* ************************************************ */
 
 /**
- * gets data from ffmpeg
- * @param string $options are the options to run ffmpeg with
- * @param boolean $error_check runs error checking on the output
- * @param string $path overrides the system settings
- * @return output of the command
+ * Get data from ffmpeg.
+ * 
+ * @param $options
+ *   The options to run ffmpeg with.
+ * @param $error_check
+ *   If TRUE, runs error checking on the output.
+ * @param $path 
+ *   Overrides the system settings.
+ * @return
+ *   Output of the command.
  */
 function ffmpeg_wrapper_run_command($options, $error_check = true, $path = '') {
   if (! $path) {
@@ -391,11 +398,12 @@
 
 
 /**
- * builds the output rates for each type of bit rate that 
- * ffmpeg offers
+ * Build the output rates for each type of bit rate that ffmpeg offers.
  *
- * @param string $type
- * @return array of key values
+ * @param $type
+ *   Type of bit rate: "ab", "ar", "fps" or "br".
+ * @return
+ *   Array of key values.
  */
 function ffmpeg_wrapper_output_rates($type) {
 	static $rates;	
@@ -667,12 +675,14 @@
 /* ************************************************** */
 
 /**
- * takes an output format, returns an array of configuration
- * options. This is a hand built list. Will return default options
- * below to preserver form integrity while switching things
- * @param string $output
- *   this is an output type (eg: flv, avi, mp4, etc)
- * @return string
+ * Take an output format and return an array of configuration options.
+ * This is a hand built list. Will return default options below to preserve
+ * form integrity while switching things.
+ * 
+ * @param $output
+ *   An output type (eg: flv, avi, mp4, etc).
+ * @return
+ *   Array of configuration options.
  */ 
 function ffmpeg_wrapper_output_rules($output) {
 	// check to see if we have a configuration for this
