From cdbcf4c286ea989bfb8922a54d9e3f80b3fc9bcb Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Tue, 1 Apr 2008 13:59:28 +0000 Subject: [PATCH] replace @b Note with @note; replace '' with " git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52960 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/combo.h | 6 +++--- interface/combobox.h | 2 +- interface/config.h | 2 +- interface/control.h | 2 +- interface/dc.h | 2 +- interface/dde.h | 2 +- interface/docview.h | 4 ++-- interface/filename.h | 2 +- interface/filesys.h | 4 ++-- interface/gdicmn.h | 6 +++--- interface/html/htmlcell.h | 4 ++-- interface/html/htmltag.h | 2 +- interface/html/winpars.h | 4 ++-- interface/intl.h | 6 +++--- interface/list.h | 2 +- interface/menuitem.h | 4 ++-- interface/minifram.h | 2 +- interface/ptr_scpd.h | 4 ++-- interface/recguard.h | 2 +- interface/renderer.h | 6 +++--- interface/sckipc.h | 2 +- interface/stdpaths.h | 4 ++-- interface/timer.h | 2 +- interface/tokenzr.h | 2 +- interface/uri.h | 2 +- interface/weakref.h | 2 +- interface/window.h | 6 +++--- interface/xml/xml.h | 2 +- 28 files changed, 45 insertions(+), 45 deletions(-) diff --git a/interface/combo.h b/interface/combo.h index 744efd2b5e..40bd5c9123 100644 --- a/interface/combo.h +++ b/interface/combo.h @@ -366,7 +366,7 @@ public: This member function is not normally called in application code. Instead, it can be implemented in a derived class to return default wxComboPopup, incase @c popup is @NULL. - @b Note: If you have implemented OnButtonClick to do + @note If you have implemented OnButtonClick to do something else than show the popup, then DoSetPopupControl must always return @NULL. */ @@ -447,7 +447,7 @@ public: /** Returns the insertion point for the combo control's text field. - @b Note: Under wxMSW, this function always returns 0 if the combo control + @note Under wxMSW, this function always returns 0 if the combo control doesn't have the focus. */ long GetInsertionPoint() const; @@ -522,7 +522,7 @@ public: Implement in a derived class to define what happens on dropdown button click. Default action is to show the popup. - @b Note: If you implement this to do something else than + @note If you implement this to do something else than show the popup, you must then also implement DoSetPopupControl() to always return @NULL. diff --git a/interface/combobox.h b/interface/combobox.h index ac98f43f63..3613170011 100644 --- a/interface/combobox.h +++ b/interface/combobox.h @@ -193,7 +193,7 @@ public: /** Returns the insertion point for the combobox's text field. - @b Note: Under wxMSW, this function always returns 0 if the combobox + @note Under wxMSW, this function always returns 0 if the combobox doesn't have the focus. */ long GetInsertionPoint() const; diff --git a/interface/config.h b/interface/config.h index b182044f4d..c0dae59d64 100644 --- a/interface/config.h +++ b/interface/config.h @@ -521,7 +521,7 @@ public: you may forget about calling @e Set(). When @e Get() is called and there is no current object, it will create one using @e Create() function. To disable this behaviour @e DontCreateOnDemand() is provided. - @b Note: You should use either @e Set() or @e Get() because wxWidgets + @note You should use either @e Set() or @e Get() because wxWidgets library itself would take advantage of it and could save various information in it. For example wxFontMapper or Unix version of wxFileDialog have the ability to use wxConfig class. diff --git a/interface/control.h b/interface/control.h index 7bdba6b7be..3d5b7ef17a 100644 --- a/interface/control.h +++ b/interface/control.h @@ -10,7 +10,7 @@ @class wxControl @wxheader{control.h} - This is the base class for a control or "widget''. + This is the base class for a control or "widget". A control is generally a small window which processes user input and/or displays one or more item of data. diff --git a/interface/dc.h b/interface/dc.h index b681c59406..e37d334fbc 100644 --- a/interface/dc.h +++ b/interface/dc.h @@ -638,7 +638,7 @@ public: @a circleCenter are the relative coordinates of centre of the circle in the specified @e rect. If not specified, the cercle is placed at the centre of rect. - @b Note: Currently this function is very slow, don't use it for + @note Currently this function is very slow, don't use it for real-time drawing. */ void GradientFillConcentric(const wxRect& rect, diff --git a/interface/dde.h b/interface/dde.h index 520508906b..a82303d763 100644 --- a/interface/dde.h +++ b/interface/dde.h @@ -300,7 +300,7 @@ public: message and this member is called. The application should derive a member to intercept this message and return a connection object of either the standard wxDDEConnection type, or of a user-derived type. If the - topic is "STDIO'', the application may wish to refuse the connection. + topic is "STDIO", the application may wish to refuse the connection. Under UNIX, when a server is created the OnAcceptConnection message is always sent for standard input and output, but in the context of DDE messages it doesn't make a lot of sense. diff --git a/interface/docview.h b/interface/docview.h index c7c8334f16..0cbe2a7e46 100644 --- a/interface/docview.h +++ b/interface/docview.h @@ -696,7 +696,7 @@ public: wxDocManager* GetDocumentManager() const; /** - Gets the frame associated with the view (if any). Note that this "frame'' is + Gets the frame associated with the view (if any). Note that this "frame" is not a wxFrame at all in the generic MDI implementation which uses the notebook pages instead of the frames and this is why this method returns a wxWindow and not a wxFrame. @@ -787,7 +787,7 @@ public: Sets the frame associated with this view. The application should call this if possible, to tell the view about the frame. See GetFrame() for the explanation about the mismatch - between the "Frame'' in the method name and the type of its parameter. + between the "Frame" in the method name and the type of its parameter. */ void SetFrame(wxWindow* frame); diff --git a/interface/filename.h b/interface/filename.h index 6e26cbfe37..54c02a8c78 100644 --- a/interface/filename.h +++ b/interface/filename.h @@ -936,7 +936,7 @@ public: without leading dot. All three of them may be empty if the corresponding component is. The old contents of the strings pointed to by these parameters will be overwritten in any case (if the pointers are not @NULL). - Note that for a filename "foo.'' the extension is present, as indicated by the + Note that for a filename "foo." the extension is present, as indicated by the trailing dot, but empty. If you need to cope with such cases, you should use @a hasExt instead of relying on testing whether @a ext is empty or not. */ diff --git a/interface/filesys.h b/interface/filesys.h index 35d27f5706..41deffada4 100644 --- a/interface/filesys.h +++ b/interface/filesys.h @@ -134,7 +134,7 @@ public: It provides more information than wxWindow's input stream (stream, filename, mime type, anchor). - @b Note: Any pointer returned by a method of wxFSFile is valid + @note Any pointer returned by a method of wxFSFile is valid only as long as the wxFSFile object exists. For example a call to GetStream() doesn't @e create the stream but only returns the pointer to it. In other words after 10 calls to GetStream() you will have obtained ten identical @@ -279,7 +279,7 @@ public: Returns the anchor if present in the location. See @ref wxFSFile::getanchor wxFSFile for details. Example: GetAnchor("index.htm#chapter2") == "chapter2" - @b Note: the anchor is NOT part of the left location. + @note the anchor is NOT part of the left location. */ wxString GetAnchor(const wxString& location) const; diff --git a/interface/gdicmn.h b/interface/gdicmn.h index 74f15a61c7..fb7f166798 100644 --- a/interface/gdicmn.h +++ b/interface/gdicmn.h @@ -270,9 +270,9 @@ public: rectangle thus change by 2*@a dx and 2*@e dy, respectively.) If one or both of @a dx and @a dy are negative, the opposite happens: the rectangle size decreases in the respective direction. - Inflating and deflating behaves "naturally''. Defined more precisely, that + Inflating and deflating behaves "naturally". Defined more precisely, that means: - "Real'' inflates (that is, @a dx and/or @a dy = 0) are not + "Real" inflates (that is, @a dx and/or @a dy = 0) are not constrained. Thus inflating a rectangle can cause its upper left corner to move into the negative numbers. (the versions prior to 2.5.4 forced the top left coordinate to not fall below (0, 0), which implied a @@ -475,7 +475,7 @@ public: @wxheader{gdicmn.h} wxWidgets maintains a database of standard RGB colours for a predefined - set of named colours (such as "BLACK'', "LIGHT GREY''). The + set of named colours (such as "BLACK", "LIGHT GREY"). The application may add to this set if desired by using wxColourDatabase::AddColour and may use it to look up colours by names using wxColourDatabase::Find or find the names diff --git a/interface/html/htmlcell.h b/interface/html/htmlcell.h index d4127f8b29..bd81c7f5d9 100644 --- a/interface/html/htmlcell.h +++ b/interface/html/htmlcell.h @@ -185,7 +185,7 @@ public: Returns pointer to the first cell in the list. You can then use child's GetNext() method to obtain pointer to the next cell in list. - @b Note: This shouldn't be used by the end user. If you need some way of + @note This shouldn't be used by the end user. If you need some way of finding particular cell in the list, try Find() method instead. */ @@ -353,7 +353,7 @@ public: /** Returns the indentation. @a ind is one of the @b wxHTML_INDENT_* constants. - @b Note: You must call GetIndentUnits() + @note You must call GetIndentUnits() with same @a ind parameter in order to correctly interpret the returned integer value. It is NOT always in pixels! diff --git a/interface/html/htmltag.h b/interface/html/htmltag.h index 6a6ef9606e..974106a761 100644 --- a/interface/html/htmltag.h +++ b/interface/html/htmltag.h @@ -58,7 +58,7 @@ public: /** Returns tag's name. The name is always in uppercase and it doesn't contain - '' or '/' characters. (So the name of @c FONT SIZE=+2 tag is "FONT" + " or '/' characters. (So the name of @c FONT SIZE=+2 tag is "FONT" and name of @c /table is "TABLE") */ wxString GetName() const; diff --git a/interface/html/winpars.h b/interface/html/winpars.h index 4b6a71af1d..ed5d5348b1 100644 --- a/interface/html/winpars.h +++ b/interface/html/winpars.h @@ -126,7 +126,7 @@ public: /** Returns (average) char height in standard font. It is used as DC-independent metrics. - @b Note: This function doesn't return the @e actual height. If you want to + @note This function doesn't return the @e actual height. If you want to know the height of the current font, call @c GetDC - GetCharHeight(). */ int GetCharHeight() const; @@ -134,7 +134,7 @@ public: /** Returns average char width in standard font. It is used as DC-independent metrics. - @b Note: This function doesn't return the @e actual width. If you want to + @note This function doesn't return the @e actual width. If you want to know the height of the current font, call @c GetDC - GetCharWidth() */ int GetCharWidth() const; diff --git a/interface/intl.h b/interface/intl.h index aef176653b..2594f28187 100644 --- a/interface/intl.h +++ b/interface/intl.h @@ -29,9 +29,9 @@ # .... # use the functions - print gettext( ``Panic!'' ); + print gettext( "Panic!" ); - button = Wx::Button-new( window, -1, gettext( ``Label'' ) ); + button = Wx::Button-new( window, -1, gettext( "Label" ) ); @endcode If you need to translate a lot of strings, then adding gettext( ) around @@ -46,7 +46,7 @@ # ... # use the functions - print t( ``Panic!!'' ); + print t( "Panic!!" ); # ... @endcode diff --git a/interface/list.h b/interface/list.h index ea950dbd09..55416b4528 100644 --- a/interface/list.h +++ b/interface/list.h @@ -318,7 +318,7 @@ public: compatibility only and usage of this class is strongly deprecated. In the documentation below, the type @c T should be thought of as a - "template'' parameter: this is the type of data stored in the linked list or, + "template" parameter: this is the type of data stored in the linked list or, in other words, the first argument of WX_DECLARE_LIST macro. Also, wxNode is written as wxNodeT even though it isn't really a template class -- but it helps to think of it as if it were. diff --git a/interface/menuitem.h b/interface/menuitem.h index e8604c2a53..4ee4df3b26 100644 --- a/interface/menuitem.h +++ b/interface/menuitem.h @@ -27,7 +27,7 @@ class wxMenuItem : public wxObject public: /** Constructs a wxMenuItem object. - Menu items can be standard, or "stock menu items'', or custom. For the + Menu items can be standard, or "stock menu items", or custom. For the standard menu items (such as commands to open a file, exit the program and so on, see @ref overview_stockitems "stock items" for the full list) it is enough to @@ -50,7 +50,7 @@ public: Identifier for this menu item, or wxID_SEPARATOR to indicate a separator. @param text Text for the menu item, as shown on the menu. An accelerator - key can be specified using the ampersand '' character. In order to embed an + key can be specified using the ampersand " character. In order to embed an ampersand character in the menu item text, the ampersand must be doubled. @param helpString Optional help string that will be shown on the status bar. diff --git a/interface/minifram.h b/interface/minifram.h index 63d398af14..f1751ab682 100644 --- a/interface/minifram.h +++ b/interface/minifram.h @@ -16,7 +16,7 @@ An example of mini frame can be seen in the @ref overview_sampledialogs "dialogs sample" - using the "Mini frame'' command of the "Generic dialogs'' submenu. + using the "Mini frame" command of the "Generic dialogs" submenu. @beginStyleTable @style{wxICONIZE}: diff --git a/interface/ptr_scpd.h b/interface/ptr_scpd.h index 340242a0da..be9d29299d 100644 --- a/interface/ptr_scpd.h +++ b/interface/ptr_scpd.h @@ -21,7 +21,7 @@ deleted when the smart pointer goes out of scope. This class is different from the @c std::auto_ptr in so far as it doesn't provide copy constructor nor assignment operator. This limits what you can do with it but is much less - surprizing than the "destructive copy'' behaviour of the standard class. + surprizing than the "destructive copy" behaviour of the standard class. @library{wxbase} @category{FIXME} @@ -139,7 +139,7 @@ public: @wxheader{ptr_scpd.h} This is a variation on the topic of wxScopedPtr. This - class is also a smart pointer but in addition it "ties'' the pointer value to + class is also a smart pointer but in addition it "ties" the pointer value to another variable. In other words, during the life time of this class the value of that variable is set to be the same as the value of the pointer itself and it is reset to its old value when the object is destroyed. This class is diff --git a/interface/recguard.h b/interface/recguard.h index 1aae24aa39..89cda8df07 100644 --- a/interface/recguard.h +++ b/interface/recguard.h @@ -86,7 +86,7 @@ public: ~wxRecursionGuard(); /** - Returns @true if we're already inside the code block "protected'' by this + Returns @true if we're already inside the code block "protected" by this wxRecursionGuard (i.e. between this line and the end of current scope). Usually the function using wxRecursionGuard takes some specific actions in such case (may be simply returning) to prevent reentrant calls to itself. diff --git a/interface/renderer.h b/interface/renderer.h index d57cc69a8a..153a95c271 100644 --- a/interface/renderer.h +++ b/interface/renderer.h @@ -52,7 +52,7 @@ public: thus allowing you to only modify some of its methods -- without having to reimplement all of them. - Note that the "normal'', inheritance-based approach, doesn't work with the + Note that the "normal", inheritance-based approach, doesn't work with the renderers as it is impossible to derive from a class unknown at compile-time and the renderer is only chosen at run-time. So suppose that you want to only add something to the drawing of the tree control buttons but leave all the @@ -63,7 +63,7 @@ public: Except for the constructor, it has exactly the same methods as wxRendererNative and their implementation is - trivial: they are simply forwarded to the real renderer. Note that the "real'' + trivial: they are simply forwarded to the real renderer. Note that the "real" renderer may, in turn, be a wxDelegateRendererNative as well and that there may be arbitrarily many levels like this -- but at the end of the chain there must be a real renderer which does the drawing. @@ -105,7 +105,7 @@ public: First, a brief introduction to wxRenderer and why it is needed. Usually wxWidgets uses the underlying low level GUI system to draw all the - controls - this is what we mean when we say that it is a "native'' framework. + controls - this is what we mean when we say that it is a "native" framework. However not all controls exist under all (or even any) platforms and in this case wxWidgets provides a default, generic, implementation of them written in wxWidgets itself. diff --git a/interface/sckipc.h b/interface/sckipc.h index 4a3db2f305..0ec3ce061e 100644 --- a/interface/sckipc.h +++ b/interface/sckipc.h @@ -42,7 +42,7 @@ public: message and this member is called. The application should derive a member to intercept this message and return a connection object of either the standard wxTCPConnection type, or of a user-derived type. If the - topic is "STDIO'', the application may wish to refuse the connection. + topic is "STDIO", the application may wish to refuse the connection. Under Unix, when a server is created the OnAcceptConnection message is always sent for standard input and output. */ diff --git a/interface/stdpaths.h b/interface/stdpaths.h index 2ca093e698..aaca998e49 100644 --- a/interface/stdpaths.h +++ b/interface/stdpaths.h @@ -95,7 +95,7 @@ public: wxString GetExecutablePath() const; /** - @b Note: This function is only available under Unix. + @note This function is only available under Unix. Return the program installation prefix, e.g. @c /usr, @c /opt or @c /home/zeitlin. If the prefix had been previously by @@ -196,7 +196,7 @@ public: wxString GetUserLocalDataDir() const; /** - @b Note: This function is only available under Unix. + @note This function is only available under Unix. Lets wxStandardPaths know about the real program installation prefix on a Unix system. By default, the value returned by GetInstallPrefix() is used. diff --git a/interface/timer.h b/interface/timer.h index 97ba7e4e85..49de74c8ef 100644 --- a/interface/timer.h +++ b/interface/timer.h @@ -32,7 +32,7 @@ after constructing it before it actually starts sending notifications. It can be stopped later with wxTimer::Stop. - @b Note: A timer can only be used from the main thread. + @note A timer can only be used from the main thread. @library{wxbase} @category{misc} diff --git a/interface/tokenzr.h b/interface/tokenzr.h index e2cbcc32c8..b9db6a1826 100644 --- a/interface/tokenzr.h +++ b/interface/tokenzr.h @@ -61,7 +61,7 @@ In this mode, the empty tokens in the middle of the string will be returned, i.e. @c "a::b:" will be tokenized in - three tokens 'a', '' and 'b'. Notice that all trailing delimiters are ignored + three tokens 'a', " and 'b'. Notice that all trailing delimiters are ignored in this mode, not just the last one, i.e. a string @c "a::b::" would still result in the same set of tokens. diff --git a/interface/uri.h b/interface/uri.h index 490eff1be7..2f49d02018 100644 --- a/interface/uri.h +++ b/interface/uri.h @@ -86,7 +86,7 @@ public: /** Obtains the fragment of this URI. The fragment of a URI is the last value of the URI, - and is the value after a '' character after the path + and is the value after a " character after the path of the URI. @c http://mysite.com/mypath#fragment */ diff --git a/interface/weakref.h b/interface/weakref.h index 02decd556f..fcd802d7a4 100644 --- a/interface/weakref.h +++ b/interface/weakref.h @@ -18,7 +18,7 @@ have a little better run-time performance. The role of wxWeakRefDynamic is to handle objects which derived type one does not know. - @b Note: wxWeakRefT selects an implementation based on the static type + @note wxWeakRefT selects an implementation based on the static type of T. If T does not have wxTrackable statically, it defaults to to a mixed- mode operation, where it uses @c dynamic_cast as the last measure (if available from the compiler and enabled when building wxWidgets). diff --git a/interface/window.h b/interface/window.h index ab5670b7da..657d9efa46 100644 --- a/interface/window.h +++ b/interface/window.h @@ -697,7 +697,7 @@ public: ignore under other platforms. Under Mac, it will change the size of the returned font. See SetWindowVariant() for more about this. - This static method is "overridden'' in many derived classes and so calling, + This static method is "overridden" in many derived classes and so calling, for example, wxButton::GetClassDefaultAttributes() will typically return the values appropriate for a button which will be normally different from those returned by, say, wxListCtrl::GetClassDefaultAttributes(). @@ -755,7 +755,7 @@ public: the call is automatically dispatched to the correct class (as usual with virtual functions) and you don't have to specify the class name explicitly. The other one is that in the future this function could return different - results, for example it might return a different font for an "Ok'' button + results, for example it might return a different font for an "Ok" button than for a generic button if the users GUI is configured to show such buttons in bold font. Of course, the down side is that it is impossible to call this function without actually having an object to apply it to whereas the static @@ -1249,7 +1249,7 @@ public: This function is (or should be, in case of custom controls) called during window creation to intelligently set up the window visual attributes, that is the font and the foreground and background colours. - By "intelligently'' the following is meant: by default, all windows use their + By "intelligently" the following is meant: by default, all windows use their own @ref getclassdefaultattributes() default attributes. However if some of the parents attributes are explicitly (that is, using SetFont() and not diff --git a/interface/xml/xml.h b/interface/xml/xml.h index bc26ffb32f..bbc63c62ed 100644 --- a/interface/xml/xml.h +++ b/interface/xml/xml.h @@ -382,7 +382,7 @@ public: } @endcode - @b Note: if you want to preserve the original formatting of the loaded file + @note if you want to preserve the original formatting of the loaded file including whitespaces and indentation, you need to turn off whitespace-only textnode removal and automatic indentation: -- 2.45.2