Fixed a few Doxygen syntax errors.

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

View File

@@ -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);
};