]> git.saurik.com Git - wxWidgets.git/blobdiff - docs/doxygen/overviews/referencenotes.h
Don't define __STRICT_ANSI__, we should build both with and without it.
[wxWidgets.git] / docs / doxygen / overviews / referencenotes.h
index 82c2308b6e1212ea66d384cef551d210cd329c21..67ec79163f4cd5d5ae4e04f43a9693b2aacfc0d0 100644 (file)
@@ -2,30 +2,22 @@
 // Name:        referencenotes.h
 // 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
+
+@tableofcontents
 
 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.
 
 */
-