[vlc-commits] Docs: Minor documentation style fixes

Marvin Scholz git at videolan.org
Fri Mar 23 08:37:43 CET 2018


vlc | branch: master | Marvin Scholz <epirat07 at gmail.com> | Fri Mar 23 08:36:57 2018 +0100| [d374aedfb971c4dc24a9271af535055600529b7b] | committer: Marvin Scholz

Docs: Minor documentation style fixes

Using a # in doxygen at the beginning on a line marks a heading
so this would turn into a huge heading in the actual rendered
documentation which looked weird.

The ? should be right at the end of the sentence without a space.

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=d374aedfb971c4dc24a9271af535055600529b7b
---

 include/vlc_picture.h | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/include/vlc_picture.h b/include/vlc_picture.h
index 5e8c6b4471..7c0d869821 100644
--- a/include/vlc_picture.h
+++ b/include/vlc_picture.h
@@ -48,8 +48,8 @@ typedef struct plane_t
     int i_pixel_pitch;
 
     /* Variables used for pictures with margins */
-    int i_visible_lines;            /**< How many visible lines are there ? */
-    int i_visible_pitch;            /**< How many visible pixels are there ? */
+    int i_visible_lines;            /**< How many visible lines are there? */
+    int i_visible_pitch;            /**< How many visible pixels are there? */
 
 } plane_t;
 
@@ -89,9 +89,9 @@ struct picture_t
      * Those properties can be changed by the decoder
      * @{
      */
-    bool            b_progressive;          /**< is it a progressive frame ? */
+    bool            b_progressive;          /**< is it a progressive frame? */
     bool            b_top_field_first;             /**< which field is first */
-    unsigned int    i_nb_fields;                  /**< # of displayed fields */
+    unsigned int    i_nb_fields;                  /**< number of displayed fields */
     picture_context_t *context;      /**< video format-specific data pointer */
     /**@}*/
 



More information about the vlc-commits mailing list