X-Git-Url: https://git.saurik.com/wxWidgets.git/blobdiff_plain/880efa2a137ce3e3f39236d0dc85f5d2dacdda12..1d156af3247c862e51a7c62f569a3fd302052a42:/docs/doxygen/overviews/referencenotes.h diff --git a/docs/doxygen/overviews/referencenotes.h b/docs/doxygen/overviews/referencenotes.h index 21dd2d496e..9c6c6a40c4 100644 --- a/docs/doxygen/overviews/referencenotes.h +++ b/docs/doxygen/overviews/referencenotes.h @@ -3,29 +3,21 @@ // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ -// Licence: wxWindows license +// Licence: wxWindows licence ///////////////////////////////////////////////////////////////////////////// /** -@page overview_referencenotes Notes on Using the Reference +@page overview_referencenotes Notes on Using this Reference Manual In the descriptions of the wxWidgets classes and their member functions, note that descriptions of inherited member functions are not duplicated in derived classes unless their behaviour is different. So in using a class such as wxScrolledWindow, be aware that wxWindow functions may be relevant. -Note also that arguments with default values may be omitted from a function -call, for brevity. Size and position arguments may usually be given a value of --1 (the default), in which case wxWidgets will choose a suitable value. - -Most strings are returned as wxString objects. However, for remaining char * -return values, the strings are allocated and deallocated by wxWidgets. -Therefore, return values should always be copied for long-term use, especially -since the same buffer is often used by wxWidgets. - -The member functions are given in alphabetical order except for constructors -and destructors which appear first. +Where not explicitly stated, size and position arguments may usually be given a +value of ::wxDefaultSize and ::wxDefaultPosition, in which case wxWidgets will +choose suitable values. */