Peter M. Groen / hueplusplus

Commit b0de8594cd70eac7d23ecbd15e9ef1d3f71575f5

Authored by Jojo-1000
Committed by Moritz Wirger
1 parent efd1ed5e

Add note that Bridge and Group in EntertainmentMode must stay alive.

Inline Side-by-side
Showing 1 changed file with 3 additions and 0 deletions
include/hueplusplus/EntertainmentMode.h
  View file @b0de859
@@ -40,6 +40,9 @@ public: @@ -40,6 +40,9 @@ public:
40 //! 40 //!
41 //! \param b Bridge reference 41 //! \param b Bridge reference
42 //! \param g Group to control in entertainment mode reference 42 //! \param g Group to control in entertainment mode reference
  43 + //!
  44 + //! \note References are held to both \c b and \c g.
  45 + //! They must stay valid until EntertainmentMode ist destroyed.
43 EntertainmentMode(Bridge& b, Group& g); 46 EntertainmentMode(Bridge& b, Group& g);
44 47
45 //! \brief Destroy the Entertainment Mode object 48 //! \brief Destroy the Entertainment Mode object