[wxWidgets.git] / docs / doxygen / overviews / referencenotes.h

/////////////////////////////////////////////////////////////////////////////
// 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.

 */
Commit	Line	Data
15b6757b FM	1	/////////////////////////////////////////////////////////////////////////////
	2	// Name: referencenotes
	3	// Purpose: topic overview
	4	// Author: wxWidgets team
	5	// RCS-ID: $Id$
	6	// Licence: wxWindows license
	7	/////////////////////////////////////////////////////////////////////////////
	8
	9	/*!
36c9828f	10
15b6757b	11	@page referencenotes_overview Notes on using the reference
36c9828f	12
15b6757b FM	13	In the descriptions of the wxWidgets classes and their member
	14	functions, note that descriptions of inherited member functions are not
	15	duplicated in derived classes unless their behaviour is different. So in
	16	using a class such as wxScrolledWindow, be aware that wxWindow functions may be
	17	relevant.
	18	Note also that arguments with default values may be omitted from a
	19	function call, for brevity. Size and position arguments may usually be
	20	given a value of -1 (the default), in which case wxWidgets will choose a
	21	suitable value.
	22	Most strings are returned as wxString objects. However, for remaining
	23	char * return values, the strings are allocated and
	24	deallocated by wxWidgets. Therefore, return values should always be
	25	copied for long-term use, especially since the same buffer is often
	26	used by wxWidgets.
	27	The member functions are given in alphabetical order except for
	28	constructors and destructors which appear first.
36c9828f	29
15b6757b	30	*/
36c9828f FM	31
36c9828f FM	32