Code Janitorial: Difference between revisions

From VideoLAN Wiki
Jump to navigation Jump to search
Initial Creation.
 
Line 2: Line 2:


=== Function header ===
=== Function header ===
The code header commentary isn't uniformed across files. We suggest you to try to tidy this.
* 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 )
{
  ...
}

Revision as of 22:22, 7 August 2007

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 )
{
  ...
}