Fixed typos in comments (patch #1515724)

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@39943 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Stefan Neis
2006-07-02 21:40:38 +00:00
parent 331f1e07ce
commit 6a17b868de
10 changed files with 48 additions and 49 deletions

View File

@@ -48,26 +48,26 @@ such as for GTK+ and Motif, you can now build two complete libraries and use
them concurrently. To do this, create a separate directory for each build them concurrently. To do this, create a separate directory for each build
of wxWidgets - you may also want to create different versions of wxWidgets of wxWidgets - you may also want to create different versions of wxWidgets
and test them concurrently. Most typically, this would be a version configured and test them concurrently. Most typically, this would be a version configured
with --enable-debug and one without. Note, that only one build can with --enable-debug and one without. Note, that only one build can currently
currently be installed with 'make install', so you'd have to use local version of be installed with 'make install', so you'd have to use a local version of
the library for that purpose. the library for that purpose.
For building three versions (one GTK+, one Motif and a debug version of the GTK For building three versions (one GTK+, one Motif and a debug version of the GTK
source) you'd do this: source) you'd do this:
md buildmotif mkdir buildmotif
cd buildmotif cd buildmotif
../configure --with-motif ../configure --with-motif
make make
cd .. cd ..
md buildgtk mkdir buildgtk
cd buildgtk cd buildgtk
../configure --with-gtk ../configure --with-gtk
make make
cd .. cd ..
md buildgtkd mkdir buildgtkd
cd buildgtkd cd buildgtkd
../configure --with-gtk --enable-debug ../configure --with-gtk --enable-debug
make make
@@ -82,11 +82,11 @@ during configure run, it usually contains some useful information.
configure reports, that you don't have GTK+ 1.2 installed although you are configure reports, that you don't have GTK+ 1.2 installed although you are
very sure you have. Well, you have installed it, but you also have another very sure you have. Well, you have installed it, but you also have another
version of the GTK+ installed, which you may need to remove including other version of the GTK+ installed, which you may need to remove including other
versions of glib (and its headers). Or maybe you installed it in non default versions of glib (and its headers). Or maybe you installed it in a non-default
location and configure can't find it there, so please check that your PATH location and configure can't find it there, so please check that your PATH
variable includes the path to the correct gtk-config. Also check that your variable includes the path to the correct gtk-config. Also check that your
LD_LIBRARY_PATH or equivalent variable contains the path to GTK+ libraries if LD_LIBRARY_PATH or equivalent variable contains the path to GTK+ libraries if
they were installed in a non default location. they were installed in a non-default location.
You get errors from make: please use GNU make instead of the native make You get errors from make: please use GNU make instead of the native make
program. Currently wxWidgets can be built only with GNU make, BSD make and program. Currently wxWidgets can be built only with GNU make, BSD make and
@@ -210,7 +210,7 @@ Usage:
./configure options ./configure options
If you want to use system's C and C++ compiler, If you want to use system's C and C++ compiler,
set environment variables CC and CCC as set environment variables CC and CXX as
% setenv CC cc % setenv CC cc
% setenv CXX CC % setenv CXX CC

View File

@@ -68,7 +68,7 @@
/* ---------------------------------------------------------------------------- */ /* ---------------------------------------------------------------------------- */
/* Debugging macros */ /* Debugging macros */
/* */ /* */
/* All debugging macros rely on ASSERT() which in turn calls user-defined */ /* All debugging macros rely on ASSERT() which in turn calls the user-defined */
/* OnAssert() function. To keep things simple, it's called even when the */ /* OnAssert() function. To keep things simple, it's called even when the */
/* expression is true (i.e. everything is ok) and by default does nothing: just */ /* expression is true (i.e. everything is ok) and by default does nothing: just */
/* returns the same value back. But if you redefine it to do something more sexy */ /* returns the same value back. But if you redefine it to do something more sexy */
@@ -142,18 +142,18 @@
#define wxFAIL_COND_MSG(cond, msg) \ #define wxFAIL_COND_MSG(cond, msg) \
wxOnAssert(__TFILE__, __LINE__, __WXFUNCTION__, _T(cond), msg) wxOnAssert(__TFILE__, __LINE__, __WXFUNCTION__, _T(cond), msg)
/* an assert helper used to avoid warning when testing constant expressions, */ /* An assert helper used to avoid warning when testing constant expressions, */
/* i.e. wxASSERT( sizeof(int) == 4 ) can generate a compiler warning about */ /* i.e. wxASSERT( sizeof(int) == 4 ) can generate a compiler warning about */
/* expression being always true, but not using */ /* expression being always true, but not using */
/* wxASSERT( wxAssertIsEqual(sizeof(int), 4) ) */ /* wxASSERT( wxAssertIsEqual(sizeof(int), 4) ) */
/* */ /* */
/* NB: this is made obsolete by wxCOMPILE_TIME_ASSERT() and shouldn't be */ /* NB: this is made obsolete by wxCOMPILE_TIME_ASSERT() and should no */
/* used any longer */ /* longer be used. */
extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y); extern bool WXDLLIMPEXP_BASE wxAssertIsEqual(int x, int y);
#else #else
#define wxTrap() #define wxTrap()
/* nothing to do in release modes (hopefully at this moment there are */ /* nothing to do in release mode (hopefully at this moment there are */
/* no more bugs ;-) */ /* no more bugs ;-) */
#define wxASSERT(cond) #define wxASSERT(cond)
#define wxASSERT_MSG(cond, msg) #define wxASSERT_MSG(cond, msg)
@@ -170,11 +170,11 @@
#define wxAssertFailure wxFalse #define wxAssertFailure wxFalse
/* NB: the following macros work also in release mode! */ /* NB: the following macros also work in release mode! */
/* /*
These macros must be used only in invalid situation: for example, an These macros must be used only in invalid situation: for example, an
invalid parameter (NULL pointer) is passed to a function. Instead of invalid parameter (e.g. a NULL pointer) is passed to a function. Instead of
dereferencing it and causing core dump the function might try using dereferencing it and causing core dump the function might try using
CHECK( p != NULL ) or CHECK( p != NULL, return LogError("p is NULL!!") ) CHECK( p != NULL ) or CHECK( p != NULL, return LogError("p is NULL!!") )
*/ */

View File

@@ -35,7 +35,7 @@ enum wxHtmlURLType
}; };
// This class handles generic parsing of HTML document : it scans // This class handles generic parsing of HTML document : it scans
// the document and divide it into blocks of tags (where one block // the document and divides it into blocks of tags (where one block
// consists of starting and ending tag and of text between these // consists of starting and ending tag and of text between these
// 2 tags. // 2 tags.
class WXDLLIMPEXP_HTML wxHtmlParser : public wxObject class WXDLLIMPEXP_HTML wxHtmlParser : public wxObject
@@ -59,7 +59,7 @@ public:
// This method does these things: // This method does these things:
// 1. call InitParser(source); // 1. call InitParser(source);
// 2. call DoParsing(); // 2. call DoParsing();
// 3. call GetProduct(); (it's return value is then returned) // 3. call GetProduct(); (its return value is then returned)
// 4. call DoneParser(); // 4. call DoneParser();
wxObject* Parse(const wxString& source); wxObject* Parse(const wxString& source);
@@ -96,7 +96,7 @@ public:
// <it name="two" value="2"> // <it name="two" value="2">
// </myitems> // </myitems>
// <it> This last it has different meaning, we don't want it to be parsed by myitems handler! // <it> This last it has different meaning, we don't want it to be parsed by myitems handler!
// handler can handle only 'myitems' (e.g. it's GetSupportedTags returns "MYITEMS") // handler can handle only 'myitems' (e.g. its GetSupportedTags returns "MYITEMS")
// you can call PushTagHandler(handler, "IT") when you find <myitems> // you can call PushTagHandler(handler, "IT") when you find <myitems>
// and call PopTagHandler() when you find </myitems> // and call PopTagHandler() when you find </myitems>
void PushTagHandler(wxHtmlTagHandler *handler, const wxString& tags); void PushTagHandler(wxHtmlTagHandler *handler, const wxString& tags);
@@ -107,7 +107,7 @@ public:
wxString* GetSource() {return &m_Source;} wxString* GetSource() {return &m_Source;}
void SetSource(const wxString& src); void SetSource(const wxString& src);
// Sets HTML source and remebers current parser's state so that it can // Sets HTML source and remembers current parser's state so that it can
// later be restored. This is useful for on-line modifications of // later be restored. This is useful for on-line modifications of
// HTML source (for example, <pre> handler replaces spaces with &nbsp; // HTML source (for example, <pre> handler replaces spaces with &nbsp;
// and newlines with <br>) // and newlines with <br>)
@@ -193,7 +193,7 @@ protected:
// Each recognized tag is passed to handler which is capable // Each recognized tag is passed to handler which is capable
// of handling it. Each tag is handled in 3 steps: // of handling it. Each tag is handled in 3 steps:
// 1. Handler will modifies state of parser // 1. Handler will modifies state of parser
// (using it's public methods) // (using its public methods)
// 2. Parser parses source between starting and ending tag // 2. Parser parses source between starting and ending tag
// 3. Handler restores original state of the parser // 3. Handler restores original state of the parser
class WXDLLIMPEXP_HTML wxHtmlTagHandler : public wxObject class WXDLLIMPEXP_HTML wxHtmlTagHandler : public wxObject

