From: Bryan Petty Date: Tue, 26 Feb 2008 18:37:50 +0000 (+0000) Subject: More doxygen overview cleanup. X-Git-Url: https://git.saurik.com/wxWidgets.git/commitdiff_plain/721a49c7159ec04e777459a36fb0b1c5b37a9f4b More doxygen overview cleanup. git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52128 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- diff --git a/docs/doxygen/overviews/resyntax.h b/docs/doxygen/overviews/resyntax.h index 65e2bf29c4..95407e5ad9 100644 --- a/docs/doxygen/overviews/resyntax.h +++ b/docs/doxygen/overviews/resyntax.h @@ -323,7 +323,7 @@ specific conditions are met, written as an escape: @endTable A word is defined as in the specification of [[:@<:]] and -[[:>:]] above. Constraint escapes are illegal within bracket +[[:@>:]] above. Constraint escapes are illegal within bracket expressions. A back reference (AREs only) matches the same string matched by the @@ -343,103 +343,67 @@ back reference), and otherwise is taken as octal. @section overview_resyntax_metasyntax Metasyntax -In addition to the main syntax described above, -there are some special forms and miscellaneous syntactic facilities available. +In addition to the main syntax described above, there are some special forms +and miscellaneous syntactic facilities available. + Normally the flavor of RE being used is specified by application-dependent means. However, this can be overridden by a @e director. If an RE of any flavor -begins with '@b ***:', the rest of the RE is an ARE. If an RE of any flavor begins -with '@b ***=', the rest of the RE is taken to be a literal string, with all -characters considered ordinary characters. -An ARE may begin with @e embedded options: a sequence @b (?xyz) -(where @e xyz is one or more alphabetic characters) -specifies options affecting the rest of the RE. These supplement, and can -override, any options specified by the application. The available option -letters are: - - - -@b b - -rest of RE is a BRE - -@b c - -case-sensitive matching (usual default) - -@b e - -rest of RE is an ERE - -@b i - -case-insensitive matching (see #Matching, below) - -@b m - -historical synonym for @b n - -@b n - -newline-sensitive matching (see #Matching, below) - -@b p - -partial newline-sensitive matching (see #Matching, below) +begins with ***:, the rest of the RE is an ARE. If an RE of any +flavor begins with ***=, the rest of the RE is taken to be a literal +string, with all characters considered ordinary characters. -@b q - -rest of RE -is a literal ("quoted'') string, all ordinary characters - -@b s - -non-newline-sensitive matching (usual default) - -@b t - -tight syntax (usual default; see below) - -@b w - -inverse -partial newline-sensitive ("weird'') matching (see #Matching, below) - -@b x - -expanded syntax (see below) - - - -Embedded options take effect at the @b ) terminating the -sequence. They are available only at the start of an ARE, and may not be -used later within it. -In addition to the usual (@e tight) RE syntax, in which -all characters are significant, there is an @e expanded syntax, available -in AREs with the embedded -x option. In the expanded syntax, white-space characters are ignored and -all characters between a @b # and the following newline (or the end of the -RE) are ignored, permitting paragraphing and commenting a complex RE. There -are three exceptions to that basic rule: - - -a white-space character or '@b #' preceded -by '@b \' is retained -white space or '@b #' within a bracket expression is retained -white space and comments are illegal within multi-character symbols like -the ARE '@b (?:' or the BRE '@b \(' +An ARE may begin with embedded options: a sequence (?xyz) +(where @e xyz is one or more alphabetic characters) specifies options affecting +the rest of the RE. These supplement, and can override, any options specified +by the application. The available option letters are: +@beginTable +@row2col{ b , Rest of RE is a BRE. } +@row2col{ c , Case-sensitive matching (usual default). } +@row2col{ e , Rest of RE is an ERE. } +@row2col{ i , Case-insensitive matching (see + @ref overview_resyntax_matching, below). } +@row2col{ m , Historical synonym for @e n. } +@row2col{ n , Newline-sensitive matching (see + @ref overview_resyntax_matching, below). } +@row2col{ p , Partial newline-sensitive matching (see + @ref overview_resyntax_matching, below). } +@row2col{ q , Rest of RE is a literal ("quoted") string, all ordinary + characters. } +@row2col{ s , Non-newline-sensitive matching (usual default). } +@row2col{ t , Tight syntax (usual default; see below). } +@row2col{ w , Inverse partial newline-sensitive ("weird") matching + (see @ref overview_resyntax_matching, below). } +@row2col{ x , Expanded syntax (see below). } +@endTable -Expanded-syntax white-space characters are blank, -tab, newline, and any character that belongs to the @e space character class. -Finally, in an ARE, outside bracket expressions, the sequence '@b (?#ttt)' (where -@e ttt is any text not containing a '@b )') is a comment, completely ignored. Again, -this is not allowed between the characters of multi-character symbols like -'@b (?:'. Such comments are more a historical artifact than a useful facility, -and their use is deprecated; use the expanded syntax instead. -@e None of these -metasyntax extensions is available if the application (or an initial @b ***= -director) has specified that the user's input be treated as a literal string -rather than as an RE. +Embedded options take effect at the ) terminating the sequence. They +are available only at the start of an ARE, and may not be used later within it. + +In addition to the usual (@e tight) RE syntax, in which all characters are +significant, there is an @e expanded syntax, available in AREs with the +embedded x option. In the expanded syntax, white-space characters are ignored +and all characters between a @# and the following newline (or the end +of the RE) are ignored, permitting paragraphing and commenting a complex RE. +There are three exceptions to that basic rule: + +@li A white-space character or @# preceded by @\ is retained. +@li White space or @# within a bracket expression is retained. +@li White space and comments are illegal within multi-character symbols like + the ARE (?: or the BRE \(. + +Expanded-syntax white-space characters are blank, tab, newline, and any +character that belongs to the @e space character class. + +Finally, in an ARE, outside bracket expressions, the sequence (?@#ttt) +(where @e ttt is any text not containing a )) is a comment, completely +ignored. Again, this is not allowed between the characters of multi-character +symbols like (?:. Such comments are more a historical artifact than a +useful facility, and their use is deprecated; use the expanded syntax instead. + +@e None of these metasyntax extensions is available if the application (or an +initial ***= director) has specified that the user's input be treated +as a literal string rather than as an RE. @section overview_resyntax_matching Matching diff --git a/docs/doxygen/overviews/roughguide.h b/docs/doxygen/overviews/roughguide.h index dbcda42ff1..5aa71e3f36 100644 --- a/docs/doxygen/overviews/roughguide.h +++ b/docs/doxygen/overviews/roughguide.h @@ -10,53 +10,53 @@ @page overview_roughguide Writing a wxWidgets Application: A Rough Guide -To set a wxWidgets application going, you will need to derive a #wxApp class -and override wxApp::OnInit. +To set a wxWidgets application going, you will need to derive a wxApp class and +override wxApp::OnInit. -An application must have a top-level #wxFrame or #wxDialog window. Each frame -may contain one or more instances of classes such as #wxPanel, -#wxSplitterWindow or other windows and controls. +An application must have a top-level wxFrame or wxDialog window. Each frame may +contain one or more instances of classes such as wxPanel, wxSplitterWindow or +other windows and controls. -A frame can have a #wxMenuBar, a #wxToolBar, a status line, and a #wxIcon for -when the frame is iconized. +A frame can have a wxMenuBar, a wxToolBar, a wxStatusBar, and a wxIcon for when +the frame is iconized. -A #wxPanel is used to place controls (classes derived from #wxControl) which -are used for user interaction. Examples of controls are #wxButton, #wxCheckBox, -#wxChoice, #wxListBox, #wxRadioBox, #wxSlider. +A wxPanel is used to place controls (classes derived from wxControl) which are +used for user interaction. Examples of controls are wxButton, wxCheckBox, +wxChoice, wxListBox, wxRadioBox, and wxSlider. -Instances of #wxDialog can also be used for controls and they have the -advantage of not requiring a separate frame. +Instances of wxDialog can also be used for controls and they have the advantage +of not requiring a separate frame. Instead of creating a dialog box and populating it with items, it is possible -to choose one of the convenient common dialog classes, such as #wxMessageDialog -and #wxFileDialog. +to choose one of the convenient common dialog classes, such as wxMessageDialog +and wxFileDialog. You never draw directly onto a window - you use a device context (DC). -#wxDC is the base for #wxClientDC, #wxPaintDC, #wxMemoryDC, #wxPostScriptDC, -#wxMemoryDC, #wxMetafileDC and #wxPrinterDC. If your drawing functions have -wxDC as a parameter, you can pass any of these DCs to the function, and thus -use the same code to draw to several different devices. You can draw using the -member functions of wxDC, such as wxDC::DrawLine and wxDC::DrawText. Control -colour on a window (#wxColour) with brushes (#wxBrush) and pens (#wxPen). +wxDC is the base for wxClientDC, wxPaintDC, wxMemoryDC, wxPostScriptDC, +wxMemoryDC, wxMetafileDC and wxPrinterDC. If your drawing functions have wxDC +as a parameter, you can pass any of these DCs to the function, and thus use the +same code to draw to several different devices. You can draw using the member +functions of wxDC, such as wxDC::DrawLine and wxDC::DrawText. Control colour on +a window (wxColour) with brushes (wxBrush) and pens (wxPen). To intercept events, you add a DECLARE_EVENT_TABLE macro to the window class declaration, and put a BEGIN_EVENT_TABLE ... END_EVENT_TABLE block in the implementation file. Between these macros, you add event macros which map the event (such as a mouse click) to a member function. These might override -predefined event handlers such as for #wxKeyEvent and #wxMouseEvent. +predefined event handlers such as for wxKeyEvent and wxMouseEvent. Most modern applications will have an on-line, hypertext help system; for this, -you need wxHelp and the #wxHelpController class to control wxHelp. +you need wxHelp and the wxHelpController class to control wxHelp. GUI applications aren't all graphical wizardry. List and hash table needs are -catered for by #wxList and #wxHashMap. You will undoubtedly need some +catered for by wxList and wxHashMap. You will undoubtedly need some platform-independent @ref functions_file, and you may find it handy to -maintain and search a list of paths using #wxPathList. There's many +maintain and search a list of paths using wxPathList. There's many @ref functions_miscellany of operating system methods and other functions. @seealso -@li @ref overview_classesbycat +@li @ref page_categories */