Bug 130934 - Vagueness in description of KWin::windowInfo() method
Summary: Vagueness in description of KWin::windowInfo() method
Status: RESOLVED FIXED
Alias: None
Product: kwin
Classification: Plasma
Component: general (show other bugs)
Version: unspecified
Platform: unspecified Linux
: NOR wishlist
Target Milestone: ---
Assignee: Documentation Editorial Team
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2006-07-16 21:07 UTC by Max Dmitrichenko
Modified: 2006-08-01 11:01 UTC (History)
1 user (show)

See Also:
Latest Commit:
Version Fixed In:
Sentry Crash Report:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Max Dmitrichenko 2006-07-16 21:07:23 UTC
Version:            (using KDE KDE 3.5.3)
Installed from:    Unspecified

KDE API documenation for KWin class contains description of KWin::windowInfo method. It has three parameters: "win", "properties" and "properties2".

Description of "properties" parameter is:
all properties that should be retrieved (see NET::Property enum for details) - passing 0 means all properties. Unlisted properties cause related information to be invalid in the returned data, but make this function faster when not all data is needed.

Description of "properties2" parameter is:
additional properties (see NET::Property2 enum)

Although both of these parameters have default values of zero, zero doesn't mean the same for the "properties2" parameter. Namely, if properties2 is equal to 0, none of these properties are retrieved. I think this should be explicitly stated in the documentation.
Comment 1 Philip Rodrigues 2006-07-17 23:11:34 UTC
Developers tend to handle their own API documentation (the docs team generally doesn't do it), so I'll reassign to kwin.
Comment 2 Lubos Lunak 2006-08-01 11:01:56 UTC
Philip: Just reassigning to another product doesn't help much if you also don't reassign the owner.
Explicitly mentioned in docs for 3.x, 4.x will have neither the 0 default nor the 0 == all meaning.