From 187acdec7657079744cef95759542eb6e5453a5e Mon Sep 17 00:00:00 2001 From: Vadim Zeitlin Date: Tue, 19 Jan 2010 13:02:21 +0000 Subject: [PATCH] Explain the location of samples better in the samples overview page. Don't mention controls sample, just the widgets one, as the latter is much richer and easier to understand. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63189 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/mainpages/samples.h | 19 ++++++++++++++++--- 1 file changed, 16 insertions(+), 3 deletions(-) diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h index 8763fc2110..3fdc9d9e86 100644 --- a/docs/doxygen/mainpages/samples.h +++ b/docs/doxygen/mainpages/samples.h @@ -18,6 +18,17 @@ make it easier to find the relevant one if a simple grep through all sources didn't help. They also provide some notes about using the samples and what features of wxWidgets are they supposed to test. +
+Notice that all wxWidgets samples mentioned here can be found in @c samples +subdirectory of the library distribution. When a @c foobar sample is mentioned +below, its sources can be found in @c samples/foobar directory of your +wxWidgets tree. If you installed wxWidgets from a binary package, you might not +have this directory. In this case, you may view the samples online at +http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/samples/ but you need to +download the source distribution in order to be able to build them (highly +recommended). +
+ There are currently more than 80 different samples as part of wxWidgets: the list in this page is not complete! You should start your tour of wxWidgets with the @ref page_samples_minimal @@ -25,9 +36,11 @@ which is the wxWidgets version of "Hello, world!". It shows the basic structure of wxWidgets program and is the most commented sample of all - looking at its source code is recommended. -The next most useful samples are probably @ref page_samples_widgets and -@ref page_samples_controls which show many of wxWidgets native and -generic controls, such as buttons, listboxes, checkboxes, comboboxes etc. +The next most useful sample is @ref page_samples_widgets which shows many of +wxWidgets controls, such as buttons, text entry zones, list boxes, check boxes, +combo boxes etc. It is organized in many different source files, one per each +control, which makes it easier to study it, and also allows to change various +control styles and call its methods interactively. Other, more complicated controls, have their own samples. In this category you may find the following samples showing the corresponding controls: -- 2.50.0