miscellaneous small enhancements

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

diff --git a/docs/doxygen/overviews/referencenotes.h b/docs/doxygen/overviews/referencenotes.h
index ded0bdc1b5054ae7593bdb6575a6afa709c1c3cd..ae538e388b33fed4f81b7b69ad65c036d5c98b75 100644 (file)
--- a/docs/doxygen/overviews/referencenotes.h
+++ b/docs/doxygen/overviews/referencenotes.h
@@ -1,32 +1,23 @@
 /////////////////////////////////////////////////////////////////////////////
-// Name:        referencenotes
+// Name:        referencenotes.h
 // 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.
- 
- */
- 
- 
+/**
+
+@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.
+
+Where not explicitely stated, size and position arguments may usually be given a
+value of ::wxDefaultSize and ::wxDefaultPosition, in which case wxWidgets will
+choose suitable values.
+
+*/
+