Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Doxygen topic overview cleanups.

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52088 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-02-25 10:50:43 +00:00
parent ed8c374dd7
commit 728449503c
4 changed files with 825 additions and 1365 deletions
Download Patch File Download Diff File Expand all files Collapse all files

37
docs/doxygen/overviews/referencenotes.h
View File

@@ -1,5 +1,5 @@
/////////////////////////////////////////////////////////////////////////////
// Name: referencenotes
// Name: referencenotes.h
// Purpose: topic overview
// Author: wxWidgets team
// RCS-ID: $Id$
@@ -8,25 +8,24 @@
/*!
@page referencenotes_overview Notes on using the reference
@page overview_referencenotes 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.
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.
*/