[libbluray-devel] commit: Documented bd_set_player_setting() parameters and return value ( hpi1 )

[git at videolan.org]

libbluray | branch: master | hpi1 <hpi1 at anonymous.org> | Thu Oct  7 14:23:16 2010 +0300| [54b76c8e8dac81a6db900e62192aa923ccd548bb] | committer: hpi1 

Documented bd_set_player_setting() parameters and return value

> http://git.videolan.org/gitweb.cgi/libbluray.git/?a=commit;h=54b76c8e8dac81a6db900e62192aa923ccd548bb
---

 src/libbluray/bluray.h |   10 ++++++++++
 1 files changed, 10 insertions(+), 0 deletions(-)

diff --git a/src/libbluray/bluray.h b/src/libbluray/bluray.h
index ea55a86..aef9509 100644
--- a/src/libbluray/bluray.h
+++ b/src/libbluray/bluray.h
@@ -382,6 +382,16 @@ typedef enum {
     BLURAY_PLAYER_SETTING_PLAYER_PROFILE = 31,  /* Profile1: 0, Profile1+: 1, Profile2: 3, Profile3: 8 */
 } bd_player_setting;
 
+/**
+ *
+ *  Update player setting registers
+ *
+ * @param bd  BLURAY object
+ * @param idx Player setting register
+ * @param value New value for player setting register
+ * @return 1 on success, 0 on error (invalid setting)
+ */
+
 int bd_set_player_setting(BLURAY *bd, uint32_t idx, uint32_t value);
 int bd_set_player_setting_str(BLURAY *bd, uint32_t idx, const char *s);