[kde-doc-english] [Bug 130934] New: Vagueness in description of KWin::windowInfo() method

[Max Dmitrichenko]

------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
         
http://bugs.kde.org/show_bug.cgi?id=130934         
           Summary: Vagueness in description of KWin::windowInfo() method
           Product: docs
           Version: unspecified
          Platform: unspecified
        OS/Version: Linux
            Status: UNCONFIRMED
          Severity: wishlist
          Priority: NOR
         Component: general
        AssignedTo: kde-doc-english kde org
        ReportedBy: dmitrmax rain ifmo ru


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.