]> git.saurik.com Git - wxWidgets.git/blame - docs/doxygen/overviews/referencenotes.h
fix many doxygen warnings; added wxMotif section in platdetails (at the very least...
[wxWidgets.git] / docs / doxygen / overviews / referencenotes.h
CommitLineData
15b6757b 1/////////////////////////////////////////////////////////////////////////////
72844950 2// Name: referencenotes.h
15b6757b
FM
3// Purpose: topic overview
4// Author: wxWidgets team
5// RCS-ID: $Id$
6// Licence: wxWindows license
7/////////////////////////////////////////////////////////////////////////////
8
880efa2a 9/**
36c9828f 10
72844950 11@page overview_referencenotes Notes on Using the Reference
36c9828f 12
72844950
BP
13In the descriptions of the wxWidgets classes and their member functions, note
14that descriptions of inherited member functions are not duplicated in derived
15classes unless their behaviour is different. So in using a class such as
16wxScrolledWindow, be aware that wxWindow functions may be relevant.
17
18Note also that arguments with default values may be omitted from a function
19call, for brevity. Size and position arguments may usually be given a value of
20-1 (the default), in which case wxWidgets will choose a suitable value.
21
22Most strings are returned as wxString objects. However, for remaining char *
23return values, the strings are allocated and deallocated by wxWidgets.
24Therefore, return values should always be copied for long-term use, especially
25since the same buffer is often used by wxWidgets.
26
27The member functions are given in alphabetical order except for constructors
28and destructors which appear first.
29
30*/
36c9828f 31