$title

From 30738aae14dfbce0c492d8696c861947228028c2 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sun, 2 Mar 2008 15:33:26 +0000 Subject: [PATCH] ensure all topic overviews have an horizontal rule with the list of the sections above git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52257 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- docs/doxygen/Doxyfile.all | 2 +- docs/doxygen/Doxyfile.inc | 2 +- docs/doxygen/htmlfooter.inc | 6 ++++-- docs/doxygen/htmlheader.inc | 16 ++++++++-------- docs/doxygen/overviews/app.h | 4 +++- docs/doxygen/overviews/bookctrl.h | 6 ++++++ docs/doxygen/overviews/debugging.h | 7 +++++++ docs/doxygen/overviews/dialog.h | 6 ++++++ docs/doxygen/overviews/font.h | 12 ++++++++---- docs/doxygen/overviews/imagelist.h | 12 ++++++------ docs/doxygen/overviews/internationalization.h | 8 ++++++++ docs/doxygen/overviews/ipc.h | 8 ++++++++ docs/doxygen/overviews/nonenglish.h | 11 +++++++++++ docs/doxygen/overviews/printing.h | 16 ++++++++++++++++ docs/doxygen/overviews/scrolling.h | 6 ++++++ docs/doxygen/overviews/splitterwindow.h | 8 ++++++++ docs/doxygen/overviews/stream.h | 10 ++++++++++ docs/doxygen/overviews/toolbar.h | 9 +++++++++ docs/doxygen/overviews/validator.h | 8 ++++++++ docs/doxygen/overviews/windowdeletion.h | 11 +++++++++++ 20 files changed, 145 insertions(+), 23 deletions(-) diff --git a/docs/doxygen/Doxyfile.all b/docs/doxygen/Doxyfile.all index 889e97f16f..ac69a02814 100644 --- a/docs/doxygen/Doxyfile.all +++ b/docs/doxygen/Doxyfile.all @@ -19,7 +19,7 @@ GENERATE_XML = YES GENERATE_LATEX = NO GENERATE_RTF = NO GENERATE_MAN = NO -GENERATE_PERLMOD = NO +GENERATE_PERLMOD = YES GENERATE_AUTOGEN_DEF = NO GENERATE_TAGFILE = diff --git a/docs/doxygen/Doxyfile.inc b/docs/doxygen/Doxyfile.inc index 3587de6ccb..c441c0dd00 100644 --- a/docs/doxygen/Doxyfile.inc +++ b/docs/doxygen/Doxyfile.inc @@ -305,7 +305,7 @@ XML_PROGRAMLISTING = YES # configuration options related to the Perl module output #--------------------------------------------------------------------------- GENERATE_PERLMOD = NO -PERLMOD_LATEX = NO +PERLMOD_LATEX = YES PERLMOD_PRETTY = YES PERLMOD_MAKEVAR_PREFIX = diff --git a/docs/doxygen/htmlfooter.inc b/docs/doxygen/htmlfooter.inc index 3deabdee31..3b93ff5c1b 100644 --- a/docs/doxygen/htmlfooter.inc +++ b/docs/doxygen/htmlfooter.inc @@ -1,12 +1,14 @@ -

+ +

+ diff --git a/docs/doxygen/htmlheader.inc b/docs/doxygen/htmlheader.inc index 97ccd37a89..36fb2f5ae1 100644 --- a/docs/doxygen/htmlheader.inc +++ b/docs/doxygen/htmlheader.inc @@ -1,17 +1,17 @@ - + - + - + $title - - - - - + + + + + diff --git a/docs/doxygen/overviews/app.h b/docs/doxygen/overviews/app.h index af846a66c3..d44cf7bc58 100644 --- a/docs/doxygen/overviews/app.h +++ b/docs/doxygen/overviews/app.h @@ -12,13 +12,15 @@ Classes: wxApp - + @li @ref overview_app_intro @li @ref overview_app_shutdown

+ @section overview_app_intro Introduction + A wxWidgets application does not have a @e main procedure; the equivalent is the wxApp::OnInit member defined for a class derived from wxApp. diff --git a/docs/doxygen/overviews/bookctrl.h b/docs/doxygen/overviews/bookctrl.h index 961190186b..51fd2c9b04 100644 --- a/docs/doxygen/overviews/bookctrl.h +++ b/docs/doxygen/overviews/bookctrl.h @@ -12,6 +12,12 @@ Classes: wxNotebook, wxListbook, wxChoicebook, wxTreebook, wxToolbook + @li @ref overview_bookctrl_intro + @li @ref overview_bookctrl_bestbookctrl + + +

+ @section overview_bookctrl_intro Introduction diff --git a/docs/doxygen/overviews/debugging.h b/docs/doxygen/overviews/debugging.h index 948b4a5be0..80c447b7a9 100644 --- a/docs/doxygen/overviews/debugging.h +++ b/docs/doxygen/overviews/debugging.h @@ -19,6 +19,13 @@ defined. You can also test the __WXDEBUG__ symbol in your own applications to execute code that should be active only in debug mode. + @li @ref overview_debugging_dbgctx + @li @ref overview_debugging_dbgmacros + @li @ref overview_debugging_logging + @li @ref overview_debugging_dbgctx2 + + +

