[vlc-commits] text_style: improve clarity of text_style_Create arg documentation

[Lyndon Brown]

vlc | branch: master | Lyndon Brown <jnqnfe at gmail.com> | Wed May  2 08:56:13 2018 +0100| [2af336dfc67210f77a9749170b6f03c90e574004] | committer: Jean-Baptiste Kempf

text_style: improve clarity of text_style_Create arg documentation

Signed-off-by: Jean-Baptiste Kempf <jb at videolan.org>

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

 include/vlc_text_style.h | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/include/vlc_text_style.h b/include/vlc_text_style.h
index 69b67c73e4..4d224208e4 100644
--- a/include/vlc_text_style.h
+++ b/include/vlc_text_style.h
@@ -156,7 +156,11 @@ VLC_API text_style_t * text_style_New( void );
 /**
  * Create a text style
  *
- * Set feature flags as argument if you want to set style defaults
+ * Give STYLE_NO_DEFAULTS as the argument if you want only the zero-filled
+ * object. Give STYLE_FULLY_SET (or anything other than STYLE_NO_DEFAULTS)
+ * if you want an object with sensible defaults. (The value is not stored,
+ * the only effect is to determine whether to return a zero-filled or
+ * sensible-defaults-filled object).
  */
 VLC_API text_style_t * text_style_Create( int );