View File

@@ -458,7 +458,7 @@ wxToolBar* wxFrameBase::CreateToolBar(long style,
wxWindowID id, wxWindowID id,
const wxString& name) const wxString& name)
{ {
// the main toolbar can't be recreated (unless it was explicitly deeleted // the main toolbar can't be recreated (unless it was explicitly deleted
// before) // before)
wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL, wxCHECK_MSG( !m_frameToolBar, (wxToolBar *)NULL,
wxT("recreating toolbar in wxFrame") ); wxT("recreating toolbar in wxFrame") );

View File

@@ -861,7 +861,7 @@ bool wxFTP::FileExists(const wxString& fileName)
if ( GetList(fileList, fileName, false) ) if ( GetList(fileList, fileName, false) )
{ {
// Some ftp-servers (Ipswitch WS_FTP Server 1.0.5 does this) // Some ftp-servers (Ipswitch WS_FTP Server 1.0.5 does this)
// displays this behaviour when queried on a non-existing file: // displays this behaviour when queried on a nonexistent file:
// NLST this_file_does_not_exist // NLST this_file_does_not_exist
// 150 Opening ASCII data connection for directory listing // 150 Opening ASCII data connection for directory listing
// (no data transferred) // (no data transferred)

View File

@@ -1806,8 +1806,8 @@ size_t wxMBConv_iconv::MB2WC(wchar_t *buf, const char *psz, size_t n) const
} }
#if wxUSE_THREADS #if wxUSE_THREADS
// NB: iconv() is MT-safe, but each thread must use it's own iconv_t handle. // NB: iconv() is MT-safe, but each thread must use its own iconv_t handle.
// Unfortunately there is a couple of global wxCSConv objects such as // Unfortunately there are a couple of global wxCSConv objects such as
// wxConvLocal that are used all over wx code, so we have to make sure // wxConvLocal that are used all over wx code, so we have to make sure
// the handle is used by at most one thread at the time. Otherwise // the handle is used by at most one thread at the time. Otherwise
// only a few wx classes would be safe to use from non-main threads // only a few wx classes would be safe to use from non-main threads
@@ -3385,10 +3385,10 @@ wxMBConv *wxCSConv::DoCreate() const
// NB: This is a hack to prevent deadlock. What could otherwise happen // NB: This is a hack to prevent deadlock. What could otherwise happen
// in Unicode build: wxConvLocal creation ends up being here // in Unicode build: wxConvLocal creation ends up being here
// because of some failure and logs the error. But wxLog will try to // because of some failure and logs the error. But wxLog will try to
// attach timestamp, for which it will need wxConvLocal (to convert // attach a timestamp, for which it will need wxConvLocal (to convert
// time to char* and then wchar_t*), but that fails, tries to log // time to char* and then wchar_t*), but that fails, tries to log the
// error, but wxLog has a (already locked) critical section that // error, but wxLog has an (already locked) critical section that
// guards static buffer. // guards the static buffer.
static bool alreadyLoggingError = false; static bool alreadyLoggingError = false;
if (!alreadyLoggingError) if (!alreadyLoggingError)
{ {

View File

@@ -122,7 +122,7 @@ extern GtkContainerClass *pizza_parent_class;
6) Display a border (sunken, raised, simple or none). 6) Display a border (sunken, raised, simple or none).
Normally one might expect, that one wxWidgets window would always correspond Normally one might expect, that one wxWidgets window would always correspond
to one GTK widget. Under GTK, there is no such allround widget that has all to one GTK widget. Under GTK, there is no such all-round widget that has all
the functionality. Moreover, the GTK defines a client area as a different the functionality. Moreover, the GTK defines a client area as a different
widget from the actual widget you are handling. Last but not least some widget from the actual widget you are handling. Last but not least some
special classes (e.g. wxFrame) handle different categories of widgets and special classes (e.g. wxFrame) handle different categories of widgets and
@@ -167,14 +167,14 @@ extern GtkContainerClass *pizza_parent_class;
clicking on a scrollbar belonging to scrolled window will inevitably move clicking on a scrollbar belonging to scrolled window will inevitably move
the window. In wxWidgets, the scrollbar will only emit an event, send this the window. In wxWidgets, the scrollbar will only emit an event, send this
to (normally) a wxScrolledWindow and that class will call ScrollWindow() to (normally) a wxScrolledWindow and that class will call ScrollWindow()
which actually moves the window and its subchildren. Note that GtkPizza which actually moves the window and its sub-windows. Note that GtkPizza
memorizes how much it has been scrolled but that wxWidgets forgets this memorizes how much it has been scrolled but that wxWidgets forgets this
so that the two coordinates systems have to be kept in synch. This is done so that the two coordinates systems have to be kept in synch. This is done
in various places using the pizza->xoffset and pizza->yoffset values. in various places using the pizza->xoffset and pizza->yoffset values.
III) III)
Singularily the most broken code in GTK is the code that is supposed to Singularly the most broken code in GTK is the code that is supposed to
inform subwindows (child windows) about new positions. Very often, duplicate inform subwindows (child windows) about new positions. Very often, duplicate
events are sent without changes in size or position, equally often no events are sent without changes in size or position, equally often no
events are sent at all (All this is due to a bug in the GtkContainer code events are sent at all (All this is due to a bug in the GtkContainer code
@@ -1158,7 +1158,7 @@ gtk_window_key_press_callback( GtkWidget *widget,
{ {
// however only do it if we have a Cancel button in the dialog, // however only do it if we have a Cancel button in the dialog,
// otherwise the user code may get confused by the events from a // otherwise the user code may get confused by the events from a
// non-existing button and, worse, a wxButton might get button event // nonexistent button and, worse, a wxButton might get button event
// from another button which is not really expected // from another button which is not really expected
wxWindow *winForCancel = win, wxWindow *winForCancel = win,
*btnCancel = NULL; *btnCancel = NULL;
@@ -1676,7 +1676,7 @@ gtk_window_button_release_callback( GtkWidget *widget,
break; break;
default: default:
// unknwon button, don't process // unknown button, don't process
return FALSE; return FALSE;
} }
@@ -1748,7 +1748,7 @@ gtk_window_motion_notify_callback( GtkWidget *widget,
if ( g_captureWindow ) if ( g_captureWindow )
{ {
// synthetize a mouse enter or leave event if needed // synthesise a mouse enter or leave event if needed
GdkWindow *winUnderMouse = gdk_window_at_pointer(NULL, NULL); GdkWindow *winUnderMouse = gdk_window_at_pointer(NULL, NULL);
// This seems to be necessary and actually been added to // This seems to be necessary and actually been added to
// GDK itself in version 2.0.X // GDK itself in version 2.0.X

View File

@@ -541,7 +541,7 @@ void wxHtmlWinParser::SetInputEncoding(wxFontEncoding enc)
else else
{ {
#ifndef __WXMAC__ #ifndef __WXMAC__
// okay, let convert to ISO_8859-1, available always // okay, let's convert to ISO_8859-1, available always
m_OutputEnc = wxFONTENCODING_DEFAULT; m_OutputEnc = wxFONTENCODING_DEFAULT;
#else #else
m_OutputEnc = wxLocale::GetSystemEncoding() ; m_OutputEnc = wxLocale::GetSystemEncoding() ;
@@ -561,7 +561,7 @@ void wxHtmlWinParser::SetInputEncoding(wxFontEncoding enc)
(m_OutputEnc == wxFONTENCODING_DEFAULT) ? (m_OutputEnc == wxFONTENCODING_DEFAULT) ?
wxFONTENCODING_ISO8859_1 : m_OutputEnc, wxFONTENCODING_ISO8859_1 : m_OutputEnc,
wxCONVERT_SUBSTITUTE)) wxCONVERT_SUBSTITUTE))
{ // total failture :-( { // total failure :-(
wxLogError(_("Failed to display HTML document in %s encoding"), wxLogError(_("Failed to display HTML document in %s encoding"),
wxFontMapper::GetEncodingName(enc).c_str()); wxFontMapper::GetEncodingName(enc).c_str());
m_InputEnc = m_OutputEnc = wxFONTENCODING_DEFAULT; m_InputEnc = m_OutputEnc = wxFONTENCODING_DEFAULT;

View File

@@ -1979,14 +1979,14 @@ wxString wxAMMediaBackend::GetErrorString(HRESULT hrdsv)
{ {
return wxString::Format(wxT("DirectShow error \"%s\" \n") return wxString::Format(wxT("DirectShow error \"%s\" \n")
wxT("(numeric %X)\n") wxT("(numeric %X)\n")
wxT("occured"), wxT("occurred"),
szError, (int)hrdsv); szError, (int)hrdsv);
} }
else else
{ {
return wxString::Format(wxT("Unknown error \n") return wxString::Format(wxT("Unknown error \n")
wxT("(numeric %X)\n") wxT("(numeric %X)\n")
wxT("occured"), wxT("occurred"),
(int)hrdsv); (int)hrdsv);
} }
} }
@@ -1995,7 +1995,6 @@ wxString wxAMMediaBackend::GetErrorString(HRESULT hrdsv)
#define wxVERIFY(x) wxASSERT((x)) #define wxVERIFY(x) wxASSERT((x))
#define wxAMLOG(x) wxLogDebug(GetErrorString(x)) #define wxAMLOG(x) wxLogDebug(GetErrorString(x))
#else #else
#define wxAMVERIFY(x) (x)
#define wxVERIFY(x) (x) #define wxVERIFY(x) (x)
#define wxAMLOG(x) #define wxAMLOG(x)
#define wxAMFAIL(x) #define wxAMFAIL(x)

View File

@@ -414,8 +414,8 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
!pItem->GetFont().Ok() && !pItem->GetFont().Ok() &&
!pItem->GetBitmap(true).Ok() ) !pItem->GetBitmap(true).Ok() )
{ {
// try to use InsertMenuItem() as it's guaranteed to look correctly // try to use InsertMenuItem() as it's guaranteed to look correct
// while our owner-drawning code is not // while our owner-drawn code is not
// first compile-time check // first compile-time check
#ifdef MIIM_BITMAP #ifdef MIIM_BITMAP
@@ -442,7 +442,7 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
// we can't pass HBITMAP directly as hbmpItem for 2 reasons: // we can't pass HBITMAP directly as hbmpItem for 2 reasons:
// 1. we can't draw it with transparency then (this is not // 1. we can't draw it with transparency then (this is not
// very important now but would be with themed menu bg) // very important now but would be with themed menu bg)
// 2. worse, Windows inverses the bitmap for the selected // 2. worse, Windows inverts the bitmap for the selected
// item and this looks downright ugly // item and this looks downright ugly
// //
// so instead draw it ourselves in MSWOnDrawItem() // so instead draw it ourselves in MSWOnDrawItem()
@@ -494,7 +494,7 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
else else
#endif // wxUSE_OWNER_DRAWN #endif // wxUSE_OWNER_DRAWN
{ {
// menu is just a normal string (passed in data parameter) // item is just a normal string (passed in data parameter)
flags |= MF_STRING; flags |= MF_STRING;
#ifdef __WXWINCE__ #ifdef __WXWINCE__
@@ -504,7 +504,7 @@ bool wxMenu::DoInsertOrAppend(wxMenuItem *pItem, size_t pos)
pData = (wxChar*)itemText.c_str(); pData = (wxChar*)itemText.c_str();
} }
// item might have been already inserted by InsertMenuItem() above // item might have already been inserted by InsertMenuItem() above
if ( !ok ) if ( !ok )
{ {
if ( !::InsertMenu(GetHmenu(), pos, flags | MF_BYPOSITION, id, pData) ) if ( !::InsertMenu(GetHmenu(), pos, flags | MF_BYPOSITION, id, pData) )
@@ -605,7 +605,7 @@ wxMenuItem* wxMenu::DoInsert(size_t pos, wxMenuItem *item)
wxMenuItem *wxMenu::DoRemove(wxMenuItem *item) wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
{ {
// we need to find the items position in the child list // we need to find the item's position in the child list
size_t pos; size_t pos;
wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst(); wxMenuItemList::compatibility_iterator node = GetMenuItems().GetFirst();
for ( pos = 0; node; pos++ ) for ( pos = 0; node; pos++ )
@@ -616,7 +616,7 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
node = node->GetNext(); node = node->GetNext();
} }
// DoRemove() (unlike Remove) can only be called for existing item! // DoRemove() (unlike Remove) can only be called for an existing item!
wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") ); wxCHECK_MSG( node, NULL, wxT("bug in wxMenu::Remove logic") );
#if wxUSE_ACCEL #if wxUSE_ACCEL
@@ -639,7 +639,7 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
if ( IsAttached() && GetMenuBar()->IsAttached() ) if ( IsAttached() && GetMenuBar()->IsAttached() )
{ {
// otherwise, the chane won't be visible // otherwise, the change won't be visible
GetMenuBar()->Refresh(); GetMenuBar()->Refresh();
} }
@@ -653,7 +653,7 @@ wxMenuItem *wxMenu::DoRemove(wxMenuItem *item)
#if wxUSE_ACCEL #if wxUSE_ACCEL
// create the wxAcceleratorEntries for our accels and put them into provided // create the wxAcceleratorEntries for our accels and put them into the provided
// array - return the number of accels we have // array - return the number of accels we have
size_t wxMenu::CopyAccels(wxAcceleratorEntry *accels) const size_t wxMenu::CopyAccels(wxAcceleratorEntry *accels) const
{ {
@@ -867,7 +867,7 @@ void wxMenuBar::Refresh()
WXHMENU wxMenuBar::Create() WXHMENU wxMenuBar::Create()
{ {
// Note: this totally doesn't work on Smartphone, // Note: this doesn't work at all on Smartphone,
// since you have to use resources. // since you have to use resources.
// We'll have to find another way to add a menu // We'll have to find another way to add a menu
// by changing/adding menu items to an existing menu. // by changing/adding menu items to an existing menu.