@section overview_debugging_dbgctx wxDebugContext diff --git a/docs/doxygen/overviews/dialog.h b/docs/doxygen/overviews/dialog.h index 00f07aa906..691736e40b 100644 --- a/docs/doxygen/overviews/dialog.h +++ b/docs/doxygen/overviews/dialog.h @@ -28,6 +28,12 @@ member functions. Validation of data in controls is covered in @ref overview_validator. + @li @ref overview_dialog_autoscrolling + + +

+ + @section overview_dialog_autoscrolling Automatic scrolling dialogs diff --git a/docs/doxygen/overviews/font.h b/docs/doxygen/overviews/font.h index 5ed37b530f..6a9367911d 100644 --- a/docs/doxygen/overviews/font.h +++ b/docs/doxygen/overviews/font.h @@ -12,6 +12,14 @@ Class: wxFont, wxFontDialog + @li @ref overview_font_intro + @li @ref overview_font_nativeinfo + +

+ + + @section overview_font_intro Introduction + A font is an object which determines the appearance of text, primarily when drawing text to a window or device context. A font is determined by the following parameters (not all of them have to be specified, of course): @@ -53,10 +61,6 @@ current mapping mode. However, user scaling on a device context will also scale fonts under both environments. - @li @ref overview_font_nativeinfo - - -

@section overview_font_nativeinfo Native font information diff --git a/docs/doxygen/overviews/imagelist.h b/docs/doxygen/overviews/imagelist.h index 450d452090..8c3cc04304 100644 --- a/docs/doxygen/overviews/imagelist.h +++ b/docs/doxygen/overviews/imagelist.h @@ -1,5 +1,5 @@ ///////////////////////////////////////////////////////////////////////////// -// Name: imagelist +// Name: imagelist.h // Purpose: topic overview // Author: wxWidgets team // RCS-ID: $Id$ @@ -10,15 +10,15 @@ @page imagelist_overview wxImageList overview - Classes: #wxImageList + Classes: wxImageList + An image list is a list of images that may have transparent areas. The class helps an application organise a collection of images so that they can be referenced by integer index instead of by pointer. - Image lists are used in #wxNotebook, - #wxListCtrl, #wxTreeCtrl and - some other control classes. - */ + Image lists are used in wxNotebook, wxListCtrl, wxTreeCtrl and + some other control classes. +*/ diff --git a/docs/doxygen/overviews/internationalization.h b/docs/doxygen/overviews/internationalization.h index 95f9d1677d..6cf281f518 100644 --- a/docs/doxygen/overviews/internationalization.h +++ b/docs/doxygen/overviews/internationalization.h @@ -10,6 +10,14 @@ @page overview_i18n Internationalization +@li @ref overview_i18n_intro +@li @ref overview_i18n_menuaccel + +

+ + +@section overview_i18n_intro Introduction + Although internationalization of an application (i18n for short) involves far more than just translating its text messages to another message - date, time and currency formats need changing too, some languages are written left to diff --git a/docs/doxygen/overviews/ipc.h b/docs/doxygen/overviews/ipc.h index 0013c1803c..26a5fb7096 100644 --- a/docs/doxygen/overviews/ipc.h +++ b/docs/doxygen/overviews/ipc.h @@ -12,6 +12,14 @@ Classes: wxServer, wxConnection, wxClient +@li @ref overview_ipc_datatransfer +@li @ref overview_ipc_examples +@li @ref overview_ipc_dde + + +

+ + wxWidgets has a number of different classes to help with interprocess communication and network programming. This section only discusses one family of classes -- the DDE-like protocol -- but here's a list of other useful diff --git a/docs/doxygen/overviews/nonenglish.h b/docs/doxygen/overviews/nonenglish.h index fbbd4143ba..b1b52d18cc 100644 --- a/docs/doxygen/overviews/nonenglish.h +++ b/docs/doxygen/overviews/nonenglish.h @@ -10,6 +10,17 @@ @page overview_nonenglish Writing Non-English Applications + +@li @ref overview_nonenglish_locales +@li @ref overview_nonenglish_strings +@li @ref overview_nonenglish_fontmapping +@li @ref overview_nonenglish_converting +@li @ref overview_nonenglish_help + + +

