]> git.saurik.com Git - wxWidgets.git/blame - docs/latex/wx/tusage.tex
remove C++ comment
[wxWidgets.git] / docs / latex / wx / tusage.tex
CommitLineData
a660d684
KB
1\section{Notes on using the reference}\label{referencenotes}
2
fc2171bd 3In the descriptions of the wxWidgets classes and their member
a660d684
KB
4functions, note that descriptions of inherited member functions are not
5duplicated in derived classes unless their behaviour is different. So in
fe604ccd 6using a class such as wxScrolledWindow, be aware that wxWindow functions may be
a660d684
KB
7relevant.
8
9Note also that arguments with default values may be omitted from a
10function call, for brevity. Size and position arguments may usually be
fc2171bd 11given a value of -1 (the default), in which case wxWidgets will choose a
a660d684
KB
12suitable value.
13
14Most strings are returned as wxString objects. However, for remaining
15char * return values, the strings are allocated and
fc2171bd 16deallocated by wxWidgets. Therefore, return values should always be
a660d684 17copied for long-term use, especially since the same buffer is often
fc2171bd 18used by wxWidgets.
a660d684
KB
19
20The member functions are given in alphabetical order except for
21constructors and destructors which appear first.
22