Further enhancement to the samples overview page.

Add links to samples sources in svn to all the individual samples and be even
more explicit about their location on the local disk.

Move the paragraph explaining the samples location further below -- but <hr>
still doesn't work somehow.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@63190 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775

diff --git a/docs/doxygen/Doxyfile_inc b/docs/doxygen/Doxyfile_inc
index 60063024eecb79ea3b968722a64c13ea329922b6..b1b79ad92dbb1bbdec59e7c75076116f5b4c4bb0 100644 (file)
--- a/docs/doxygen/Doxyfile_inc
+++ b/docs/doxygen/Doxyfile_inc
@@ -203,8 +203,8 @@ ALIASES += rightCurly="}"
 # Aliases - for use when documenting samples
 #---------------------------------------------------------------------------
 
-# For indicating the a directory containing a sample
-ALIASES += sampledir{1}="\verbatim Location: samples/\1\endverbatim"
+# For indicating a sample location
+ALIASES += sampledir{1}="@e Location: @c samples/\1 subdirectory of your wxWidgets installation or http://svn.wxwidgets.org/viewvc/wx/wxWidgets/trunk/\1"
 
 # For refering to the corresponding sample in a class document or a overview
 # Usually placed in the queue of @see

diff --git a/docs/doxygen/mainpages/samples.h b/docs/doxygen/mainpages/samples.h
index 3fdc9d9e86cdb93d814a08eaced4a23c08a29cfc..fead85090df0c83f39b10e8edba5df4f2d578812 100644 (file)
--- a/docs/doxygen/mainpages/samples.h
+++ b/docs/doxygen/mainpages/samples.h
@@ -8,7 +8,9 @@
 
 /**
 
-@page page_samples Included Samples
+@page page_samples wxWidgets Samples Overview
+
+@brief Overview of the examples provided with wxWidgets.
 
 Probably the best way to learn wxWidgets is by reading the source of some 80+
 samples provided with it. Many aspects of wxWidgets programming can be learnt
@@ -18,17 +20,6 @@ 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.
 
-<hr/>
-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).
-<hr/>
-
 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
@@ -51,10 +42,8 @@ may find the following samples showing the corresponding controls:
 @li wxGrid: @ref page_samples_grid
 @li wxDataViewCtrl: @ref page_samples_dataview
 
-Finally, it might be helpful to do a search in the entire sample directory if
-you can't find the sample showing the control you are interested in by
-name. Most classes contained in wxWidgets occur in at least one of the samples.
 
+Finally, here is the full list of samples:
 <!--
 The following sample list is generated by executing command
 
@@ -151,9 +140,25 @@ TODO: Organize them in a more human-readable way.
 </td></tr>
 @endTable
 
+
+<hr/>
+
+Notice that all wxWidgets samples mentioned above 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).
+
+Final advice is to do a search in the entire samples directory if you can't
+find the sample showing the control you are interested in by name. Most classes
+contained in wxWidgets occur in at least one of the samples.
+
+
 @todo Write descriptions for the samples who description started with
  "This sample demonstrates", they are semi-auto generated.
-<hr>
 
 @section page_samples_access Accessibility Sample