+ + This article describes how to write applications that communicate with the user in a language other than English. Unfortunately many languages use different charsets under Unix and Windows (and other platforms, to make the situation diff --git a/docs/doxygen/overviews/printing.h b/docs/doxygen/overviews/printing.h index de21b4b77b..d0748be8c0 100644 --- a/docs/doxygen/overviews/printing.h +++ b/docs/doxygen/overviews/printing.h @@ -22,6 +22,22 @@ Classes: @li wxPageSetupDialog @li wxPageSetupDialogData + +@li @ref overview_printing_printout +@li @ref overview_printing_printer +@li @ref overview_printing_printpreview +@li @ref overview_printing_printerdc +@li @ref overview_printing_postscriptdc +@li @ref overview_printing_printdialog +@li @ref overview_printing_printdata +@li @ref overview_printing_printdialogdata +@li @ref overview_printing_pagesetupdialog +@li @ref overview_printing_pagesetupdialogdata + + +

+ + The printing framework relies on the application to provide classes whose member functions can respond to particular requests, such as 'print this page' or 'does this page exist in the document?'. This method allows wxWidgets to diff --git a/docs/doxygen/overviews/scrolling.h b/docs/doxygen/overviews/scrolling.h index 1c1eb43164..fd3f066020 100644 --- a/docs/doxygen/overviews/scrolling.h +++ b/docs/doxygen/overviews/scrolling.h @@ -15,6 +15,12 @@ Classes: @li wxScrolledWindow @li wxScrollBar +@li @ref overview_scrolling_model +@li @ref overview_scrolling_example + +

+ + Scrollbars come in various guises in wxWidgets. All windows have the potential to show a vertical scrollbar and/or a horizontal scrollbar: it is a basic capability of a window. However, in practice, not all windows do make use of diff --git a/docs/doxygen/overviews/splitterwindow.h b/docs/doxygen/overviews/splitterwindow.h index 6be2e69faf..401f4fb831 100644 --- a/docs/doxygen/overviews/splitterwindow.h +++ b/docs/doxygen/overviews/splitterwindow.h @@ -12,6 +12,14 @@ Classes: wxSplitterWindow +@li @ref overview_splitterwindow_appearance +@li @ref overview_splitterwindow_example + +

+ + +@section overview_splitterwindow_appearance Appearance + The following screenshot shows the appearance of a splitter window with a horizontal split. diff --git a/docs/doxygen/overviews/stream.h b/docs/doxygen/overviews/stream.h index 57097edc67..a10b5357ef 100644 --- a/docs/doxygen/overviews/stream.h +++ b/docs/doxygen/overviews/stream.h @@ -18,6 +18,15 @@ Classes: @li wxFilterInputStream @li wxFilterOutputStream +@li @ref overview_stream_intro +@li @ref overview_stream_example + +

+ + + +@section overview_stream_intro Introduction + Standard C++ streams can cause problems on several platforms: they work quite well in most cases, but in the multi-threaded case, for example, they have many problems. Some Borland compilers refuse to work at all with them and using @@ -58,6 +67,7 @@ nothing in the case of wxMemoryIn/OutputStream which bases itself on wxStreamBuffer. This could also be a simple link to the a true syscall (for example read(...), write(...)). + @section overview_stream_example Example Usage is simple. We can take the example of wxFileInputStream and here is some diff --git a/docs/doxygen/overviews/toolbar.h b/docs/doxygen/overviews/toolbar.h index 4acbb584a8..0cf9bc355e 100644 --- a/docs/doxygen/overviews/toolbar.h +++ b/docs/doxygen/overviews/toolbar.h @@ -12,6 +12,15 @@ Classes: wxToolBar +@li @ref overview_toolbar_intro +@li @ref overview_toolbar_library + + +

+ + +@section overview_toolbar_intro Introduction + The toolbar family of classes allows an application to use toolbars in a variety of configurations and styles. diff --git a/docs/doxygen/overviews/validator.h b/docs/doxygen/overviews/validator.h index 4d36ff2fe4..97094c9cb3 100644 --- a/docs/doxygen/overviews/validator.h +++ b/docs/doxygen/overviews/validator.h @@ -24,6 +24,14 @@ data transfer, validation and filtering) and wxGenericValidator (which does data transfer for a range of controls); or you can write your own. +@li @ref overview_validator_example +@li @ref overview_validator_anatomy +@li @ref overview_validator_dialogs + + +

+ + @section overview_validator_example Example Here is an example of wxTextValidator usage. diff --git a/docs/doxygen/overviews/windowdeletion.h b/docs/doxygen/overviews/windowdeletion.h index 420b4c1664..72d4123ea6 100644 --- a/docs/doxygen/overviews/windowdeletion.h +++ b/docs/doxygen/overviews/windowdeletion.h @@ -16,6 +16,17 @@ Window deletion can be a confusing subject, so this overview is provided to help make it clear when and how you delete windows, or respond to user requests to close windows. +@li @ref overview_windowdeletion_sequence +@li @ref overview_windowdeletion_close +@li @ref overview_windowdeletion_default +@li @ref overview_windowdeletion_menuexit +@li @ref overview_windowdeletion_exitapp +@li @ref overview_windowdeletion_deletion +@li @ref overview_windowdeletion_windowkinds + + +

+ @section overview_windowdeletion_sequence Sequence of Events During Window Deletion -- 2.47.2

- +	Page generated `$datetime` by Doxygen $doxygenversion