Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fixed a few Doxygen syntax errors.

Browse Source
This commit is contained in:
Bryan Petty
2015-10-31 14:35:30 -06:00
parent 98176fd7ac
commit 18b4bc7dd3
6 changed files with 38 additions and 35 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/doxygen/mainpages/introduction.h
View File

@@ -124,7 +124,7 @@ And if you have any questions, you can join wxWidgets community using
- Web-based <a href="https://forums.wxwidgets.org/">wxForum</a> - Web-based <a href="https://forums.wxwidgets.org/">wxForum</a>
- <a href="https://www.wxwidgets.org/support/mailing-lists/">Mailing lists</a> - <a href="https://www.wxwidgets.org/support/mailing-lists/">Mailing lists</a>
- <a href="https://www.wxwidgets.org/support/irc/">#wxwidgets IRC Channel</a> - <a href="https://www.wxwidgets.org/support/irc/">IRC Channel</a>
- Or asking questions with @c wxwidgets tag on Stack Overflow: - Or asking questions with @c wxwidgets tag on Stack Overflow:
https://stackoverflow.com/questions/tagged/wxwidgets https://stackoverflow.com/questions/tagged/wxwidgets

14
docs/doxygen/mainpages/manual.h
View File

@@ -24,13 +24,13 @@ developing native cross-platform GUI applications in C++!
@n @n
If you are new to wxWidgets, please start with the @subpage page_introduction If you are new to wxWidgets, please start with the @subpage page_introduction
"introduction" and follow with the @subpage page_topics "programming guides", and follow with the @subpage page_topics, with maybe a look at
with maybe a look at @subpage page_samples "the samples" as you go. If you are @subpage page_samples as you go. If you are already familiar with wxWidgets,
already familiar with wxWidgets, please read about @subpage please read about @subpage overview_changes_since28 "the changes" in the latest
overview_changes_since28 "the changes" in the latest version compared to 2.8 version compared to 2.8 series. And you can also follow the links in the
series. And you can also follow the links in the reference section or jump reference section or jump directly to the
directly to the <a href="classes.html">alphabetical list of classes</a> <a href="classes.html">alphabetical list of classes</a> to find out more about
to find out more about the topic you are interested in. the topic you are interested in.
@section manual_user User Manual @section manual_user User Manual

6
interface/wx/busyinfo.h
View File

@@ -33,7 +33,8 @@
This window is rather plain by default but can be customized by passing This window is rather plain by default but can be customized by passing
wxBusyInfo constructor an object of wxBusyInfoFlags class instead of a 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 @code
wxBusyInfo info wxBusyInfo info
( (
@@ -48,7 +49,8 @@
.Transparency(4*wxALPHA_OPAQUE/5) .Transparency(4*wxALPHA_OPAQUE/5)
); );
@endcode @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 (@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 possible to add an icon and customize the colours and transparency of the
window. window.

42
interface/wx/html/htmlwin.h
View File

@@ -110,22 +110,20 @@ public:
/** /**
@class wxHtmlWindow @class wxHtmlWindow
wxHtmlWindow is probably the only class you will directly use unless you want wxHtmlWindow is probably the only class you will directly use unless you
to do something special (like adding new tag handlers or MIME filters). 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 The purpose of this class is to display rich content pages (either local
downloaded via HTTP protocol) in a window based on a subset of the HTML standard. file or downloaded via HTTP protocol) in a window based on a subset of the
The width of the window is constant - given in the constructor - and virtual height HTML standard. The width of the window is constant, given in the constructor
is changed dynamically depending on page size. and virtual height is changed dynamically depending on page size. Once the
Once the window is created you can set its content by calling SetPage() with raw HTML, window is created you can set its content by calling SetPage() with raw
LoadPage() with a wxFileSystem location or LoadFile() with a filename. HTML, LoadPage() with a wxFileSystem location or LoadFile() with a filename.
@note @note If you want complete HTML/CSS support as well as a Javascript engine,
If you want complete HTML/CSS support as well as a Javascript engine, see instead consider using wxWebView instead.
wxWebView.
@note wxHtmlWindow uses the wxImage class for displaying images, so you need to
wxHtmlWindow uses the wxImage class for displaying images, as such you need to
initialize the handlers for any image formats you use before loading a page. initialize the handlers for any image formats you use before loading a page.
See ::wxInitAllImageHandlers and wxImage::AddHandler. See ::wxInitAllImageHandlers and wxImage::AddHandler.
@@ -139,7 +137,6 @@ public:
Don't allow the user to select text. Don't allow the user to select text.
@endStyleTable @endStyleTable
@beginEventEmissionTable{wxHtmlCellEvent, wxHtmlLinkEvent} @beginEventEmissionTable{wxHtmlCellEvent, wxHtmlLinkEvent}
@event{EVT_HTML_CELL_CLICKED(id, func)} @event{EVT_HTML_CELL_CLICKED(id, func)}
A wxHtmlCell was clicked. A wxHtmlCell was clicked.
@@ -164,6 +161,7 @@ public:
/** /**
Constructor. Constructor.
The parameters are the same as wxScrolled::wxScrolled() constructor. The parameters are the same as wxScrolled::wxScrolled() constructor.
*/ */
wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY, wxHtmlWindow(wxWindow *parent, wxWindowID id = wxID_ANY,
@@ -173,11 +171,16 @@ public:
const wxString& name = "htmlWindow"); const wxString& name = "htmlWindow");
/** /**
Adds @ref overview_html_filters "input filter" to the static list of available Adds an @ref overview_html_filters "input filter" to the static list of
filters. These filters are present by default: available filters. These filters are present by default:
- @c text/html MIME type
- @c image/* MIME types @code
- Plain Text filter (this filter is used if no other filter matches) text/html
text/plain
image/*
@endcode
The plain text filter will be used if no other filter matches.
*/ */
static void AddFilter(wxHtmlFilter* filter); static void AddFilter(wxHtmlFilter* filter);
@@ -622,4 +625,3 @@ public:
*/ */
void SetLinkClicked(bool linkclicked); void SetLinkClicked(bool linkclicked);
}; };

2
interface/wx/nativewin.h
View File

@@ -37,7 +37,7 @@
@since 3.1.0 @since 3.1.0
@library{core} @library{wxcore}
@category{ctrl} @category{ctrl}
*/ */
class wxNativeWindow : public wxWindow class wxNativeWindow : public wxWindow

3
interface/wx/xml/xml.h
View File

@@ -58,7 +58,7 @@ enum wxXmlNodeType
If @c wxUSE_UNICODE is 0, all strings are encoded in the encoding given to If @c wxUSE_UNICODE is 0, all strings are encoded in the encoding given to
wxXmlDocument::Load (default is UTF-8). wxXmlDocument::Load (default is UTF-8).
@Note @note
Once a wxXmlNode has been added to a wxXmlDocument it becomes owned by the Once a wxXmlNode has been added to a wxXmlDocument it becomes owned by the
document and this has two implications. Firstly, the wxXmlDocument takes document and this has two implications. Firstly, the wxXmlDocument takes
responsibility for deleting the node so the user should not @c delete it; responsibility for deleting the node so the user should not @c delete it;
@@ -908,4 +908,3 @@ public:
*/ */
static wxVersionInfo GetLibraryVersionInfo(); static wxVersionInfo GetLibraryVersionInfo();
}; };