added initial version of the Doxygen manual
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@51901 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
32
docs/doxygen/overviews/referencenotes.h
Normal file
32
docs/doxygen/overviews/referencenotes.h
Normal file
@@ -0,0 +1,32 @@
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
// Name: referencenotes
|
||||
// Purpose: topic overview
|
||||
// Author: wxWidgets team
|
||||
// RCS-ID: $Id$
|
||||
// Licence: wxWindows license
|
||||
/////////////////////////////////////////////////////////////////////////////
|
||||
|
||||
/*!
|
||||
|
||||
@page referencenotes_overview Notes on using the reference
|
||||
|
||||
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.
|
||||
|
||||
*/
|
||||
|
||||
|
Reference in New Issue
Block a user