Fix premature truncation of brief descriptions in Doxygen comments.

Don't end the brief description at the first period if it's a period which is
part of "i.e." or "e.g.": escape the space following it to prevent Doxygen
from recognizing it as an end of sentence.

See #14866.

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@73084 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Vadim Zeitlin
2012-12-01 00:14:07 +00:00
parent faadbe6f39
commit 0824e36969
41 changed files with 82 additions and 83 deletions

View File

@@ -94,7 +94,7 @@ public:
virtual int FilterEvent(wxEvent& event);
/**
Returns the main event loop instance, i.e. the event loop which is started
Returns the main event loop instance, i.e.\ the event loop which is started
by OnRun() and which dispatches all events sent from the native toolkit
to the application (except when new event loops are temporarily set-up).
The returned value maybe @NULL. Put initialization code which needs a
@@ -245,7 +245,7 @@ public:
static wxAppConsole* GetInstance();
/**
Returns @true if the main event loop is currently running, i.e. if the
Returns @true if the main event loop is currently running, i.e.\ if the
application is inside OnRun().
This can be useful to test whether events can be dispatched. For example,
@@ -260,7 +260,7 @@ public:
//@{
/**
This function is called when an assert failure occurs, i.e. the condition
This function is called when an assert failure occurs, i.e.\ the condition
specified in wxASSERT() macro evaluated to @false.
It is only called in debug mode (when @c __WXDEBUG__ is defined) as
@@ -288,7 +288,7 @@ public:
const wxChar *msg);
/**
Called when command line parsing fails (i.e. an incorrect command line option
Called when command line parsing fails (i.e.\ an incorrect command line option
was specified by the user). The default behaviour is to show the program usage
text and abort the program.
@@ -700,7 +700,7 @@ public:
virtual wxWindow* GetTopWindow() const;
/**
Returns @true if the application is active, i.e. if one of its windows is
Returns @true if the application is active, i.e.\ if one of its windows is
currently in the foreground.
If this function returns @false and you need to attract users attention to