diff --git a/docs/doxygen/mainpages/introduction.h b/docs/doxygen/mainpages/introduction.h index 067575536f..897e3759f7 100644 --- a/docs/doxygen/mainpages/introduction.h +++ b/docs/doxygen/mainpages/introduction.h @@ -124,7 +124,7 @@ And if you have any questions, you can join wxWidgets community using - Web-based wxForum - Mailing lists -- #wxwidgets IRC Channel +- IRC Channel - Or asking questions with @c wxwidgets tag on Stack Overflow: https://stackoverflow.com/questions/tagged/wxwidgets diff --git a/docs/doxygen/mainpages/manual.h b/docs/doxygen/mainpages/manual.h index ef8028addc..02a5ce2dbb 100644 --- a/docs/doxygen/mainpages/manual.h +++ b/docs/doxygen/mainpages/manual.h @@ -24,13 +24,13 @@ developing native cross-platform GUI applications in C++! @n If you are new to wxWidgets, please start with the @subpage page_introduction -"introduction" and follow with the @subpage page_topics "programming guides", -with maybe a look at @subpage page_samples "the samples" as you go. If you are -already familiar with wxWidgets, please read about @subpage -overview_changes_since28 "the changes" in the latest version compared to 2.8 -series. And you can also follow the links in the reference section or jump -directly to the alphabetical list of classes -to find out more about the topic you are interested in. +and follow with the @subpage page_topics, with maybe a look at +@subpage page_samples as you go. If you are already familiar with wxWidgets, +please read about @subpage overview_changes_since28 "the changes" in the latest +version compared to 2.8 series. And you can also follow the links in the +reference section or jump directly to the +alphabetical list of classes to find out more about +the topic you are interested in. @section manual_user User Manual diff --git a/interface/wx/busyinfo.h b/interface/wx/busyinfo.h index 59cd50d5fc..94ee4f74df 100644 --- a/interface/wx/busyinfo.h +++ b/interface/wx/busyinfo.h @@ -33,7 +33,8 @@ This window is rather plain by default but can be customized by passing wxBusyInfo constructor an object of wxBusyInfoFlags class instead of a - simple message. Here is an example from the @ref page_samples_dialogs: + simple message. Here is an example from the dialogs sample: + @code wxBusyInfo info ( @@ -48,7 +49,8 @@ .Transparency(4*wxALPHA_OPAQUE/5) ); @endcode - showing that separate title and text can be set, and that simple markup + + This shows that separate title and text can be set, and that simple markup (@ref wxControl::SetLabelMarkup()) can be used in them, and that it's also possible to add an icon and customize the colours and transparency of the window. diff --git a/interface/wx/html/htmlwin.h b/interface/wx/html/htmlwin.h index cb00713da5..498cecbd6b 100644 --- a/interface/wx/html/htmlwin.h +++ b/interface/wx/html/htmlwin.h @@ -27,7 +27,7 @@ enum wxHtmlOpeningStatus /** @class wxHtmlWindowInterface - + Abstract interface to a HTML rendering window (such as wxHtmlWindow or wxHtmlListBox) that is passed to wxHtmlWinParser. It encapsulates all communication from the parser to the window. @@ -110,22 +110,20 @@ public: /** @class wxHtmlWindow - wxHtmlWindow is probably the only class you will directly use unless you want - to do something special (like adding new tag handlers or MIME filters). + wxHtmlWindow is probably the only class you will directly use unless you + want to do something special (like adding new tag handlers or MIME filters). - The purpose of this class is to display rich content pages (either local file or - downloaded via HTTP protocol) in a window based on a subset of the HTML standard. - The width of the window is constant - given in the constructor - and virtual height - is changed dynamically depending on page size. - Once the window is created you can set its content by calling SetPage() with raw HTML, - LoadPage() with a wxFileSystem location or LoadFile() with a filename. + The purpose of this class is to display rich content pages (either local + file or downloaded via HTTP protocol) in a window based on a subset of the + HTML standard. The width of the window is constant, given in the constructor + and virtual height is changed dynamically depending on page size. Once the + window is created you can set its content by calling SetPage() with raw + HTML, LoadPage() with a wxFileSystem location or LoadFile() with a filename. - @note - If you want complete HTML/CSS support as well as a Javascript engine, see instead - wxWebView. + @note If you want complete HTML/CSS support as well as a Javascript engine, + consider using wxWebView instead. - @note - wxHtmlWindow uses the wxImage class for displaying images, as such you need to + wxHtmlWindow uses the wxImage class for displaying images, so you need to initialize the handlers for any image formats you use before loading a page. See ::wxInitAllImageHandlers and wxImage::AddHandler. @@ -139,7 +137,6 @@ public: Don't allow the user to select text. @endStyleTable - @beginEventEmissionTable{wxHtmlCellEvent, wxHtmlLinkEvent} @event{EVT_HTML_CELL_CLICKED(id, func)} A wxHtmlCell was clicked. @@ -164,6 +161,7 @@ public: /** Constructor. + The parameters are the same as wxScrolled::wxScrolled() constructor. */ wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY, @@ -173,11 +171,16 @@ public: const wxString& name = "htmlWindow"); /** - Adds @ref overview_html_filters "input filter" to the static list of available - filters. These filters are present by default: - - @c text/html MIME type - - @c image/* MIME types - - Plain Text filter (this filter is used if no other filter matches) + Adds an @ref overview_html_filters "input filter" to the static list of + available filters. These filters are present by default: + + @code + text/html + text/plain + image/* + @endcode + + The plain text filter will be used if no other filter matches. */ static void AddFilter(wxHtmlFilter* filter); @@ -390,7 +393,7 @@ public: const int* sizes = NULL); /** - Sets default font sizes and/or default font size. + Sets default font sizes and/or default font size. See wxHtmlDCRenderer::SetStandardFonts for detailed description. @see SetFonts() */ @@ -622,4 +625,3 @@ public: */ void SetLinkClicked(bool linkclicked); }; - diff --git a/interface/wx/nativewin.h b/interface/wx/nativewin.h index c35cc6ac68..b81770bde5 100644 --- a/interface/wx/nativewin.h +++ b/interface/wx/nativewin.h @@ -37,7 +37,7 @@ @since 3.1.0 - @library{core} + @library{wxcore} @category{ctrl} */ class wxNativeWindow : public wxWindow diff --git a/interface/wx/xml/xml.h b/interface/wx/xml/xml.h index 93ed2943fd..8c9c60f1ed 100644 --- a/interface/wx/xml/xml.h +++ b/interface/wx/xml/xml.h @@ -58,7 +58,7 @@ enum wxXmlNodeType If @c wxUSE_UNICODE is 0, all strings are encoded in the encoding given to wxXmlDocument::Load (default is UTF-8). - @Note + @note Once a wxXmlNode has been added to a wxXmlDocument it becomes owned by the document and this has two implications. Firstly, the wxXmlDocument takes responsibility for deleting the node so the user should not @c delete it; @@ -908,4 +908,3 @@ public: */ static wxVersionInfo GetLibraryVersionInfo(); }; -