Difference between revisions of "Code Janitorial"

From VideoLAN Wiki
Jump to navigation Jump to search
Line 5: Line 5:
  
 
  /**************************************************************************  |
 
  /**************************************************************************  |
   * Get the Media descriptor associated with the instance                     | <- This is the function header commentary
+
   * Get the Media descriptor associated with the instance                 *  | <- This is the function header commentary
 
   **************************************************************************/ |
 
   **************************************************************************/ |
 
  libvlc_media_descriptor_t *
 
  libvlc_media_descriptor_t *

Revision as of 12:10, 1 September 2008

Here is some samples janitorial task you can pick up:

Function header

  • The function header commentary isn't uniformed across files. We suggest you to try to tidy this.
/**************************************************************************  |
 * Get the Media descriptor associated with the instance                  *  | <- This is the function header commentary
 **************************************************************************/ |
libvlc_media_descriptor_t *
libvlc_media_instance_get_media_descriptor(
                           libvlc_media_instance_t *p_mi,
                           libvlc_exception_t *p_e )
{
  ...
}