D23915: Add some docstrings
romangg accepted this revision. romangg added inline comments. This revision is now accepted and ready to land. INLINE COMMENTS > zzag wrote in dpms.h:44 > Not sure that this is valid documentation for org_kde_kwin_dpms_manager > because it's nothing more but a factory. Yea, maybe just write that this class is meant to create the DPMS object below only. You already have the information you provided here there then. > zzag wrote in dpms_interface.h:38-41 > While it's sort of true, I don't think it's valid description. The line above > precisely describes what DpmsManagerInterface is. Not sure why it should not be valid. Maybe add that the code interaction //server-side// happens only via the OutputInterface. Because client-side in KWayland the respective Dpms class provides the API. REPOSITORY R127 KWayland BRANCH master REVISION DETAIL https://phabricator.kde.org/D23915 To: gladhorn, #kwin, romangg Cc: romangg, zzag, kde-frameworks-devel, LeGast00n, GB_2, michaelh, ngraham, bruns
D23915: Add some docstrings
zzag added inline comments. INLINE COMMENTS > dpms.h:44 > * > + * Display Power Management Signaling allows power management for monitors. > + * Not sure that this is valid documentation for org_kde_kwin_dpms_manager because it's nothing more but a factory. > dpms_interface.h:38-41 > + * Display Power Management Signaling allows power management for monitors. > + * A DpmsManagerInterface allows a client to query the DPMS state > + * on a given OutputInterface and request changes to it. > + * The code interaction happens only via the OutputInterface. While it's sort of true, I don't think it's valid description. The line above precisely describes what DpmsManagerInterface is. REPOSITORY R127 KWayland REVISION DETAIL https://phabricator.kde.org/D23915 To: gladhorn, #kwin Cc: zzag, kde-frameworks-devel, LeGast00n, GB_2, michaelh, ngraham, bruns
D23915: Add some docstrings
gladhorn created this revision. gladhorn added a reviewer: KWin. Herald added a project: Frameworks. Herald added a subscriber: kde-frameworks-devel. gladhorn requested review of this revision. REVISION SUMMARY When first reading the KWayland code, some explanations help getting around. REPOSITORY R127 KWayland BRANCH master REVISION DETAIL https://phabricator.kde.org/D23915 AFFECTED FILES src/client/datadevice.h src/client/dpms.h src/server/dpms_interface.h To: gladhorn, #kwin Cc: kde-frameworks-devel, LeGast00n, GB_2, michaelh, ngraham, bruns
