wxWidgets / wxWidgets

Cross-Platform C++ GUI Library
https://www.wxwidgets.org/
6.09k stars 1.76k forks source link

Documentation error for wxStaticLine #19403

Closed wxtrac closed 2 years ago

wxtrac commented 24 years ago

Issue migrated from trac ticket # 38

component: documentation | priority: normal

2000-09-26 22:50:36: anonymous created the issue


Bug#: 102 Product: .wxWindows Version: 2.2.0 Platform: All OS/Version: All Status: NEW
Resolution: Severity: critical Priority: P1 Component: docs AssignedTo: ???
ReportedBy: dmishee@flash.net
URL: http://www.lpthe.jussieu.fr/~zeitlin/wxWindows/docs/wxwin319.htm#wxstaticline Summary: Documentation error for wxStaticLine

The documentation for a wxStaticLine has this for the constructor:

wxStaticLine(wxWindow* parent, wxWindowID id, const wxString& label, const wxPoint& pos = wxDefaultPosition, const wxSize& size # wxDefaultSize, long stylewxLI_HORIZONTAL, const wxString& name = "staticLine")

and below, only these parameters are described in this order: parent, id, pos, size, style, name

The documentation is not consistent (a label is called for in the constuctor, but not in the Parameter docs below), so I assumed the constructor documentation was correct and used all the arguments given. It wasn't working correctly in wxPython. I then assumed the Parameter section was accurate and removed the "label" argument and it works.

It appears that the constructor is calling for a "label" argument which is incorrect (or it is incorrectly implemented in wxPython).

I'm not sure if I selected the correct version, so don't quote me on that.

David

wxtrac commented 23 years ago

2000-10-20 17:41:18: @vadz commented


inexisting param desc removed