From e54c96f187f46c06bd36be8cd52b35c19884aa2b Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Mon, 10 Mar 2008 15:24:38 +0000 Subject: [PATCH] regenerated headers to remove @seealso in favour of @see; fixed links to global functions/macros; converted \since latex macros into @wxsince commands; changed headers purpose from 'documentation for' to 'interface of' git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52425 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775 --- interface/access.h | 3 +- interface/animate.h | 26 ++-- interface/app.h | 50 ++++---- interface/apptrait.h | 8 +- interface/archive.h | 34 +++--- interface/arrstr.h | 12 +- interface/artprov.h | 12 +- interface/atomic.h | 2 +- interface/aui/aui.h | 10 +- interface/aui/auibook.h | 4 +- interface/aui/dockart.h | 6 +- interface/base64.h | 10 +- interface/bitmap.h | 32 +++-- interface/bmpbuttn.h | 11 +- interface/bmpcbox.h | 6 +- interface/brush.h | 99 +++++++++++---- interface/buffer.h | 3 +- interface/busyinfo.h | 3 +- interface/button.h | 8 +- interface/calctrl.h | 18 +-- interface/caret.h | 6 +- interface/chartype.h | 4 +- interface/checkbox.h | 6 +- interface/checklst.h | 6 +- interface/choicdlg.h | 14 +-- interface/choice.h | 9 +- interface/choicebk.h | 6 +- interface/clipboard.h | 2 +- interface/clipbrd.h | 6 +- interface/clntdata.h | 11 +- interface/clrpicker.h | 10 +- interface/cmdline.h | 6 +- interface/cmdproc.h | 10 +- interface/cmndata.h | 29 ++--- interface/collpane.h | 10 +- interface/colordlg.h | 8 +- interface/colour.h | 86 +++++++++---- interface/combo.h | 10 +- interface/combobox.h | 6 +- interface/config.h | 16 +-- interface/control.h | 6 +- interface/convauto.h | 6 +- interface/cpp.h | 8 +- interface/cshelp.h | 24 ++-- interface/ctrlsub.h | 6 +- interface/cursor.h | 50 ++++++-- interface/dataobj.h | 43 +++---- interface/dataview.h | 31 ++++- interface/datectrl.h | 6 +- interface/dateevt.h | 3 +- interface/datetime.h | 21 ++-- interface/datstrm.h | 4 +- interface/dc.h | 12 +- interface/dcbuffer.h | 14 +-- interface/dcclient.h | 14 +-- interface/dcmemory.h | 6 +- interface/dcmirror.h | 3 +- interface/dcprint.h | 6 +- interface/dcps.h | 3 +- interface/dcscreen.h | 6 +- interface/dcsvg.h | 6 +- interface/dde.h | 18 +-- interface/debug.h | 32 ++--- interface/debugrpt.h | 9 +- interface/defs.h | 6 +- interface/dialog.h | 10 +- interface/dialup.h | 7 +- interface/dir.h | 6 +- interface/dirctrl.h | 3 +- interface/dirdlg.h | 6 +- interface/display.h | 6 +- interface/dnd.h | 21 ++-- interface/docmdi.h | 12 +- interface/docview.h | 49 ++++---- interface/dragimag.h | 3 +- interface/dynarray.h | 62 +++++----- interface/dynlib.h | 15 ++- interface/editlbox.h | 6 +- interface/encconv.h | 8 +- interface/event.h | 159 +++++++++++++------------ interface/fdrepdlg.h | 5 +- interface/ffile.h | 6 +- interface/file.h | 4 +- interface/fileconf.h | 8 +- interface/filectrl.h | 7 +- interface/filedlg.h | 7 +- interface/filefn.h | 20 ++-- interface/filename.h | 8 +- interface/filepicker.h | 14 +-- interface/filesys.h | 24 ++-- interface/font.h | 57 +++++++-- interface/fontdlg.h | 6 +- interface/fontenum.h | 10 +- interface/fontmap.h | 6 +- interface/fontpicker.h | 10 +- interface/frame.h | 6 +- interface/fs_mem.h | 11 +- interface/gauge.h | 6 +- interface/gbsizer.h | 6 +- interface/gdicmn.h | 38 +++--- interface/gdiobj.h | 6 +- interface/glcanvas.h | 10 +- interface/graphics.h | 16 ++- interface/grid.h | 59 +++++---- interface/hash.h | 6 +- interface/hashmap.h | 3 +- interface/hashset.h | 3 +- interface/help.h | 8 +- interface/html/helpctrl.h | 9 +- interface/html/helpdata.h | 3 +- interface/html/helpdlg.h | 3 +- interface/html/helpfrm.h | 3 +- interface/html/helpwnd.h | 3 +- interface/html/htmlcell.h | 13 +- interface/html/htmlfilt.h | 6 +- interface/html/htmlpars.h | 10 +- interface/html/htmltag.h | 3 +- interface/html/htmlwin.h | 8 +- interface/html/htmprint.h | 5 +- interface/html/winpars.h | 20 ++-- interface/htmllbox.h | 10 +- interface/hyperlink.h | 9 +- interface/icon.h | 24 +++- interface/iconbndl.h | 12 +- interface/iconloc.h | 6 +- interface/image.h | 12 +- interface/imaglist.h | 6 +- interface/init.h | 4 +- interface/intl.h | 53 +++++---- interface/ipc.h | 16 +-- interface/joystick.h | 6 +- interface/layout.h | 14 +-- interface/laywin.h | 18 +-- interface/link.h | 8 +- interface/list.h | 10 +- interface/listbook.h | 6 +- interface/listbox.h | 9 +- interface/listctrl.h | 30 +++-- interface/log.h | 44 ++++--- interface/longlong.h | 16 +-- interface/math.h | 2 +- interface/mdi.h | 14 +-- interface/mediactrl.h | 9 +- interface/memory.h | 10 +- interface/menu.h | 10 +- interface/menuitem.h | 6 +- interface/metafile.h | 10 +- interface/mimetype.h | 14 +-- interface/minifram.h | 6 +- interface/module.h | 7 +- interface/msgdlg.h | 6 +- interface/msgqueue.h | 6 +- interface/mstream.h | 10 +- interface/msw/ole/activex.h | 7 +- interface/msw/ole/automtn.h | 6 +- interface/msw/registry.h | 3 +- interface/notebook.h | 10 +- interface/notifmsg.h | 3 +- interface/numdlg.h | 2 +- interface/object.h | 40 +++---- interface/odcombo.h | 6 +- interface/palette.h | 22 +++- interface/panel.h | 6 +- interface/pen.h | 99 +++++++++++---- interface/pickerbase.h | 6 +- interface/platform.h | 4 +- interface/platinfo.h | 11 +- interface/position.h | 6 +- interface/power.h | 6 +- interface/print.h | 26 ++-- interface/printdlg.h | 12 +- interface/process.h | 18 +-- interface/progdlg.h | 3 +- interface/propdlg.h | 3 +- interface/protocol/ftp.h | 6 +- interface/protocol/http.h | 6 +- interface/protocol/protocol.h | 6 +- interface/ptr_scpd.h | 17 +-- interface/ptr_shrd.h | 10 +- interface/quantize.h | 3 +- interface/radiobox.h | 6 +- interface/radiobut.h | 6 +- interface/recguard.h | 4 +- interface/regex.h | 8 +- interface/region.h | 10 +- interface/renderer.h | 8 +- interface/richtext/richtextbuffer.h | 6 +- interface/richtext/richtextctrl.h | 2 + interface/richtext/richtextformatdlg.h | 2 + interface/richtext/richtexthtml.h | 1 + interface/richtext/richtextprint.h | 3 + interface/richtext/richtextstyledlg.h | 1 + interface/richtext/richtextstyles.h | 18 ++- interface/richtext/richtextsymboldlg.h | 1 + interface/richtext/richtextxml.h | 1 + interface/sashwin.h | 10 +- interface/sckipc.h | 14 +-- interface/sckstrm.h | 10 +- interface/scopeguard.h | 6 +- interface/scrolbar.h | 6 +- interface/scrolwin.h | 6 +- interface/settings.h | 6 +- interface/sizer.h | 38 +++--- interface/slider.h | 6 +- interface/snglinst.h | 5 +- interface/socket.h | 31 ++--- interface/sound.h | 3 +- interface/spinbutt.h | 10 +- interface/spinctrl.h | 6 +- interface/splash.h | 3 +- interface/splitter.h | 10 +- interface/srchctrl.h | 6 +- interface/sstream.h | 4 +- interface/stackwalk.h | 10 +- interface/statbmp.h | 6 +- interface/statbox.h | 6 +- interface/statline.h | 6 +- interface/stattext.h | 9 +- interface/statusbr.h | 6 +- interface/stc/stc.h | 7 +- interface/stdpaths.h | 18 +-- interface/stockitem.h | 2 +- interface/stopwatch.h | 6 +- interface/strconv.h | 41 +++---- interface/stream.h | 36 +++--- interface/string.h | 36 ++++-- interface/sysopt.h | 6 +- interface/tarstrm.h | 21 ++-- interface/taskbar.h | 3 +- interface/textctrl.h | 26 ++-- interface/textdlg.h | 13 +- interface/textfile.h | 6 +- interface/tglbtn.h | 9 +- interface/thread.h | 55 ++++----- interface/timer.h | 10 +- interface/tipdlg.h | 14 +-- interface/tipwin.h | 3 +- interface/tokenzr.h | 9 +- interface/toolbar.h | 6 +- interface/toolbook.h | 6 +- interface/tooltip.h | 3 +- interface/toplevel.h | 6 +- interface/tracker.h | 5 +- interface/treebase.h | 6 +- interface/treebook.h | 10 +- interface/treectrl.h | 18 +-- interface/txtstrm.h | 7 +- interface/uri.h | 6 +- interface/url.h | 6 +- interface/utils.h | 75 ++++++------ interface/valgen.h | 6 +- interface/validate.h | 6 +- interface/valtext.h | 6 +- interface/variant.h | 10 +- interface/vector.h | 6 +- interface/vlbox.h | 6 +- interface/vscroll.h | 30 ++--- interface/weakref.h | 7 +- interface/wfstream.h | 30 ++--- interface/window.h | 31 +++-- interface/windowid.h | 10 +- interface/wizard.h | 20 ++-- interface/wrapsizer.h | 6 +- interface/wupdlock.h | 3 +- interface/wxcrt.h | 8 +- interface/xml/xml.h | 14 +-- interface/xrc/xmlres.h | 8 +- interface/zipstrm.h | 28 +++-- interface/zstream.h | 10 +- 269 files changed, 2027 insertions(+), 1553 deletions(-) diff --git a/interface/access.h b/interface/access.h index 977286b0e2..941764016a 100644 --- a/interface/access.h +++ b/interface/access.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: access.h -// Purpose: documentation for wxAccessible class +// Purpose: interface of wxAccessible // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -205,3 +205,4 @@ public: */ void SetWindow(wxWindow* window); }; + diff --git a/interface/animate.h b/interface/animate.h index 6b49baa177..5ce14baba6 100644 --- a/interface/animate.h +++ b/interface/animate.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: animate.h -// Purpose: documentation for wxAnimationCtrl class +// Purpose: interface of wxAnimationCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -32,8 +32,7 @@ @category{ctrl} @appearance{animationctrl.png} - @seealso - wxAnimation + @see wxAnimation */ class wxAnimationCtrl : public wxControl { @@ -150,6 +149,7 @@ public: }; + /** @class wxAnimation @wxheader{animate.h} @@ -162,11 +162,9 @@ public: @category{FIXME} @stdobjects - Objects: - wxNullAnimation + ::Objects:, ::wxNullAnimation, - @seealso - wxAnimationCtrl + @see wxAnimationCtrl */ class wxAnimation : public wxGDIObject { @@ -320,3 +318,17 @@ public: */ wxAnimation operator =(const wxAnimation& brush); }; + + +/** + FIXME +*/ +wxAnimation Objects: +; + +/** + FIXME +*/ +wxAnimation wxNullAnimation; + + diff --git a/interface/app.h b/interface/app.h index 25fd6524c4..bea4fa35bb 100644 --- a/interface/app.h +++ b/interface/app.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: app.h -// Purpose: documentation for wxApp class +// Purpose: interface of wxApp // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -30,8 +30,7 @@ @library{wxbase} @category{appmanagement} - @seealso - @ref overview_wxappoverview "wxApp overview" + @see @ref overview_wxappoverview "wxApp overview" */ class wxApp : public wxEvtHandler { @@ -95,7 +94,8 @@ public: page headers and so on while the other one should be only used internally, e.g. for the file names or configuration file keys. By default, returns the same string as GetAppName(). - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} */ wxString GetAppDisplayName() const; @@ -169,7 +169,8 @@ public: page headers and so on while the other one should be only used internally, e.g. for the file names or configuration file keys. By default, returns the same string as GetVendorName(). - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} */ wxString GetVendorDisplayName() const; @@ -248,7 +249,7 @@ public: /** This function is called when an assert failure occurs, i.e. the condition - specified in wxASSERT macro evaluated to @false. + specified in wxASSERT() macro evaluated to @false. It is only called in debug mode (when @c __WXDEBUG__ is defined) as asserts are not left in the release code at all. The base class version shows the default assert failure dialog box proposing to @@ -338,12 +339,12 @@ public: This function may be called if something fatal happens: an unhandled exception under Win32 or a a fatal signal under Unix, for example. However, this will not happen by default: you have to explicitly call - wxHandleFatalExceptions to enable this. + wxHandleFatalExceptions() to enable this. Generally speaking, this function should only show a message to the user and return. You may attempt to save unsaved data but this is not guaranteed to work and, in fact, probably won't. - @see wxHandleFatalExceptions + @see wxHandleFatalExceptions() */ void OnFatalException(); @@ -581,6 +582,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -607,8 +609,8 @@ void wxVLogVerbose(const char* formatString, va_list argPtr); /** This is used in headers to create a forward declaration of the - wxGetApp function implemented by - wxIMPLEMENT_APP. It creates the declaration + wxGetApp() function implemented by + wxIMPLEMENT_APP(). It creates the declaration @c className wxGetApp(void). Example: @@ -637,7 +639,7 @@ void wxVLogWarning(const char* formatString, va_list argPtr); //@{ /** - Like wxLogError, but also + Like wxLogError(), but also terminates the program with the exit code 3. Using @e abort() standard function also terminates the program with this exit code. */ @@ -677,7 +679,7 @@ bool wxHandleFatalExceptions(bool doIt = true); IMPLEMENT_APP(MyApp) @endcode - See also DECLARE_APP. + See also DECLARE_APP(). */ #define IMPLEMENT_APP() /* implementation is private */ @@ -685,7 +687,7 @@ bool wxHandleFatalExceptions(bool doIt = true); Returns the error code from the last system call. This function uses @c errno on Unix platforms and @c GetLastError under Win32. - @see wxSysErrorMsg, wxLogSysError + @see wxSysErrorMsg(), wxLogSysError() */ unsigned long wxSysErrorCode(); @@ -765,15 +767,15 @@ void wxVLogTrace(wxTraceMask mask, const char* formatString, /** Returns the error message corresponding to the given system error code. If @a errCode is 0 (default), the last error code (as returned by - wxSysErrorCode) is used. + wxSysErrorCode()) is used. - @see wxSysErrorCode, wxLogSysError + @see wxSysErrorCode(), wxLogSysError() */ const wxChar* wxSysErrorMsg(unsigned long errCode = 0); /** This function is for use in console (wxBase) programs only. It must be called - once for each previous successful call to wxInitialize. + once for each previous successful call to wxInitialize(). */ void wxUninitialize(); @@ -789,9 +791,9 @@ void wxVLogDebug(const char* formatString, va_list argPtr); /** This function doesn't exist in wxWidgets but it is created by using - the IMPLEMENT_APP macro. Thus, before using it + the IMPLEMENT_APP() macro. Thus, before using it anywhere but in the same module where this macro is used, you must make it - available using DECLARE_APP. + available using DECLARE_APP(). The advantage of using this function compared to directly using the global wxTheApp pointer is that the latter is of type @c wxApp * and so wouldn't allow you to access the functions specific to your application class but not @@ -820,17 +822,17 @@ void wxVLogStatus(const char* formatString, va_list argPtr); @c main() function before calling any other wxWidgets functions. If the function returns @false the initialization could not be performed, in this case the library cannot be used and - wxUninitialize shouldn't be called neither. + wxUninitialize() shouldn't be called neither. This function may be called several times but - wxUninitialize must be called for each successful + wxUninitialize() must be called for each successful call to this function. */ bool wxInitialize(); /** This is used in headers to create a forward declaration of the - wxGetApp function implemented by - IMPLEMENT_APP. It creates the declaration + wxGetApp() function implemented by + IMPLEMENT_APP(). It creates the declaration @c className wxGetApp(void). Example: @@ -855,7 +857,7 @@ bool wxYield(); on the platform) and the corresponding error message. The second form of this function takes the error code explicitly as the first argument. - @see wxSysErrorCode, wxSysErrorMsg + @see wxSysErrorCode(), wxSysErrorMsg() */ void wxLogSysError(const char* formatString, ... ); void wxVLogSysError(const char* formatString, @@ -878,7 +880,7 @@ void wxVLogSysError(const char* formatString, function wxApp::CleanUp. For example, if exiting from an MFC application that also uses wxWidgets: - @see wxEntryStart + @see wxEntryStart() */ int wxEntry(int& argc, wxChar** argv); int wxEntry(HINSTANCE hInstance, diff --git a/interface/apptrait.h b/interface/apptrait.h index cca9c9859b..1c6771eef9 100644 --- a/interface/apptrait.h +++ b/interface/apptrait.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: apptrait.h -// Purpose: documentation for wxAppTraits class +// Purpose: interface of wxAppTraits // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -25,8 +25,7 @@ @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxappoverview "wxApp overview", wxApp + @see @ref overview_wxappoverview "wxApp overview", wxApp */ class wxAppTraits { @@ -34,7 +33,7 @@ public: /** Called by wxWidgets to create the default configuration object for the application. The default version creates a registry-based - wxRegConfig class under MSW and + wxRegConfig() class under MSW and wxFileConfig under all other platforms. The wxApp wxApp::GetAppName and wxApp::GetVendorName methods are used to determine the @@ -114,3 +113,4 @@ public: */ virtual bool ShowAssertDialog(const wxString& msg); }; + diff --git a/interface/archive.h b/interface/archive.h index 9de1a3e72f..d19bd60c7e 100644 --- a/interface/archive.h +++ b/interface/archive.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: archive.h -// Purpose: documentation for wxArchiveInputStream class +// Purpose: interface of wxArchiveInputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -23,8 +23,7 @@ @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarc "Archive formats such as zip", wxArchiveEntry, + @see @ref overview_wxarc "Archive formats such as zip", wxArchiveEntry, wxArchiveOutputStream */ class wxArchiveInputStream : public wxFilterInputStream @@ -55,6 +54,7 @@ public: }; + /** @class wxArchiveOutputStream @wxheader{archive.h} @@ -70,8 +70,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarc "Archive formats such as zip", wxArchiveEntry, + @see @ref overview_wxarc "Archive formats such as zip", wxArchiveEntry, wxArchiveInputStream */ class wxArchiveOutputStream : public wxFilterOutputStream @@ -151,6 +150,7 @@ public: }; + /** @class wxArchiveEntry @wxheader{archive.h} @@ -163,9 +163,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric - "Generic archive programming", wxArchiveInputStream, wxArchiveOutputStream, wxArchiveNotifier + @see @ref overview_wxarc "Archive formats such as zip", @ref + overview_wxarcgeneric "Generic archive programming", wxArchiveInputStream, wxArchiveOutputStream, wxArchiveNotifier */ class wxArchiveEntry : public wxObject { @@ -250,7 +249,7 @@ public: //@{ /** - Sets the notifier for this entry. + Sets the notifier() for this entry. Whenever the wxArchiveInputStream updates this entry, it will then invoke the associated notifier's wxArchiveNotifier::OnEntryUpdated @@ -265,6 +264,7 @@ public: }; + /** @class wxArchiveClassFactory @wxheader{archive.h} @@ -289,9 +289,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric - "Generic archive programming", wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream, wxFilterClassFactory + @see @ref overview_wxarc "Archive formats such as zip", @ref + overview_wxarcgeneric "Generic archive programming", wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream, wxFilterClassFactory */ class wxArchiveClassFactory : public wxObject { @@ -401,6 +400,7 @@ public: }; + /** @class wxArchiveNotifier @wxheader{archive.h} @@ -423,9 +423,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarcnoseek "Archives on non-seekable streams", wxArchiveEntry, - wxArchiveInputStream, wxArchiveOutputStream + @see @ref overview_wxarcnoseek "Archives on non-seekable streams", + wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream */ class wxArchiveNotifier { @@ -437,6 +436,7 @@ public: }; + /** @class wxArchiveIterator @wxheader{archive.h} @@ -535,8 +535,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream + @see wxArchiveEntry, wxArchiveInputStream, wxArchiveOutputStream */ class wxArchiveIterator { @@ -564,3 +563,4 @@ public: wxArchiveIterator operator++(int ); //@} }; + diff --git a/interface/arrstr.h b/interface/arrstr.h index b60f2f3321..a367d28f82 100644 --- a/interface/arrstr.h +++ b/interface/arrstr.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: arrstr.h -// Purpose: documentation for wxArrayString class +// Purpose: interface of wxArrayString // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -19,7 +19,7 @@ doesn't take more space than a C array @e wxString[] type (wxArrayString uses its knowledge of internals of wxString class to achieve this). - This class is used in the same way as other dynamic arrays, + This class is used in the same way as other dynamic arrays(), except that no @e WX_DEFINE_ARRAY declaration is needed for it. When a string is added or inserted in the array, a copy of the string is created, so the original string may be safely deleted (e.g. if it was a @e wxChar * @@ -52,8 +52,7 @@ @library{wxbase} @category{containers} - @seealso - wxArray, wxString, @ref overview_wxstringoverview "wxString overview" + @see wxArray, wxString, @ref overview_wxstringoverview "wxString overview" */ class wxArrayString : public wxArray { @@ -223,6 +222,7 @@ Warning: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -236,7 +236,7 @@ Warning: Note that empty tokens will be generated if there are two or more adjacent separators. - @see wxJoin + @see wxJoin() */ wxArrayString wxSplit(const wxString& str, const wxChar sep, const wxChar escape = ' @@ -250,7 +250,7 @@ wxArrayString wxSplit(const wxString& str, const wxChar sep, occurrence of @e sep in the strings contained in @a arr before joining them which is necessary in order to be able to recover the original array contents from the string - later using wxSplit. + later using wxSplit(). */ wxString wxJoin(const wxArrayString& arr, const wxChar sep, const wxChar escape = '\'); diff --git a/interface/artprov.h b/interface/artprov.h index 91660de670..695c9d500b 100644 --- a/interface/artprov.h +++ b/interface/artprov.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: artprov.h -// Purpose: documentation for wxArtProvider class +// Purpose: interface of wxArtProvider // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -70,7 +70,7 @@ is used when requesting a resource from it. The ID is represented by wxArtID type and can have one of these predefined values (you can see bitmaps represented by these - constants in the artprov sample): + constants in the artprov() sample): wxART_ERROR wxART_QUESTION @@ -128,8 +128,7 @@ @library{wxcore} @category{FIXME} - @seealso - See the artprov sample for an example of wxArtProvider usage. + @see See the artprov() sample for an example of wxArtProvider usage. */ class wxArtProvider : public wxObject { @@ -161,7 +160,7 @@ public: GetBitmap() returns identical bitmap for different @e client values! - @see See the artprov sample for an example of wxArtProvider usage. + @see See the artprov() sample for an example of wxArtProvider usage. */ @@ -251,7 +250,7 @@ public: is used when requesting a resource from it. The ID is represented by wxArtID type and can have one of these predefined values (you can see bitmaps represented by these - constants in the artprov sample): + constants in the artprov() sample): wxART_ERROR wxART_QUESTION @@ -333,3 +332,4 @@ public: */ static bool Remove(wxArtProvider* provider); }; + diff --git a/interface/atomic.h b/interface/atomic.h index ee07a6636e..1e9305cf1c 100644 --- a/interface/atomic.h +++ b/interface/atomic.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: atomic.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license diff --git a/interface/aui/aui.h b/interface/aui/aui.h index 6b7ee4167e..b1e491d0f3 100644 --- a/interface/aui/aui.h +++ b/interface/aui/aui.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: aui/aui.h -// Purpose: documentation for wxAuiManager class +// Purpose: interface of wxAuiManager // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -49,8 +49,7 @@ @library{wxbase} @category{aui} - @seealso - wxAuiPaneInfo, wxAuiDockArt + @see wxAuiPaneInfo, wxAuiDockArt */ class wxAuiManager : public wxEvtHandler { @@ -258,6 +257,7 @@ public: }; + /** @class wxAuiPaneInfo @headerfile aui.h wx/aui/aui.h @@ -275,8 +275,7 @@ public: @library{wxbase} @category{aui} - @seealso - wxAuiManager, wxAuiDockArt + @see wxAuiManager, wxAuiDockArt */ class wxAuiPaneInfo { @@ -684,3 +683,4 @@ public: */ wxAuiPaneInfo& operator operator=(const wxAuiPaneInfo& c); }; + diff --git a/interface/aui/auibook.h b/interface/aui/auibook.h index d4449facab..281692a542 100644 --- a/interface/aui/auibook.h +++ b/interface/aui/auibook.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: aui/auibook.h -// Purpose: documentation for wxAuiNotebook class +// Purpose: interface of wxAuiNotebook // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -239,6 +239,7 @@ public: }; + /** @class wxAuiTabArt @headerfile auibook.h wx/aui/auibook.h @@ -340,3 +341,4 @@ public: int ShowWindowList(wxWindow* wnd, const wxArrayString& items, int active_idx); }; + diff --git a/interface/aui/dockart.h b/interface/aui/dockart.h index f9a85a1826..6d7ef4fcd6 100644 --- a/interface/aui/dockart.h +++ b/interface/aui/dockart.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: aui/dockart.h -// Purpose: documentation for wxAuiDockArt class +// Purpose: interface of wxAuiDockArt // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -28,8 +28,7 @@ @library{wxaui} @category{aui} - @seealso - wxAuiManager, wxAuiPaneInfo + @see wxAuiManager, wxAuiPaneInfo */ class wxAuiDockArt { @@ -135,3 +134,4 @@ public: */ virtual void SetMetric(int id, int new_val); }; + diff --git a/interface/base64.h b/interface/base64.h index 388ac189cf..1aae84304c 100644 --- a/interface/base64.h +++ b/interface/base64.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: base64.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -13,7 +13,7 @@ other ones return the output as wxString. There is no error return for these functions except for the first one which returns @c wxCONV_FAILED if the output buffer is too small. To allocate the buffer of the correct size, use - wxBase64EncodedSize or call this function with + wxBase64EncodedSize() or call this function with @a dst set to @NULL -- it will then return the necessary buffer size. @param dst @@ -37,14 +37,14 @@ wxString wxBase64Encode(const wxMemoryBuffer& buf); /** Returns the size of the buffer necessary to contain the data encoded in a base64 string of length @e srcLen. This can be useful for allocating a -buffer to be passed to wxBase64Decode. +buffer to be passed to wxBase64Decode(). */ size_t wxBase64DecodedSize(size_t srcLen); /** Returns the length of the string with base64 representation of a buffer of specified size @e len. This can be useful for allocating the buffer passed - to wxBase64Encode. + to wxBase64Encode(). */ size_t wxBase64EncodedSize(size_t len); @@ -53,7 +53,7 @@ size_t wxBase64EncodedSize(size_t len); These function decode a Base64-encoded string. The first version is a raw decoding function and decodes the data into the provided buffer @a dst of the given size @e dstLen. An error is returned if the buffer is not large - enough -- that is not at least wxBase64DecodedSize(srcLen) + enough -- that is not at least wxBase64DecodedSize(srcLen)() bytes. The second version allocates memory internally and returns it as wxMemoryBuffer and is recommended for normal use. The first version returns the number of bytes written to the buffer or the diff --git a/interface/bitmap.h b/interface/bitmap.h index 54d7e3cddd..22710d45ca 100644 --- a/interface/bitmap.h +++ b/interface/bitmap.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: bitmap.h -// Purpose: documentation for wxBitmapHandler class +// Purpose: interface of wxBitmapHandler // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -10,7 +10,7 @@ @class wxBitmapHandler @wxheader{bitmap.h} - Overview + Overview() This is the base class for implementing bitmap file loading/saving, and bitmap creation from data. @@ -24,8 +24,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxBitmap, wxIcon, wxCursor + @see wxBitmap, wxIcon, wxCursor */ class wxBitmapHandler : public wxObject { @@ -145,6 +144,7 @@ public: }; + /** @class wxBitmap @wxheader{bitmap.h} @@ -156,11 +156,9 @@ public: @category{gdi} @stdobjects - Objects: - wxNullBitmap + ::Objects:, ::wxNullBitmap, - @seealso - @ref overview_wxbitmapoverview "wxBitmap overview", @ref + @see @ref overview_wxbitmapoverview "wxBitmap overview", @ref overview_supportedbitmapformats "supported bitmap file formats", wxDC::Blit, wxIcon, wxCursor, wxBitmap, wxMemoryDC */ class wxBitmap : public wxGDIObject @@ -710,6 +708,20 @@ public: }; +/** + FIXME +*/ +wxBitmap Objects: +; + +/** + FIXME +*/ +wxBitmap wxNullBitmap; + + + + /** @class wxMask @wxheader{bitmap.h} @@ -724,8 +736,7 @@ public: @library{wxcore} @category{gdi} - @seealso - wxBitmap, wxDC::Blit, wxMemoryDC + @see wxBitmap, wxDC::Blit, wxMemoryDC */ class wxMask : public wxObject { @@ -773,3 +784,4 @@ public: bool Create(const wxBitmap& bitmap, int index); //@} }; + diff --git a/interface/bmpbuttn.h b/interface/bmpbuttn.h index d62458b54a..02503fedfa 100644 --- a/interface/bmpbuttn.h +++ b/interface/bmpbuttn.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: bmpbuttn.h -// Purpose: documentation for wxBitmapButton class +// Purpose: interface of wxBitmapButton // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -11,7 +11,7 @@ @wxheader{bmpbuttn.h} A bitmap button is a control that contains a bitmap. - It may be placed on a @ref overview_wxdialog "dialog box" or panel, or indeed + It may be placed on a @ref overview_wxdialog "dialog box" or panel(), or indeed almost any other window. @beginStyleTable @@ -40,8 +40,7 @@ @category{ctrl} @appearance{bitmapbutton.png} - @seealso - wxButton + @see wxButton */ class wxBitmapButton : public wxButton { @@ -184,7 +183,8 @@ public: /** Sets the bitmap to be shown when the mouse is over the button. - This function is new since wxWidgets version 2.7.0 and the hover bitmap is + + @wxsince{2.7.0} and the hover bitmap is currently only supported in wxMSW. @see GetBitmapHover() @@ -212,3 +212,4 @@ public: */ void SetBitmapSelected(const wxBitmap& bitmap); }; + diff --git a/interface/bmpcbox.h b/interface/bmpcbox.h index 5516946afe..86aeb32065 100644 --- a/interface/bmpcbox.h +++ b/interface/bmpcbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: bmpcbox.h -// Purpose: documentation for wxBitmapComboBox class +// Purpose: interface of wxBitmapComboBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -43,8 +43,7 @@ @category{ctrl} @appearance{bitmapcombobox.png} - @seealso - wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxCommandEvent + @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxCommandEvent */ class wxBitmapComboBox : public wxComboBox { @@ -171,3 +170,4 @@ public: */ void SetItemBitmap(unsigned int n, const wxBitmap& bitmap); }; + diff --git a/interface/brush.h b/interface/brush.h index 09399ea878..d644b1e19b 100644 --- a/interface/brush.h +++ b/interface/brush.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: brush.h -// Purpose: documentation for wxBrush class +// Purpose: interface of wxBrush // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,31 +18,10 @@ @category{gdi} @stdobjects - Objects: - wxNullBrush - Pointers: - wxBLUE_BRUSH + ::Objects:, ::wxNullBrush, ::Pointers:, ::wxBLUE_BRUSH, ::wxGREEN_BRUSH, + ::wxWHITE_BRUSH, ::wxBLACK_BRUSH, ::wxGREY_BRUSH, ::wxMEDIUM_GREY_BRUSH, ::wxLIGHT_GREY_BRUSH, ::wxTRANSPARENT_BRUSH, ::wxCYAN_BRUSH, ::wxRED_BRUSH, - wxGREEN_BRUSH - - wxWHITE_BRUSH - - wxBLACK_BRUSH - - wxGREY_BRUSH - - wxMEDIUM_GREY_BRUSH - - wxLIGHT_GREY_BRUSH - - wxTRANSPARENT_BRUSH - - wxCYAN_BRUSH - - wxRED_BRUSH - - @seealso - wxBrushList, wxDC, wxDC::SetBrush + @see wxBrushList, wxDC, wxDC::SetBrush */ class wxBrush : public wxGDIObject { @@ -432,3 +411,73 @@ public: */ bool operator ==(const wxBrush& brush); }; + + +/** + FIXME +*/ +wxBrush Objects: +; + +/** + FIXME +*/ +wxBrush wxNullBrush; + +/** + FIXME +*/ +wxBrush Pointers: +; + +/** + FIXME +*/ +wxBrush wxBLUE_BRUSH; + +/** + FIXME +*/ +wxBrush wxGREEN_BRUSH; + +/** + FIXME +*/ +wxBrush wxWHITE_BRUSH; + +/** + FIXME +*/ +wxBrush wxBLACK_BRUSH; + +/** + FIXME +*/ +wxBrush wxGREY_BRUSH; + +/** + FIXME +*/ +wxBrush wxMEDIUM_GREY_BRUSH; + +/** + FIXME +*/ +wxBrush wxLIGHT_GREY_BRUSH; + +/** + FIXME +*/ +wxBrush wxTRANSPARENT_BRUSH; + +/** + FIXME +*/ +wxBrush wxCYAN_BRUSH; + +/** + FIXME +*/ +wxBrush wxRED_BRUSH; + + diff --git a/interface/buffer.h b/interface/buffer.h index c29919daf0..f46b11387d 100644 --- a/interface/buffer.h +++ b/interface/buffer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: buffer.h -// Purpose: documentation for wxMemoryBuffer class +// Purpose: interface of wxMemoryBuffer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -110,3 +110,4 @@ public: */ void UngetWriteBuf(size_t sizeUsed); }; + diff --git a/interface/busyinfo.h b/interface/busyinfo.h index cc68c8c65e..4290bd6ce5 100644 --- a/interface/busyinfo.h +++ b/interface/busyinfo.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: busyinfo.h -// Purpose: documentation for wxBusyInfo class +// Purpose: interface of wxBusyInfo // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -70,3 +70,4 @@ public: */ ~wxBusyInfo(); }; + diff --git a/interface/button.h b/interface/button.h index 5fb95e80c8..4bbb9134ba 100644 --- a/interface/button.h +++ b/interface/button.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: button.h -// Purpose: documentation for wxButton class +// Purpose: interface of wxButton // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -12,7 +12,7 @@ A button is a control that contains a text string, and is one of the most common elements of a GUI. It may be placed on a - @ref overview_wxdialog "dialog box" or panel, or indeed + @ref overview_wxdialog "dialog box" or panel(), or indeed almost any other window. @beginStyleTable @@ -41,8 +41,7 @@ @category{ctrl} @appearance{button.png} - @seealso - wxBitmapButton + @see wxBitmapButton */ class wxButton : public wxControl { @@ -140,3 +139,4 @@ public: */ void SetLabel(const wxString& label); }; + diff --git a/interface/calctrl.h b/interface/calctrl.h index 707f116c49..ad461f0899 100644 --- a/interface/calctrl.h +++ b/interface/calctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: calctrl.h -// Purpose: documentation for wxCalendarEvent class +// Purpose: interface of wxCalendarEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,7 @@ @library{wxadv} @category{events} - @seealso - wxCalendarCtrl + @see wxCalendarCtrl */ class wxCalendarEvent : public wxDateEvent { @@ -37,6 +36,7 @@ public: }; + /** @class wxCalendarDateAttr @wxheader{calctrl.h} @@ -47,8 +47,7 @@ public: @library{wxadv} @category{misc} - @seealso - wxCalendarCtrl + @see wxCalendarCtrl */ class wxCalendarDateAttr { @@ -73,7 +72,7 @@ public: const wxColour GetBackgroundColour() const; /** - Returns the border to use for the item with this attribute. + Returns the border() to use for the item with this attribute. */ wxCalendarDateBorder GetBorder() const; @@ -156,6 +155,7 @@ public: }; + /** @class wxCalendarCtrl @wxheader{calctrl.h} @@ -208,8 +208,7 @@ public: @category{ctrl} @appearance{calendarctrl.png} - @seealso - @ref overview_samplecalendar "Calendar sample", wxCalendarDateAttr, + @see @ref overview_samplecalendar "Calendar sample", wxCalendarDateAttr, wxCalendarEvent */ class wxCalendarCtrl : public wxControl @@ -321,7 +320,7 @@ public: /** Returns one of @c wxCAL_HITTEST_XXX - constants and fills either @a date or + constants() and fills either @a date or @a wd pointer with the corresponding value depending on the hit test code. */ wxCalendarHitTestResult HitTest(const wxPoint& pos, @@ -369,3 +368,4 @@ public: void SetHolidayColours(const wxColour& colFg, const wxColour& colBg); }; + diff --git a/interface/caret.h b/interface/caret.h index cc9b5aec58..5a6248b3fe 100644 --- a/interface/caret.h +++ b/interface/caret.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: caret.h -// Purpose: documentation for wxCaret class +// Purpose: interface of wxCaret // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxcore} @category{misc} - @seealso - wxCaret::GetBlinkTime + @see wxCaret::GetBlinkTime */ class wxCaret { @@ -145,3 +144,4 @@ public: */ void Show(bool show = true); }; + diff --git a/interface/chartype.h b/interface/chartype.h index 6ac118fe37..4e8d4e4d57 100644 --- a/interface/chartype.h +++ b/interface/chartype.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: chartype.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -38,7 +38,7 @@ const wxChar* wxT(const char* s); current build, but using it can be beneficial in performance-sensitive code to do the conversion at compile-time instead. - @see wxT + @see wxT() */ wxStringCharType wxS(char ch); const wxStringCharType* wxS(const char* s); diff --git a/interface/checkbox.h b/interface/checkbox.h index 81757d0f8e..5ee0b90c6e 100644 --- a/interface/checkbox.h +++ b/interface/checkbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: checkbox.h -// Purpose: documentation for wxCheckBox class +// Purpose: interface of wxCheckBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -39,8 +39,7 @@ @category{ctrl} @appearance{checkbox.png} - @seealso - wxRadioButton, wxCommandEvent + @see wxRadioButton, wxCommandEvent */ class wxCheckBox : public wxControl { @@ -148,3 +147,4 @@ public: */ void SetValue(bool state); }; + diff --git a/interface/checklst.h b/interface/checklst.h index 3fd990b9ec..aa5e0db926 100644 --- a/interface/checklst.h +++ b/interface/checklst.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: checklst.h -// Purpose: documentation for wxCheckListBox class +// Purpose: interface of wxCheckListBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -30,8 +30,7 @@ @category{ctrl} @appearance{checklistbox.png} - @seealso - wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent + @see wxListBox, wxChoice, wxComboBox, wxListCtrl, wxCommandEvent */ class wxCheckListBox : public wxListBox { @@ -95,3 +94,4 @@ public: */ void Check(int item, bool check = true); }; + diff --git a/interface/choicdlg.h b/interface/choicdlg.h index 138c60c88f..969b77c2d8 100644 --- a/interface/choicdlg.h +++ b/interface/choicdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: choicdlg.h -// Purpose: documentation for wxMultiChoiceDialog class +// Purpose: interface of wxMultiChoiceDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,7 @@ @library{wxbase} @category{cmndlg} - @seealso - @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview", + @see @ref overview_wxmultichoicedialogoverview "wxMultiChoiceDialog overview", wxSingleChoiceDialog */ class wxMultiChoiceDialog : public wxDialog @@ -118,6 +117,7 @@ public: }; + /** @class wxSingleChoiceDialog @wxheader{choicdlg.h} @@ -129,9 +129,8 @@ public: @library{wxbase} @category{cmndlg} - @seealso - @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog overview", - wxMultiChoiceDialog + @see @ref overview_wxsinglechoicedialogoverview "wxSingleChoiceDialog + overview", wxMultiChoiceDialog */ class wxSingleChoiceDialog : public wxDialog { @@ -246,6 +245,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -281,7 +281,7 @@ int wxGetSingleChoiceIndex(const wxString& message, Pops up a dialog box containing a message, OK/Cancel buttons and a single-selection listbox. The user may choose an item and press OK to return a string or Cancel to return the empty string. Use - wxGetSingleChoiceIndex if empty string is a + wxGetSingleChoiceIndex() if empty string is a valid choice and if you want to be able to detect pressing Cancel reliably. You may pass the list of strings to choose from either using @e choices which is an array of @a n strings for the listbox or by using a single diff --git a/interface/choice.h b/interface/choice.h index 2661f638bd..03fa0cfc3f 100644 --- a/interface/choice.h +++ b/interface/choice.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: choice.h -// Purpose: documentation for wxChoice class +// Purpose: interface of wxChoice // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @category{ctrl} @appearance{choice.png} - @seealso - wxListBox, wxComboBox, wxCommandEvent + @see wxListBox, wxComboBox, wxCommandEvent */ class wxChoice : public wxControlWithItems { @@ -118,7 +117,8 @@ public: That is, while the dropdown list is shown, it returns the currently selected item in it. When it is not shown, its result is the same as for the other function. - This function is new since wxWidgets version 2.6.2 (before this version + + @wxsince{2.6.2} (before this version wxControlWithItems::GetSelection itself behaved like this). */ @@ -132,3 +132,4 @@ public: */ void SetColumns(int n = 1); }; + diff --git a/interface/choicebk.h b/interface/choicebk.h index 68e312a21c..4482f14dc2 100644 --- a/interface/choicebk.h +++ b/interface/choicebk.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: choicebk.h -// Purpose: documentation for wxChoicebook class +// Purpose: interface of wxChoicebook // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -42,8 +42,7 @@ @library{wxcore} @category{miscwnd} - @seealso - wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample" + @see wxBookCtrl(), wxNotebook, @ref overview_samplenotebook "notebook sample" */ class wxChoicebook : public wxBookCtrl overview { @@ -60,3 +59,4 @@ public: const wxString& name = wxEmptyStr); //@} }; + diff --git a/interface/clipboard.h b/interface/clipboard.h index 563e2bed1b..5bdd0038ac 100644 --- a/interface/clipboard.h +++ b/interface/clipboard.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: clipboard.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license diff --git a/interface/clipbrd.h b/interface/clipbrd.h index 17598cf70b..77e6dac932 100644 --- a/interface/clipbrd.h +++ b/interface/clipbrd.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: clipbrd.h -// Purpose: documentation for wxClipboard class +// Purpose: interface of wxClipboard // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -56,8 +56,7 @@ @library{wxcore} @category{dnd} - @seealso - @ref overview_wxdndoverview, wxDataObject + @see @ref overview_wxdndoverview, wxDataObject */ class wxClipboard : public wxObject { @@ -162,3 +161,4 @@ public: */ void UsePrimarySelection(bool primary = true); }; + diff --git a/interface/clntdata.h b/interface/clntdata.h index 163cc6d718..0b39286033 100644 --- a/interface/clntdata.h +++ b/interface/clntdata.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: clntdata.h -// Purpose: documentation for wxClientDataContainer class +// Purpose: interface of wxClientDataContainer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxEvtHandler, wxClientData + @see wxEvtHandler, wxClientData */ class wxClientDataContainer { @@ -62,6 +61,7 @@ public: }; + /** @class wxClientData @wxheader{clntdata.h} @@ -92,8 +92,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxEvtHandler, wxTreeItemData, wxStringClientData, wxClientDataContainer + @see wxEvtHandler, wxTreeItemData, wxStringClientData, wxClientDataContainer */ class wxClientData { @@ -110,6 +109,7 @@ public: }; + /** @class wxStringClientData @wxheader{clntdata.h} @@ -140,3 +140,4 @@ public: */ void SetData(const wxString& data); }; + diff --git a/interface/clrpicker.h b/interface/clrpicker.h index ba82dfa0cd..78c1059c08 100644 --- a/interface/clrpicker.h +++ b/interface/clrpicker.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: clrpicker.h -// Purpose: documentation for wxColourPickerCtrl class +// Purpose: interface of wxColourPickerCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -35,8 +35,7 @@ @category{miscpickers} @appearance{colourpickerctrl.png} - @seealso - wxColourDialog, wxColourPickerEvent + @see wxColourDialog, wxColourPickerEvent */ class wxColourPickerCtrl : public wxPickerBase { @@ -97,6 +96,7 @@ public: }; + /** @class wxColourPickerEvent @wxheader{clrpicker.h} @@ -107,8 +107,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxColourPickerCtrl + @see wxColourPickerCtrl */ class wxColourPickerEvent : public wxCommandEvent { @@ -129,3 +128,4 @@ public: */ void SetColour(const wxColour& pos); }; + diff --git a/interface/cmdline.h b/interface/cmdline.h index e9b5318693..1345a6ea41 100644 --- a/interface/cmdline.h +++ b/interface/cmdline.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: cmdline.h -// Purpose: documentation for wxCmdLineParser class +// Purpose: interface of wxCmdLineParser // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -58,8 +58,7 @@ @library{wxbase} @category{appmanagement} - @seealso - wxApp::argc and wxApp::argv, console sample + @see wxApp::argc and wxApp::argv, console sample */ class wxCmdLineParser { @@ -289,3 +288,4 @@ public: */ void Usage(); }; + diff --git a/interface/cmdproc.h b/interface/cmdproc.h index e6fca428a8..21b5adc151 100644 --- a/interface/cmdproc.h +++ b/interface/cmdproc.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: cmdproc.h -// Purpose: documentation for wxCommand class +// Purpose: interface of wxCommand // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxcore} @category{FIXME} - @seealso - Overview + @see Overview() */ class wxCommand : public wxObject { @@ -81,6 +80,7 @@ public: }; + /** @class wxCommandProcessor @wxheader{cmdproc.h} @@ -92,8 +92,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - @ref overview_wxcommandprocessoroverview "wxCommandProcessor overview", + @see @ref overview_wxcommandprocessoroverview "wxCommandProcessor overview", wxCommand */ class wxCommandProcessor : public wxObject @@ -226,3 +225,4 @@ public: */ virtual bool Undo(); }; + diff --git a/interface/cmndata.h b/interface/cmndata.h index 2317ab42ce..2e3889a5e1 100644 --- a/interface/cmndata.h +++ b/interface/cmndata.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: cmndata.h -// Purpose: documentation for wxFontData class +// Purpose: interface of wxFontData // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,7 @@ @library{wxcore} @category{FIXME} - @seealso - Overview, wxFont, wxFontDialog + @see Overview(), wxFont, wxFontDialog */ class wxFontData : public wxObject { @@ -120,6 +119,7 @@ public: }; + /** @class wxPageSetupDialogData @wxheader{cmndata.h} @@ -133,8 +133,8 @@ public: @library{wxcore} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", wxPageSetupDialog + @see @ref overview_printingoverview "Printing framework overview", + wxPageSetupDialog */ class wxPageSetupDialogData : public wxObject { @@ -332,6 +332,7 @@ public: }; + /** @class wxColourData @wxheader{cmndata.h} @@ -341,9 +342,8 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxColour, wxColourDialog, @ref overview_wxcolourdialogoverview "wxColourDialog - overview" + @see wxColour, wxColourDialog, @ref overview_wxcolourdialogoverview + "wxColourDialog overview" */ class wxColourData : public wxObject { @@ -411,6 +411,7 @@ public: }; + /** @class wxPrintData @wxheader{cmndata.h} @@ -424,9 +425,8 @@ public: @library{wxcore} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", wxPrintDialog, - wxPageSetupDialog, wxPrintDialogData, wxPageSetupDialogData, @ref overview_wxprintdialogoverview "wxPrintDialog Overview", wxPrinterDC, wxPostScriptDC + @see @ref overview_printingoverview "Printing framework overview", + wxPrintDialog, wxPageSetupDialog, wxPrintDialogData, wxPageSetupDialogData, @ref overview_wxprintdialogoverview "wxPrintDialog Overview", wxPrinterDC, wxPostScriptDC */ class wxPrintData : public wxObject { @@ -575,6 +575,7 @@ public: }; + /** @class wxPrintDialogData @wxheader{cmndata.h} @@ -586,9 +587,8 @@ public: @library{wxcore} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", wxPrintDialog, - @ref overview_wxprintdialogoverview "wxPrintDialog Overview" + @see @ref overview_printingoverview "Printing framework overview", + wxPrintDialog, @ref overview_wxprintdialogoverview "wxPrintDialog Overview" */ class wxPrintDialogData : public wxObject { @@ -748,3 +748,4 @@ public: void operator =(const wxPrintDialogData& data); //@} }; + diff --git a/interface/collpane.h b/interface/collpane.h index 1be941d5b8..982fd00842 100644 --- a/interface/collpane.h +++ b/interface/collpane.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: collpane.h -// Purpose: documentation for wxCollapsiblePaneEvent class +// Purpose: interface of wxCollapsiblePaneEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxCollapsiblePane + @see wxCollapsiblePane */ class wxCollapsiblePaneEvent : public wxCommandEvent { @@ -42,6 +41,7 @@ public: }; + /** @class wxCollapsiblePane @wxheader{collpane.h} @@ -96,8 +96,7 @@ public: @category{ctrl} @appearance{collapsiblepane.png} - @seealso - wxPanel, wxCollapsiblePaneEvent + @see wxPanel, wxCollapsiblePaneEvent */ class wxCollapsiblePane : public wxControl { @@ -170,3 +169,4 @@ public: */ bool IsExpanded() const; }; + diff --git a/interface/colordlg.h b/interface/colordlg.h index b5df29b264..d4ee56f3d1 100644 --- a/interface/colordlg.h +++ b/interface/colordlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: colordlg.h -// Purpose: documentation for wxColourDialog class +// Purpose: interface of wxColourDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,9 +15,8 @@ @library{wxcore} @category{cmndlg} - @seealso - @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour, - wxColourData, wxGetColourFromUser + @see @ref overview_wxcolourdialogoverview "wxColourDialog Overview", wxColour, + wxColourData, wxGetColourFromUser() */ class wxColourDialog : public wxDialog { @@ -58,6 +57,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/colour.h b/interface/colour.h index b9d4ff34d8..9df414c4c7 100644 --- a/interface/colour.h +++ b/interface/colour.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: colour.h -// Purpose: documentation for wxColour class +// Purpose: interface of wxColour // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,25 +24,10 @@ @category{gdi} @stdobjects - Objects: - wxNullColour - Pointers: - wxBLACK + ::Objects:, ::wxNullColour, ::Pointers:, ::wxBLACK, ::wxWHITE, ::wxRED, + ::wxBLUE, ::wxGREEN, ::wxCYAN, ::wxLIGHT_GREY, - wxWHITE - - wxRED - - wxBLUE - - wxGREEN - - wxCYAN - - wxLIGHT_GREY - - @seealso - wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings + @see wxColourDatabase, wxPen, wxBrush, wxColourDialog, wxSystemSettings */ class wxColour : public wxObject { @@ -90,7 +75,8 @@ public: /** is not specified in flags. - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ wxString GetAsString(long flags); const wxC2S_NAME, to obtain the colour name (e.g. @@ -133,12 +119,13 @@ public: Sets the RGB intensity values using the given values (first overload), extracting them from the packed long (second overload), using the given string (third overloard). When using third form, Set() accepts: colour names (those listed in - wxTheColourDatabase), the CSS-like + wxTheColourDatabase()), the CSS-like @c "rgb(r,g,b)" or @c "rgba(r,g,b,a)" syntax (case insensitive) and the HTML-like syntax (i.e. @c "#" followed by 6 hexadecimal digits for red, green, blue components). Returns @true if the conversion was successful, @false otherwise. - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ void Set(unsigned char red, unsigned char green, unsigned char blue, @@ -169,3 +156,58 @@ public: */ bool operator ==(const wxColour& colour); }; + + +/** + FIXME +*/ +wxColour Objects: +; + +/** + FIXME +*/ +wxColour wxNullColour; + +/** + FIXME +*/ +wxColour Pointers: +; + +/** + FIXME +*/ +wxColour wxBLACK; + +/** + FIXME +*/ +wxColour wxWHITE; + +/** + FIXME +*/ +wxColour wxRED; + +/** + FIXME +*/ +wxColour wxBLUE; + +/** + FIXME +*/ +wxColour wxGREEN; + +/** + FIXME +*/ +wxColour wxCYAN; + +/** + FIXME +*/ +wxColour wxLIGHT_GREY; + + diff --git a/interface/combo.h b/interface/combo.h index e007048c24..3ef6bff178 100644 --- a/interface/combo.h +++ b/interface/combo.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: combo.h -// Purpose: documentation for wxComboPopup class +// Purpose: interface of wxComboPopup // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxComboCtrl + @see wxComboCtrl */ class wxComboPopup { @@ -144,6 +143,7 @@ public: }; + /** @class wxComboCtrl @wxheader{combo.h} @@ -184,8 +184,7 @@ public: @category{ctrl} @appearance{comboctrl.png} - @seealso - wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup, wxCommandEvent + @see wxComboBox, wxChoice, wxOwnerDrawnComboBox, wxComboPopup, wxCommandEvent */ class wxComboCtrl : public wxControl { @@ -622,3 +621,4 @@ public: */ void UseAltPopupWindow(bool enable = true); }; + diff --git a/interface/combobox.h b/interface/combobox.h index a3d2dc584a..d987a8c0b1 100644 --- a/interface/combobox.h +++ b/interface/combobox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: combobox.h -// Purpose: documentation for wxComboBox class +// Purpose: interface of wxComboBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -58,8 +58,7 @@ @category{ctrl} @appearance{combobox.png} - @seealso - wxListBox, wxTextCtrl, wxChoice, wxCommandEvent + @see wxListBox, wxTextCtrl, wxChoice, wxCommandEvent */ class wxComboBox : public wxControlWithItems { @@ -289,3 +288,4 @@ public: */ void Undo(); }; + diff --git a/interface/config.h b/interface/config.h index 6fe45f090b..d6630c659d 100644 --- a/interface/config.h +++ b/interface/config.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: config.h -// Purpose: documentation for wxConfigBase class +// Purpose: interface of wxConfigBase // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -83,7 +83,8 @@ public: flag, which changes the default local configuration file to ~/.appname/appname should be used. Notice that this flag is ignored if localFilename is - provided. This function is new since wxWidgets version 2.8.2 + provided. + @wxsince{2.8.2} For wxFileConfig, you can also add wxCONFIG_USE_NO_ESCAPE_CHARACTERS which will turn off character escaping for the values of entries stored in the config @@ -299,8 +300,8 @@ public: Currently, supported types of data are: wxString, @e long, @e double, @e bool, wxColour and any other types, - for which functions wxToString - and wxFromString are defined. + for which functions wxToString() + and wxFromString() are defined. Try not to read long values into string variables and vice versa: although it just might work with wxFileConfig, you will get a system error with wxRegConfig because in the Windows registry the different types of entries are @@ -377,7 +378,7 @@ public: //@{ /** Reads a value of type T, for which function - wxFromString is defined, + wxFromString() is defined, returning @true if the value was found. If the value was not found, @a defaultVal is used instead. bool Read(const wxStringkey, T* value) const; @@ -440,7 +441,7 @@ public: /** Reads a value of type T, for which function - wxFromString is defined, from the key and returns it. + wxFromString() is defined, from the key and returns it. @a defaultVal is returned if the key is not found. */ T ReadObject(const wxString& key, T const& defaultVal) const; @@ -548,7 +549,7 @@ public: //@{ /** These functions write the specified value to the config file and return @true - on success. In the last one, function wxToString must be + on success. In the last one, function wxToString() must be defined for type @e T. @@ -576,3 +577,4 @@ public: bool Write(const wxString& key, const T& buf); //@} }; + diff --git a/interface/control.h b/interface/control.h index 862d4795fc..7bdba6b7be 100644 --- a/interface/control.h +++ b/interface/control.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: control.h -// Purpose: documentation for wxControl class +// Purpose: interface of wxControl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -19,8 +19,7 @@ @category{ctrl} @appearance{control.png} - @seealso - wxValidator + @see wxValidator */ class wxControl : public wxWindow { @@ -58,3 +57,4 @@ public: */ void SetLabel(const wxString& label); }; + diff --git a/interface/convauto.h b/interface/convauto.h index abd98afcb0..3cf6148745 100644 --- a/interface/convauto.h +++ b/interface/convauto.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: convauto.h -// Purpose: documentation for wxConvAuto class +// Purpose: interface of wxConvAuto // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -42,8 +42,7 @@ @library{wxbase} @category{FIXME} - @seealso - @ref overview_mbconvclasses "wxMBConv classes overview" + @see @ref overview_mbconvclasses "wxMBConv classes overview" */ class wxConvAuto : public wxMBConv { @@ -95,3 +94,4 @@ public: */ static void SetFallbackEncoding(wxFontEncoding enc); }; + diff --git a/interface/cpp.h b/interface/cpp.h index 38898b058c..f176322202 100644 --- a/interface/cpp.h +++ b/interface/cpp.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: cpp.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,16 +24,16 @@ Returns the string representation of the given symbol which can be either a literal or a macro (hence the advantage of using this macro instead of the standard preprocessor @c # operator which doesn't work with macros). Notice that this macro always produces a @c char string, use -wxSTRINGIZE_T to build a wide string Unicode build. +wxSTRINGIZE_T() to build a wide string Unicode build. -@see wxCONCAT +@see wxCONCAT() */ #define wxSTRINGIZE(x) /* implementation is private */ /** Returns the string representation of the given symbol as either an ASCII or Unicode string, depending on the current build. This is the Unicode-friendly - equivalent of wxSTRINGIZE. + equivalent of wxSTRINGIZE(). */ #define wxSTRINGIZE_T(x) /* implementation is private */ diff --git a/interface/cshelp.h b/interface/cshelp.h index 821fe2bd0a..1790f218a1 100644 --- a/interface/cshelp.h +++ b/interface/cshelp.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: cshelp.h -// Purpose: documentation for wxHelpProvider class +// Purpose: interface of wxHelpProvider // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -20,8 +20,7 @@ @library{wxcore} @category{help} - @seealso - wxContextHelp, wxContextHelpButton, wxSimpleHelpProvider, + @see wxContextHelp, wxContextHelpButton, wxSimpleHelpProvider, wxHelpControllerHelpProvider, wxWindow::SetHelpText, wxWindow::GetHelpTextAtPoint */ class wxHelpProvider @@ -98,6 +97,7 @@ public: }; + /** @class wxHelpControllerHelpProvider @wxheader{cshelp.h} @@ -119,9 +119,8 @@ public: @library{wxcore} @category{help} - @seealso - wxHelpProvider, wxSimpleHelpProvider, wxContextHelp, wxWindow::SetHelpText, - wxWindow::GetHelpTextAtPoint + @see wxHelpProvider, wxSimpleHelpProvider, wxContextHelp, + wxWindow::SetHelpText, wxWindow::GetHelpTextAtPoint */ class wxHelpControllerHelpProvider : public wxSimpleHelpProvider { @@ -144,6 +143,7 @@ public: }; + /** @class wxContextHelp @wxheader{cshelp.h} @@ -180,8 +180,7 @@ public: @library{wxcore} @category{help} - @seealso - wxHelpEvent, wxHelpController, wxContextHelpButton + @see wxHelpEvent, wxHelpController, wxContextHelpButton */ class wxContextHelp : public wxObject { @@ -214,6 +213,7 @@ public: }; + /** @class wxContextHelpButton @wxheader{cshelp.h} @@ -232,8 +232,7 @@ public: @library{wxcore} @category{help} - @seealso - wxBitmapButton, wxContextHelp + @see wxBitmapButton, wxContextHelp */ class wxContextHelpButton : public wxBitmapButton { @@ -265,6 +264,7 @@ public: }; + /** @class wxSimpleHelpProvider @wxheader{cshelp.h} @@ -276,8 +276,7 @@ public: @library{wxcore} @category{help} - @seealso - wxHelpProvider, wxHelpControllerHelpProvider, wxContextHelp, + @see wxHelpProvider, wxHelpControllerHelpProvider, wxContextHelp, wxWindow::SetHelpText, wxWindow::GetHelpTextAtPoint */ class wxSimpleHelpProvider : public wxHelpProvider @@ -285,3 +284,4 @@ class wxSimpleHelpProvider : public wxHelpProvider public: }; + diff --git a/interface/ctrlsub.h b/interface/ctrlsub.h index 06915e5165..50067dc7c0 100644 --- a/interface/ctrlsub.h +++ b/interface/ctrlsub.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: ctrlsub.h -// Purpose: documentation for wxControlWithItems class +// Purpose: interface of wxControlWithItems // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -35,8 +35,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxControlWithItems::Clear + @see wxControlWithItems::Clear */ class wxControlWithItems : public wxControl { @@ -333,3 +332,4 @@ public: */ bool SetStringSelection(const wxString& string); }; + diff --git a/interface/cursor.h b/interface/cursor.h index a0f93b1514..ee6fc7ef0c 100644 --- a/interface/cursor.h +++ b/interface/cursor.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: cursor.h -// Purpose: documentation for wxCursor class +// Purpose: interface of wxCursor // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -28,17 +28,10 @@ @category{gdi} @stdobjects - Objects: - wxNullCursor - Pointers: - wxSTANDARD_CURSOR + ::Objects:, ::wxNullCursor, ::Pointers:, ::wxSTANDARD_CURSOR, + ::wxHOURGLASS_CURSOR, ::wxCROSS_CURSOR, - wxHOURGLASS_CURSOR - - wxCROSS_CURSOR - - @seealso - wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor + @see wxBitmap, wxIcon, wxWindow::SetCursor, ::wxSetCursor */ class wxCursor : public wxBitmap { @@ -467,3 +460,38 @@ public: */ wxCursor operator =(const wxCursor& cursor); }; + + +/** + FIXME +*/ +wxCursor Objects: +; + +/** + FIXME +*/ +wxCursor wxNullCursor; + +/** + FIXME +*/ +wxCursor Pointers: +; + +/** + FIXME +*/ +wxCursor wxSTANDARD_CURSOR; + +/** + FIXME +*/ +wxCursor wxHOURGLASS_CURSOR; + +/** + FIXME +*/ +wxCursor wxCROSS_CURSOR; + + diff --git a/interface/dataobj.h b/interface/dataobj.h index 9d95f7eb42..d162f93b4f 100644 --- a/interface/dataobj.h +++ b/interface/dataobj.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dataobj.h -// Purpose: documentation for wxCustomDataObject class +// Purpose: interface of wxCustomDataObject // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -30,8 +30,7 @@ @library{wxcore} @category{dnd} - @seealso - wxDataObject + @see wxDataObject */ class wxCustomDataObject : public wxDataObjectSimple { @@ -91,6 +90,7 @@ public: }; + /** @class wxDataObjectComposite @wxheader{dataobj.h} @@ -111,8 +111,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - @ref overview_wxdndoverview "Clipboard and drag and drop overview", + @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxBitmapDataObject */ class wxDataObjectComposite : public wxDataObject @@ -139,6 +138,7 @@ public: }; + /** @class wxDataObjectSimple @wxheader{dataobj.h} @@ -162,8 +162,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref + @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref overview_samplednd "DnD sample", wxFileDataObject, wxTextDataObject, wxBitmapDataObject */ class wxDataObjectSimple : public wxDataObject @@ -208,6 +207,7 @@ public: }; + /** @class wxBitmapDataObject @wxheader{dataobj.h} @@ -227,8 +227,7 @@ public: @library{wxcore} @category{dnd} - @seealso - @ref overview_wxdndoverview "Clipboard and drag and drop overview", + @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", wxDataObject, wxDataObjectSimple, wxFileDataObject, wxTextDataObject, wxDataObject */ class wxBitmapDataObject : public wxDataObjectSimple @@ -257,6 +256,7 @@ public: }; + /** @class wxDataFormat @wxheader{dataobj.h} @@ -331,8 +331,7 @@ public: @library{wxbase} @category{dnd} - @seealso - @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref + @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref overview_samplednd "DnD sample", wxDataObject */ class wxDataFormat @@ -377,6 +376,7 @@ public: }; + /** @class wxURLDataObject @wxheader{dataobj.h} @@ -392,8 +392,8 @@ public: @library{wxcore} @category{dnd} - @seealso - @ref overview_wxdndoverview "Clipboard and drag and drop overview", wxDataObject + @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", + wxDataObject */ class wxURLDataObject { @@ -416,6 +416,7 @@ public: }; + /** @class wxDataObject @wxheader{dataobj.h} @@ -531,7 +532,7 @@ public: translation under Windows is not yet finished. @b wxPython note: At this time this class is not directly usable from wxPython. - Derive a class from wxPyDataObjectSimple + Derive a class from wxPyDataObjectSimple() instead. @b wxPerl note: This class is not currently usable from wxPerl; you may @@ -540,8 +541,7 @@ public: @library{wxcore} @category{dnd} - @seealso - @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref + @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", @ref overview_samplednd "DnD sample", wxFileDataObject, wxTextDataObject, wxBitmapDataObject, wxCustomDataObject, wxDropTarget, wxDropSource, wxTextDropTarget, wxFileDropTarget */ class wxDataObject @@ -597,6 +597,7 @@ public: }; + /** @class wxTextDataObject @wxheader{dataobj.h} @@ -624,8 +625,7 @@ public: @library{wxcore} @category{dnd} - @seealso - @ref overview_wxdndoverview "Clipboard and drag and drop overview", + @see @ref overview_wxdndoverview "Clipboard and drag and drop overview", wxDataObject, wxDataObjectSimple, wxFileDataObject, wxBitmapDataObject */ class wxTextDataObject : public wxDataObjectSimple @@ -664,6 +664,7 @@ public: }; + /** @class wxFileDataObject @wxheader{dataobj.h} @@ -684,8 +685,7 @@ public: @library{wxcore} @category{dnd} - @seealso - wxDataObject, wxDataObjectSimple, wxTextDataObject, wxBitmapDataObject, + @see wxDataObject, wxDataObjectSimple, wxTextDataObject, wxBitmapDataObject, wxDataObject */ class wxFileDataObject : public wxDataObjectSimple @@ -702,7 +702,8 @@ public: virtual void AddFile(const wxString& file); /** - Returns the array of file names. + Returns the array() of file names. */ const wxArrayString GetFilenames() const; }; + diff --git a/interface/dataview.h b/interface/dataview.h index 1dbf777cf1..30454f221c 100644 --- a/interface/dataview.h +++ b/interface/dataview.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dataview.h -// Purpose: documentation for wxDataViewIconText class +// Purpose: interface of wxDataViewIconText // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -52,6 +52,7 @@ public: }; + /** @class wxDataViewEvent @wxheader{dataview.h} @@ -127,6 +128,7 @@ public: }; + /** @class wxDataViewIconTextRenderer @wxheader{dataview.h} @@ -152,6 +154,7 @@ public: }; + /** @class wxDataViewIndexListModel @wxheader{dataview.h} @@ -197,7 +200,7 @@ public: /** Oberride this to indicate that the row has special font attributes. This only affects the - wxDataViewTextRendererText renderer. + wxDataViewTextRendererText() renderer. See also wxDataViewItemAttr. */ bool GetAttr(unsigned int row, unsigned int col, @@ -272,6 +275,7 @@ public: }; + /** @class wxDataViewModel @wxheader{dataview.h} @@ -396,7 +400,7 @@ public: /** Oberride this to indicate that the item has special font attributes. This only affects the - wxDataViewTextRendererText renderer. + wxDataViewTextRendererText() renderer. See also wxDataViewItemAttr. */ bool GetAttr(const wxDataViewItem& item, unsigned int col, @@ -536,6 +540,7 @@ public: }; + /** @class wxDataViewCustomRenderer @wxheader{dataview.h} @@ -656,6 +661,7 @@ public: }; + /** @class wxDataViewBitmapRenderer @wxheader{dataview.h} @@ -676,17 +682,18 @@ public: }; + /** @class wxDataViewItemAttr @wxheader{dataview.h} This class is used to indicate to a wxDataViewCtrl - that a certain Item has extra font attributes + that a certain Item() has extra font attributes for its renderer. For this, it is required to override wxDataViewModel::GetAttr. Attributes are currently only supported by - wxDataViewTextRendererText. + wxDataViewTextRendererText(). @library{wxadv} @category{FIXME} @@ -717,6 +724,7 @@ public: }; + /** @class wxDataViewItem @wxheader{dataview.h} @@ -763,6 +771,7 @@ public: }; + /** @class wxDataViewCtrl @wxheader{dataview.h} @@ -1111,6 +1120,7 @@ public: }; + /** @class wxDataViewModelNotifier @wxheader{dataview.h} @@ -1198,6 +1208,7 @@ public: }; + /** @class wxDataViewRenderer @wxheader{dataview.h} @@ -1315,6 +1326,7 @@ public: }; + /** @class wxDataViewTextRenderer @wxheader{dataview.h} @@ -1336,6 +1348,7 @@ public: }; + /** @class wxDataViewProgressRenderer @wxheader{dataview.h} @@ -1357,6 +1370,7 @@ public: }; + /** @class wxDataViewSpinRenderer @wxheader{dataview.h} @@ -1381,6 +1395,7 @@ public: }; + /** @class wxDataViewToggleRenderer @wxheader{dataview.h} @@ -1401,6 +1416,7 @@ public: }; + /** @class wxDataViewTreeCtrl @wxheader{dataview.h} @@ -1591,6 +1607,7 @@ public: }; + /** @class wxDataViewTreeStore @wxheader{dataview.h} @@ -1735,6 +1752,7 @@ public: }; + /** @class wxDataViewDateRenderer @wxheader{dataview.h} @@ -1755,6 +1773,7 @@ public: }; + /** @class wxDataViewTextRendererAttr @wxheader{dataview.h} @@ -1781,6 +1800,7 @@ public: }; + /** @class wxDataViewColumn @wxheader{dataview.h} @@ -1906,3 +1926,4 @@ public: */ void SetTitle(const wxString& title); }; + diff --git a/interface/datectrl.h b/interface/datectrl.h index a4fa0ded8f..1a91b91454 100644 --- a/interface/datectrl.h +++ b/interface/datectrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: datectrl.h -// Purpose: documentation for wxDatePickerCtrl class +// Purpose: interface of wxDatePickerCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -52,8 +52,7 @@ @category{miscpickers} @appearance{datepickerctrl.png} - @seealso - wxCalendarCtrl, wxDateEvent + @see wxCalendarCtrl, wxDateEvent */ class wxDatePickerCtrl : public wxControl { @@ -154,3 +153,4 @@ public: */ void SetValue(const wxDateTime& dt); }; + diff --git a/interface/dateevt.h b/interface/dateevt.h index 63aa15f63b..13bb4bb7e5 100644 --- a/interface/dateevt.h +++ b/interface/dateevt.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dateevt.h -// Purpose: documentation for wxDateEvent class +// Purpose: interface of wxDateEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -31,3 +31,4 @@ public: */ void SetDate(const wxDateTime& date); }; + diff --git a/interface/datetime.h b/interface/datetime.h index 47cb2d0705..7b2ad9370c 100644 --- a/interface/datetime.h +++ b/interface/datetime.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: datetime.h -// Purpose: documentation for wxDateTime class +// Purpose: interface of wxDateTime // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,8 +15,7 @@ @library{wxbase} @category{data} - @seealso - @ref overview_wxdatetimeoverview "Date classes overview", wxTimeSpan, + @see @ref overview_wxdatetimeoverview "Date classes overview", wxTimeSpan, wxDateSpan, wxCalendarCtrl */ class wxDateTime @@ -205,7 +204,7 @@ public: static int ConvertYearToBC(int year); /** - These functions carry out arithmetics on the wxDateTime + These functions carry out arithmetics() on the wxDateTime objects. As explained in the overview, either wxTimeSpan or wxDateSpan may be added to wxDateTime, hence all functions are overloaded to accept both arguments. @@ -361,7 +360,8 @@ public: /** Returns the object having the same date component as this one but time of 00:00:00. - This function is new since wxWidgets version 2.8.2 + + @wxsince{2.8.2} @see ResetTime() */ @@ -1153,6 +1153,7 @@ public: }; + /** @class wxDateTimeWorkDays @wxheader{datetime.h} @@ -1168,6 +1169,7 @@ public: }; + /** @class wxDateSpan @wxheader{datetime.h} @@ -1210,8 +1212,7 @@ public: @library{wxbase} @category{data} - @seealso - @ref overview_wxdatetimeoverview "Date classes overview", wxDateTime + @see @ref overview_wxdatetimeoverview "Date classes overview", wxDateTime */ class wxDateSpan { @@ -1399,6 +1400,7 @@ public: }; + /** @class wxTimeSpan @wxheader{datetime.h} @@ -1408,8 +1410,7 @@ public: @library{wxbase} @category{data} - @seealso - @ref overview_wxdatetimeoverview "Date classes overview", wxDateTime + @see @ref overview_wxdatetimeoverview "Date classes overview", wxDateTime */ class wxTimeSpan { @@ -1728,6 +1729,7 @@ public: }; + /** @class wxDateTimeHolidayAuthority @wxheader{datetime.h} @@ -1741,3 +1743,4 @@ class wxDateTimeHolidayAuthority public: }; + diff --git a/interface/datstrm.h b/interface/datstrm.h index 3f6a8ead37..3c5ff21f5a 100644 --- a/interface/datstrm.h +++ b/interface/datstrm.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: datstrm.h -// Purpose: documentation for wxDataOutputStream class +// Purpose: interface of wxDataOutputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -121,6 +121,7 @@ public: }; + /** @class wxDataInputStream @wxheader{datstrm.h} @@ -254,3 +255,4 @@ public: */ wxString ReadString(); }; + diff --git a/interface/dc.h b/interface/dc.h index a0cbcba42c..d1b3b1ad3e 100644 --- a/interface/dc.h +++ b/interface/dc.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dc.h -// Purpose: documentation for wxDC class +// Purpose: interface of wxDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -30,8 +30,7 @@ @library{wxcore} @category{dc} - @seealso - Overview + @see Overview() */ class wxDC : public wxObject { @@ -468,7 +467,7 @@ public: /** Returns the depth (number of bits/pixel) of this DC. - @see wxDisplayDepth + @see wxDisplayDepth() */ int GetDepth() const; @@ -975,6 +974,7 @@ public: }; + /** @class wxDCClipper @wxheader{dc.h} @@ -1002,8 +1002,7 @@ public: @library{wxcore} @category{gdi} - @seealso - wxDC::SetClippingRegion + @see wxDC::SetClippingRegion */ class wxDCClipper { @@ -1020,3 +1019,4 @@ public: wxDCClipper(wxDC& dc, int x, int y, int w, int h); //@} }; + diff --git a/interface/dcbuffer.h b/interface/dcbuffer.h index 912e377389..083e7d9111 100644 --- a/interface/dcbuffer.h +++ b/interface/dcbuffer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcbuffer.h -// Purpose: documentation for wxBufferedDC class +// Purpose: interface of wxBufferedDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -38,8 +38,7 @@ @library{wxcore} @category{dc} - @seealso - wxDC, wxMemoryDC, wxBufferedPaintDC, wxAutoBufferedPaintDC + @see wxDC, wxMemoryDC, wxBufferedPaintDC, wxAutoBufferedPaintDC */ class wxBufferedDC : public wxMemoryDC { @@ -99,6 +98,7 @@ public: }; + /** @class wxAutoBufferedPaintDC @wxheader{dcbuffer.h} @@ -120,8 +120,7 @@ public: @library{wxbase} @category{dc} - @seealso - wxDC, wxBufferedPaintDC + @see wxDC, wxBufferedPaintDC */ class wxAutoBufferedPaintDC : public wxBufferedPaintDC { @@ -133,6 +132,7 @@ public: }; + /** @class wxBufferedPaintDC @wxheader{dcbuffer.h} @@ -152,8 +152,7 @@ public: @library{wxcore} @category{dc} - @seealso - wxDC, wxBufferedDC, wxAutoBufferedPaintDC + @see wxDC, wxBufferedDC, wxAutoBufferedPaintDC */ class wxBufferedPaintDC : public wxBufferedDC { @@ -182,3 +181,4 @@ public: object, using a wxPaintDC. */ }; + diff --git a/interface/dcclient.h b/interface/dcclient.h index ed929d005c..b39198cdf5 100644 --- a/interface/dcclient.h +++ b/interface/dcclient.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcclient.h -// Purpose: documentation for wxPaintDC class +// Purpose: interface of wxPaintDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxcore} @category{dc} - @seealso - wxDC, wxMemoryDC, wxPaintDC, wxWindowDC, wxScreenDC + @see wxDC, wxMemoryDC, wxPaintDC, wxWindowDC, wxScreenDC */ class wxPaintDC : public wxWindowDC { @@ -42,6 +41,7 @@ public: }; + /** @class wxClientDC @wxheader{dcclient.h} @@ -59,8 +59,7 @@ public: @library{wxcore} @category{dc} - @seealso - wxDC, wxMemoryDC, wxPaintDC, wxWindowDC, wxScreenDC + @see wxDC, wxMemoryDC, wxPaintDC, wxWindowDC, wxScreenDC */ class wxClientDC : public wxWindowDC { @@ -72,6 +71,7 @@ public: }; + /** @class wxWindowDC @wxheader{dcclient.h} @@ -92,8 +92,7 @@ public: @library{wxcore} @category{dc} - @seealso - wxDC, wxMemoryDC, wxPaintDC, wxClientDC, wxScreenDC + @see wxDC, wxMemoryDC, wxPaintDC, wxClientDC, wxScreenDC */ class wxWindowDC : public wxDC { @@ -103,3 +102,4 @@ public: */ wxWindowDC(wxWindow* window); }; + diff --git a/interface/dcmemory.h b/interface/dcmemory.h index af09579f06..0a866d07be 100644 --- a/interface/dcmemory.h +++ b/interface/dcmemory.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcmemory.h -// Purpose: documentation for wxMemoryDC class +// Purpose: interface of wxMemoryDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -19,8 +19,7 @@ @library{wxcore} @category{dc} - @seealso - wxBitmap, wxDC + @see wxBitmap, wxDC */ class wxMemoryDC : public wxDC { @@ -67,3 +66,4 @@ public: */ void SelectObjectAsSource(const wxBitmap& bitmap); }; + diff --git a/interface/dcmirror.h b/interface/dcmirror.h index c0ce2d50ed..24e77ba59e 100644 --- a/interface/dcmirror.h +++ b/interface/dcmirror.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcmirror.h -// Purpose: documentation for wxMirrorDC class +// Purpose: interface of wxMirrorDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -32,3 +32,4 @@ public: */ wxMirrorDC(wxDC& dc, bool mirror); }; + diff --git a/interface/dcprint.h b/interface/dcprint.h index 12ccf3dda1..075a943af5 100644 --- a/interface/dcprint.h +++ b/interface/dcprint.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcprint.h -// Purpose: documentation for wxPrinterDC class +// Purpose: interface of wxPrinterDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxcore} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", wxDC + @see @ref overview_printingoverview "Printing framework overview", wxDC */ class wxPrinterDC : public wxDC { @@ -52,3 +51,4 @@ public: */ wxRect wxPrinterDC::GetPaperRect(); }; + diff --git a/interface/dcps.h b/interface/dcps.h index 547e68ccd6..c93c6f8178 100644 --- a/interface/dcps.h +++ b/interface/dcps.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcps.h -// Purpose: documentation for wxPostScriptDC class +// Purpose: interface of wxPostScriptDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -52,6 +52,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/dcscreen.h b/interface/dcscreen.h index 7c4854c7ea..b5ced1dc28 100644 --- a/interface/dcscreen.h +++ b/interface/dcscreen.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcscreen.h -// Purpose: documentation for wxScreenDC class +// Purpose: interface of wxScreenDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,7 @@ @library{wxcore} @category{dc} - @seealso - wxDC, wxMemoryDC, wxPaintDC, wxClientDC, wxWindowDC + @see wxDC, wxMemoryDC, wxPaintDC, wxClientDC, wxWindowDC */ class wxScreenDC : public wxDC { @@ -65,3 +64,4 @@ public: bool StartDrawingOnTop(wxRect* rect = NULL); //@} }; + diff --git a/interface/dcsvg.h b/interface/dcsvg.h index 2b55869d70..459b0f314f 100644 --- a/interface/dcsvg.h +++ b/interface/dcsvg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dcsvg.h -// Purpose: documentation for wxSVGFileDC class +// Purpose: interface of wxSVGFileDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -36,8 +36,7 @@ @library{wxcore} @category{FIXME} - @seealso - @b Members + @see @b Members */ class wxSVGFileDC : public wxDC { @@ -648,3 +647,4 @@ public: */ bool StartDoc(const wxString& message); }; + diff --git a/interface/dde.h b/interface/dde.h index 2111e1a580..67efd41609 100644 --- a/interface/dde.h +++ b/interface/dde.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dde.h -// Purpose: documentation for wxDDEConnection class +// Purpose: interface of wxDDEConnection // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxDDEClient, wxDDEServer, @ref overview_ipcoverview "Interprocess + @see wxDDEClient, wxDDEServer, @ref overview_ipcoverview "Interprocess communications overview" */ class wxDDEConnection : public wxObject @@ -197,6 +196,7 @@ public: }; + /** @class wxDDEClient @wxheader{dde.h} @@ -218,8 +218,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxDDEServer, wxDDEConnection, @ref overview_ipcoverview "Interprocess + @see wxDDEServer, wxDDEConnection, @ref overview_ipcoverview "Interprocess communications overview" */ class wxDDEClient : public wxObject @@ -263,6 +262,7 @@ public: }; + /** @class wxDDEServer @wxheader{dde.h} @@ -277,8 +277,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxDDEClient, wxDDEConnection, @ref overview_ipcoverview "IPC overview" + @see wxDDEClient, wxDDEConnection, @ref overview_ipcoverview "IPC overview" */ class wxDDEServer { @@ -310,6 +309,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -318,7 +318,7 @@ public: Called when wxWidgets exits, to clean up the DDE system. This no longer needs to be called by the application. - See also wxDDEInitialize. + See also wxDDEInitialize(). */ void wxDDECleanUp(); @@ -327,7 +327,7 @@ void wxDDECleanUp(); This no longer needs to be called by the application: it will be called by wxWidgets if necessary. See also wxDDEServer, wxDDEClient, wxDDEConnection, - wxDDECleanUp. + wxDDECleanUp(). */ void wxDDEInitialize(); diff --git a/interface/debug.h b/interface/debug.h index 06a118f62f..e28aadd000 100644 --- a/interface/debug.h +++ b/interface/debug.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: debug.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -8,7 +8,7 @@ /** Will always generate an assert error if this code is reached (in debug mode). -See also: wxFAIL_MSG +See also: wxFAIL_MSG() */ wxFAIL(); @@ -16,7 +16,7 @@ wxFAIL(); /** This function is called whenever one of debugging macros fails (i.e. condition is @false in an assertion). It is only defined in the debug mode, in release -builds the wxCHECK failures don't result in anything. +builds the wxCHECK() failures don't result in anything. To override the default behaviour in the debug builds which is to show the user a dialog asking whether he wants to abort the program, continue or continue ignoring any subsequent assert failures, you may override @@ -43,7 +43,7 @@ void wxTrap(); it may be used in the "default:" branch of a switch statement if all possible cases are processed above. - @see wxFAIL + @see wxFAIL() */ #define wxFAIL_MSG(msg) /* implementation is private */ @@ -74,13 +74,13 @@ void wxTrap(); Assert macro with message. An error message will be generated if the condition is @false. - @see wxASSERT, wxCOMPILE_TIME_ASSERT + @see wxASSERT(), wxCOMPILE_TIME_ASSERT() */ #define wxASSERT_MSG(condition, msg) /* implementation is private */ /** - This is the same as wxCHECK2, but - wxFAIL_MSG with the specified @a msg is called + This is the same as wxCHECK2(), but + wxFAIL_MSG() with the specified @a msg is called instead of wxFAIL() if the @a condition is @false. */ #define wxCHECK2(condition, operation, msg) /* implementation is private */ @@ -91,7 +91,7 @@ void wxTrap(); Please note that the condition in wxASSERT() should have no side effects because it will not be executed in release mode at all. - @see wxASSERT_MSG, wxCOMPILE_TIME_ASSERT + @see wxASSERT_MSG(), wxCOMPILE_TIME_ASSERT() */ #define wxASSERT(condition) /* implementation is private */ @@ -99,24 +99,24 @@ void wxTrap(); Checks that the condition is @true, and returns if not (FAILs with given error message in debug mode). This check is done even in release mode. This macro should be used in void functions instead of - wxCHECK_MSG. + wxCHECK_MSG(). */ #define wxCHECK_RET(condition, msg) /* implementation is private */ /** - Checks that the condition is @true and wxFAIL and execute + Checks that the condition is @true and wxFAIL() and execute @a operation if it is not. This is a generalisation of - wxCHECK and may be used when something else than just + wxCHECK() and may be used when something else than just returning from the function must be done when the @a condition is @false. This check is done even in release mode. */ #define wxCHECK2(condition, operation) /* implementation is private */ /** - This macro is identical to wxCOMPILE_TIME_ASSERT2 + This macro is identical to wxCOMPILE_TIME_ASSERT2() except that it allows you to specify a unique @a name for the struct internally defined by this macro to avoid getting the compilation errors - described above. + described above(). */ #define wxCOMPILE_TIME_ASSERT(condition, msg, name) /* implementation is private */ @@ -125,7 +125,7 @@ void wxTrap(); (FAILs in debug mode). This check is done even in release mode. This macro may be only used in non-void functions, see also - wxCHECK_RET. + wxCHECK_RET(). */ #define wxCHECK_MSG(condition, retValue, msg) /* implementation is private */ @@ -141,13 +141,13 @@ void wxTrap(); unique by using the @c __LINE__ in it but it may still not work if you use it on the same line in two different source files. In this case you may either change the line in which either of them appears on or use the - wxCOMPILE_TIME_ASSERT2 macro. + wxCOMPILE_TIME_ASSERT2() macro. Also note that Microsoft Visual C++ has a bug which results in compiler errors if you use this macro with 'Program Database For Edit And Continue' (@c /ZI) option, so you shouldn't use it ('Program Database' (@c /Zi) is ok though) for the code making use of this macro. - @see wxASSERT_MSG, wxASSERT_MIN_BITSIZE + @see wxASSERT_MSG(), wxASSERT_MIN_BITSIZE() */ #define wxCOMPILE_TIME_ASSERT(condition, msg) /* implementation is private */ diff --git a/interface/debugrpt.h b/interface/debugrpt.h index 89e61a5d54..c79b13dcb8 100644 --- a/interface/debugrpt.h +++ b/interface/debugrpt.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: debugrpt.h -// Purpose: documentation for wxDebugReportPreview class +// Purpose: interface of wxDebugReportPreview // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -47,6 +47,7 @@ public: }; + /** @class wxDebugReportCompress @wxheader{debugrpt.h} @@ -73,6 +74,7 @@ public: }; + /** @class wxDebugReport @wxheader{debugrpt.h} @@ -80,7 +82,7 @@ public: wxDebugReport is used to generate a debug report, containing information about the program current state. It is usually used from wxApp::OnFatalException as shown in the - sample. + sample(). A wxDebugReport object contains one or more files. A few of them can be created by the @@ -259,6 +261,7 @@ public: }; + /** @class wxDebugReportPreviewStd @wxheader{debugrpt.h} @@ -287,6 +290,7 @@ public: }; + /** @class wxDebugReportUpload @wxheader{debugrpt.h} @@ -323,3 +327,4 @@ public: */ bool OnServerReply(); }; + diff --git a/interface/defs.h b/interface/defs.h index 972f52c6be..62c2f977f6 100644 --- a/interface/defs.h +++ b/interface/defs.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: defs.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -35,7 +35,7 @@ wxUint16 wxUINT16_SWAP_ON_LE(wxUint16 value); //@} /** - This macro is similar to wxDEPRECATED but can be used + This macro is similar to wxDEPRECATED() but can be used to not only declare the function @a func as deprecated but to also provide its (inline) implementation @e body. It can be used as following: @@ -131,7 +131,7 @@ wxUint16 wxUINT16_SWAP_ON_BE(wxUint16 value); void wxVaCopy(va_list argptrDst, va_list argptrSrc); /** - This is a special version of wxDEPRECATED macro which + This is a special version of wxDEPRECATED() macro which only does something when the deprecated function is used from the code outside wxWidgets itself but doesn't generate warnings when it is used from wxWidgets. It is used with the virtual functions which are called by the library itself -- diff --git a/interface/dialog.h b/interface/dialog.h index 757cda8305..7b6ba992a3 100644 --- a/interface/dialog.h +++ b/interface/dialog.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dialog.h -// Purpose: documentation for wxDialog class +// Purpose: interface of wxDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -60,8 +60,7 @@ @library{wxcore} @category{cmndlg} - @seealso - @ref overview_wxdialogoverview, wxFrame, @ref overview_validatoroverview + @see @ref overview_wxdialogoverview, wxFrame, @ref overview_validatoroverview "Validator overview" */ class wxDialog : public wxTopLevelWindow @@ -488,6 +487,7 @@ public: }; + /** @class wxDialogLayoutAdapter @wxheader{dialog.h} @@ -506,8 +506,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - @ref overview_autoscrollingdialogs "Automatic scrolling dialogs" + @see @ref overview_autoscrollingdialogs "Automatic scrolling dialogs" */ class wxDialogLayoutAdapter { @@ -529,3 +528,4 @@ public: */ bool DoLayoutAdaptation(wxDialog* dialog); }; + diff --git a/interface/dialup.h b/interface/dialup.h index 3605a60f07..04a37a0f16 100644 --- a/interface/dialup.h +++ b/interface/dialup.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dialup.h -// Purpose: documentation for wxDialUpManager class +// Purpose: interface of wxDialUpManager // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxcore} @category{net} - @seealso - @ref overview_sampledialup "dialup sample", wxDialUpEvent + @see @ref overview_sampledialup "dialup sample", wxDialUpEvent */ class wxDialUpManager { @@ -165,6 +164,7 @@ public: }; + /** @class wxDialUpEvent @wxheader{dialup.h} @@ -196,3 +196,4 @@ public: */ bool IsOwnEvent() const; }; + diff --git a/interface/dir.h b/interface/dir.h index dd7ba41d20..0009ab1b80 100644 --- a/interface/dir.h +++ b/interface/dir.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dir.h -// Purpose: documentation for wxDirTraverser class +// Purpose: interface of wxDirTraverser // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -78,6 +78,7 @@ public: }; + /** @class wxDir @wxheader{dir.h} @@ -203,7 +204,7 @@ public: big, it could be far from real size of the directory. See also: wxFileName::GetHumanReadableSize, - wxGetDiskSpace + wxGetDiskSpace() */ static wxULongLong GetTotalSize(const wxString& dir, wxArrayString* filesSkipped = NULL); @@ -253,3 +254,4 @@ public: const wxString& filespec = wxEmptyString, int flags = wxDIR_DEFAULT); }; + diff --git a/interface/dirctrl.h b/interface/dirctrl.h index 31260aab49..360e44991a 100644 --- a/interface/dirctrl.h +++ b/interface/dirctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dirctrl.h -// Purpose: documentation for wxGenericDirCtrl class +// Purpose: interface of wxGenericDirCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -172,3 +172,4 @@ public: */ void ShowHidden(bool show); }; + diff --git a/interface/dirdlg.h b/interface/dirdlg.h index ca177ae564..c5e55a3a12 100644 --- a/interface/dirdlg.h +++ b/interface/dirdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dirdlg.h -// Purpose: documentation for wxDirDialog class +// Purpose: interface of wxDirDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxcore} @category{cmndlg} - @seealso - @ref overview_wxdirdialogoverview "wxDirDialog overview", wxFileDialog + @see @ref overview_wxdirdialogoverview "wxDirDialog overview", wxFileDialog */ class wxDirDialog : public wxDialog { @@ -95,6 +94,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/display.h b/interface/display.h index be0f8755da..ce3d62c704 100644 --- a/interface/display.h +++ b/interface/display.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: display.h -// Purpose: documentation for wxDisplay class +// Purpose: interface of wxDisplay // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,8 +15,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxClientDisplayRect, wxDisplaySize, wxDisplaySizeMM + @see wxClientDisplayRect(), wxDisplaySize(), wxDisplaySizeMM() */ class wxDisplay { @@ -120,3 +119,4 @@ public: */ bool IsPrimary(); }; + diff --git a/interface/dnd.h b/interface/dnd.h index f92bbe4c3b..6122d1ac25 100644 --- a/interface/dnd.h +++ b/interface/dnd.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dnd.h -// Purpose: documentation for wxTextDropTarget class +// Purpose: interface of wxTextDropTarget // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,8 +15,7 @@ @library{wxcore} @category{dnd} - @seealso - @ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxFileDropTarget + @see @ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxFileDropTarget */ class wxTextDropTarget : public wxDropTarget { @@ -47,6 +46,7 @@ public: }; + /** @class wxDropTarget @wxheader{dnd.h} @@ -73,8 +73,8 @@ public: @library{wxcore} @category{dnd} - @seealso - wxDropSource, wxTextDropTarget, wxFileDropTarget, wxDataFormat, wxDataObject + @see wxDropSource, wxTextDropTarget, wxFileDropTarget, wxDataFormat, + wxDataObject */ class wxDropTarget { @@ -168,6 +168,7 @@ public: }; + /** @class wxDropSource @wxheader{dnd.h} @@ -180,8 +181,7 @@ public: @library{wxcore} @category{dnd} - @seealso - wxDropTarget, wxTextDropTarget, wxFileDropTarget + @see wxDropTarget, wxTextDropTarget, wxFileDropTarget */ class wxDropSource { @@ -193,7 +193,7 @@ public: SetData() later. Note that the exact type of @a iconCopy and subsequent parameters differs between wxMSW and wxGTK: these are cursors under Windows but icons for GTK. - You should use the macro wxDROP_ICON in portable + You should use the macro wxDROP_ICON() in portable programs instead of directly using either of these types. @param win @@ -279,6 +279,7 @@ public: }; + /** @class wxFileDropTarget @wxheader{dnd.h} @@ -289,8 +290,7 @@ public: @library{wxcore} @category{dnd} - @seealso - @ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxTextDropTarget + @see @ref overview_wxdndoverview, wxDropSource, wxDropTarget, wxTextDropTarget */ class wxFileDropTarget : public wxDropTarget { @@ -321,6 +321,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/docmdi.h b/interface/docmdi.h index 8273a30f16..fd31790829 100644 --- a/interface/docmdi.h +++ b/interface/docmdi.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: docmdi.h -// Purpose: documentation for wxDocMDIParentFrame class +// Purpose: interface of wxDocMDIParentFrame // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,15 +15,14 @@ MDI parent frames. It cooperates with the wxView, wxDocument, - wxDocManager and wxDocTemplates classes. + wxDocManager and wxDocTemplates() classes. See the example application in @c samples/docview. @library{wxcore} @category{FIXME} - @seealso - @ref overview_docviewoverview, wxMDIParentFrame + @see @ref overview_docviewoverview, wxMDIParentFrame */ class wxDocMDIParentFrame : public wxMDIParentFrame { @@ -67,6 +66,7 @@ public: }; + /** @class wxDocMDIChildFrame @wxheader{docmdi.h} @@ -83,8 +83,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - @ref overview_docviewoverview, wxMDIChildFrame + @see @ref overview_docviewoverview, wxMDIChildFrame */ class wxDocMDIChildFrame : public wxMDIChildFrame { @@ -149,3 +148,4 @@ public: The view associated with the frame. */ }; + diff --git a/interface/docview.h b/interface/docview.h index 67759e5350..b8b9e66d4d 100644 --- a/interface/docview.h +++ b/interface/docview.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: docview.h -// Purpose: documentation for wxDocTemplate class +// Purpose: interface of wxDocTemplate // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,8 @@ @library{wxcore} @category{dvf} - @seealso - @ref overview_wxdoctemplateoverview "wxDocTemplate overview", wxDocument, wxView + @see @ref overview_wxdoctemplateoverview "wxDocTemplate overview", wxDocument, + wxView */ class wxDocTemplate : public wxObject { @@ -258,6 +258,7 @@ public: }; + /** @class wxDocManager @wxheader{docview.h} @@ -270,9 +271,8 @@ public: @library{wxcore} @category{dvf} - @seealso - @ref overview_wxdocmanageroverview "wxDocManager overview", wxDocument, wxView, - wxDocTemplate, wxFileHistory + @see @ref overview_wxdocmanageroverview "wxDocManager overview", wxDocument, + wxView, wxDocTemplate, wxFileHistory */ class wxDocManager : public wxEvtHandler { @@ -368,7 +368,7 @@ public: /** Loads the file history from a config object. - @see wxConfig + @see wxConfig() */ void FileHistoryLoad(wxConfigBase& config); @@ -382,7 +382,7 @@ public: Saves the file history into a config object. This must be called explicitly by the application. - @see wxConfig + @see wxConfig() */ void FileHistorySave(wxConfigBase& resourceFile); @@ -633,6 +633,7 @@ public: }; + /** @class wxView @wxheader{docview.h} @@ -646,8 +647,7 @@ public: @library{wxcore} @category{dvf} - @seealso - @ref overview_wxviewoverview "wxView overview", wxDocument, wxDocTemplate, + @see @ref overview_wxviewoverview "wxView overview", wxDocument, wxDocTemplate, wxDocManager */ class wxView : public wxEvtHandler @@ -817,6 +817,7 @@ public: }; + /** @class wxDocChildFrame @wxheader{docview.h} @@ -833,8 +834,7 @@ public: @library{wxcore} @category{dvf} - @seealso - @ref overview_docviewoverview, wxFrame + @see @ref overview_docviewoverview, wxFrame */ class wxDocChildFrame : public wxFrame { @@ -900,6 +900,7 @@ public: }; + /** @class wxDocParentFrame @wxheader{docview.h} @@ -909,15 +910,14 @@ public: SDI (not MDI) parent frames. It cooperates with the wxView, wxDocument, - wxDocManager and wxDocTemplates classes. + wxDocManager and wxDocTemplates() classes. See the example application in @c samples/docview. @library{wxcore} @category{dvf} - @seealso - @ref overview_docviewoverview, wxFrame + @see @ref overview_docviewoverview, wxFrame */ class wxDocParentFrame : public wxFrame { @@ -966,6 +966,7 @@ public: }; + /** @class wxDocument @wxheader{docview.h} @@ -978,9 +979,8 @@ public: @library{wxcore} @category{dvf} - @seealso - @ref overview_wxdocumentoverview "wxDocument overview", wxView, wxDocTemplate, - wxDocManager + @see @ref overview_wxdocumentoverview "wxDocument overview", wxView, + wxDocTemplate, wxDocManager */ class wxDocument : public wxEvtHandler { @@ -1033,7 +1033,7 @@ public: /** Gets the document type name for this document. See the comment for - documentTypeName. + documentTypeName(). */ wxString GetDocumentName() const; @@ -1217,7 +1217,7 @@ public: /** Sets the document type name for this document. See the comment for - documentTypeName. + documentTypeName(). */ void SetDocumentName(const wxString& name); @@ -1298,6 +1298,7 @@ public: }; + /** @class wxFileHistory @wxheader{docview.h} @@ -1314,8 +1315,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - @ref overview_wxfilehistoryoverview "wxFileHistory overview", wxDocManager + @see @ref overview_wxfilehistoryoverview "wxFileHistory overview", wxDocManager */ class wxFileHistory : public wxObject { @@ -1381,7 +1381,7 @@ public: Loads the file history from the given config object. This function should be called explicitly by the application. - @see wxConfig + @see wxConfig() */ void Load(wxConfigBase& config); @@ -1399,7 +1399,7 @@ public: Saves the file history into the given config object. This must be called explicitly by the application. - @see wxConfig + @see wxConfig() */ void Save(wxConfigBase& config); @@ -1443,6 +1443,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/dragimag.h b/interface/dragimag.h index 695c393a10..cb3177687b 100644 --- a/interface/dragimag.h +++ b/interface/dragimag.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dragimag.h -// Purpose: documentation for wxDragImage class +// Purpose: interface of wxDragImage // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -195,3 +195,4 @@ public: const wxRect& sourceRect, const wxRect& destRect) const; }; + diff --git a/interface/dynarray.h b/interface/dynarray.h index 66f803a4e5..d4c824ef56 100644 --- a/interface/dynarray.h +++ b/interface/dynarray.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dynarray.h -// Purpose: documentation for wxArray class +// Purpose: interface of wxArray // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -149,8 +149,7 @@ @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxcontaineroverview, wxListT, wxVectorT + @see @ref overview_wxcontaineroverview, wxListT(), wxVectorT() */ class wxArray { @@ -169,7 +168,7 @@ public: because the other array types never take ownership of their elements. Also note that you cannot append more than one pointer as reusing it would lead to deleting it twice (or more) and hence to a crash. - You may also use WX_APPEND_ARRAY macro to append all + You may also use WX_APPEND_ARRAY() macro to append all elements of one array to another one but it is more efficient to use @a copies parameter and modify the elements in place later if you plan to append a lot of items. @@ -200,9 +199,9 @@ public: wxArray::SetCount - WX_APPEND_ARRAY + WX_APPEND_ARRAY() - WX_PREPEND_ARRAY + WX_PREPEND_ARRAY() */ @@ -349,27 +348,27 @@ public: least) forward declared for WX_DEFINE_ARRAY, WX_DEFINE_SORTED_ARRAY and WX_DECLARE_OBJARRAY macros and must be fully declared before you use WX_DEFINE_OBJARRAY macro. - WX_DEFINE_ARRAY + WX_DEFINE_ARRAY() - WX_DEFINE_EXPORTED_ARRAY + WX_DEFINE_EXPORTED_ARRAY() - WX_DEFINE_USER_EXPORTED_ARRAY + WX_DEFINE_USER_EXPORTED_ARRAY() - WX_DEFINE_SORTED_ARRAY + WX_DEFINE_SORTED_ARRAY() - WX_DEFINE_SORTED_EXPORTED_ARRAY + WX_DEFINE_SORTED_EXPORTED_ARRAY() - WX_DEFINE_SORTED_USER_EXPORTED_ARRAY + WX_DEFINE_SORTED_USER_EXPORTED_ARRAY() - WX_DECLARE_EXPORTED_OBJARRAY + WX_DECLARE_EXPORTED_OBJARRAY() - WX_DECLARE_USER_EXPORTED_OBJARRAY + WX_DECLARE_USER_EXPORTED_OBJARRAY() - WX_DEFINE_OBJARRAY + WX_DEFINE_OBJARRAY() - WX_DEFINE_EXPORTED_OBJARRAY + WX_DEFINE_EXPORTED_OBJARRAY() - WX_DEFINE_USER_EXPORTED_OBJARRAY + WX_DEFINE_USER_EXPORTED_OBJARRAY() To slightly complicate the matters even further, the operator - defined by default for the array iterators by these macros only makes sense if the array element type is not a pointer itself and, although it still works, this @@ -393,17 +392,17 @@ public: To create an array of a simple type, simply append the type you want in CAPS to the array definition. For example, for an integer array, you'd use one of the following variants: - WX_DEFINE_ARRAY_INT + WX_DEFINE_ARRAY_INT() - WX_DEFINE_EXPORTED_ARRAY_INT + WX_DEFINE_EXPORTED_ARRAY_INT() - WX_DEFINE_USER_EXPORTED_ARRAY_INT + WX_DEFINE_USER_EXPORTED_ARRAY_INT() - WX_DEFINE_SORTED_ARRAY_INT + WX_DEFINE_SORTED_ARRAY_INT() - WX_DEFINE_SORTED_EXPORTED_ARRAY_INT + WX_DEFINE_SORTED_EXPORTED_ARRAY_INT() - WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT + WX_DEFINE_SORTED_USER_EXPORTED_ARRAY_INT() */ @@ -445,11 +444,11 @@ public: array equal to @a item is removed, an assert failure will result from an attempt to remove an item which doesn't exist in the array. When an element is removed from wxObjArray it is deleted by the array - use - Detach if you don't want this to happen. On the + Detach() if you don't want this to happen. On the other hand, when an object is removed from a wxArray nothing happens - you should delete it manually if required: - See also WX_CLEAR_ARRAY macro which deletes all + See also WX_CLEAR_ARRAY() macro which deletes all elements of a wxArray (supposed to contain pointers). */ Remove(T item); @@ -457,17 +456,17 @@ public: /** Removes @a count elements starting at @a index from the array. When an element is removed from wxObjArray it is deleted by the array - use - Detach if you don't want this to happen. On + Detach() if you don't want this to happen. On the other hand, when an object is removed from a wxArray nothing happens - you should delete it manually if required: - See also WX_CLEAR_ARRAY macro which deletes all + See also WX_CLEAR_ARRAY() macro which deletes all elements of a wxArray (supposed to contain pointers). */ RemoveAt(size_t index, size_t count = 1); /** - WX_CLEAR_ARRAY + WX_CLEAR_ARRAY() wxArray::Empty @@ -540,7 +539,7 @@ public: needed for exporting an array from a user DLL. Example: - You must use WX_DEFINE_OBJARRAY macro to define + You must use WX_DEFINE_OBJARRAY() macro to define the array class - otherwise you would get link errors. */ WX_DECLARE_OBJARRAY(T, name); @@ -568,7 +567,7 @@ public: //@{ /** This macro defines the methods of the array class @a name not defined by the - WX_DECLARE_OBJARRAY macro. You must include the + WX_DECLARE_OBJARRAY() macro. You must include the file wx/arrimpl.cpp before using this macro and you must have the full declaration of the class of array elements in scope! If you forget to do the first, the error will be caught by the compiler, but, unfortunately, many @@ -624,10 +623,11 @@ public: /** The wxObjArray destructor deletes all the items owned by the array. This is not done by wxArray and wxSortedArray versions - you may use - WX_CLEAR_ARRAY macro for this. + WX_CLEAR_ARRAY() macro for this. */ ~wxArray(); ~wxSortedArray(); ~wxObjArray(); //@} }; + diff --git a/interface/dynlib.h b/interface/dynlib.h index 78e611639f..a6d0f6239a 100644 --- a/interface/dynlib.h +++ b/interface/dynlib.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: dynlib.h -// Purpose: documentation for wxDynamicLibraryDetails class +// Purpose: interface of wxDynamicLibraryDetails // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -59,6 +59,7 @@ public: }; + /** @class wxDllLoader @wxheader{dynlib.h} @@ -185,6 +186,7 @@ public: }; + /** @class wxDynamicLibrary @wxheader{dynlib.h} @@ -197,8 +199,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxDynamicLibrary::CanonicalizePluginName + @see wxDynamicLibrary::CanonicalizePluginName */ class wxDynamicLibrary { @@ -269,7 +270,7 @@ public: Returns pointer to symbol @a name in the library or @NULL if the library contains no such symbol. - @see wxDYNLIB_FUNCTION + @see wxDYNLIB_FUNCTION() */ void* GetSymbol(const wxString& name) const; @@ -288,7 +289,8 @@ public: Returns @true if the symbol with the given @a name is present in the dynamic library, @false otherwise. Unlike GetSymbol(), this function doesn't log an error message if the symbol is not found. - This function is new since wxWidgets version 2.5.4 + + @wxsince{2.5.4} */ bool HasSymbol(const wxString& name) const; @@ -298,7 +300,7 @@ public: bool IsLoaded() const; /** - This static method returns an array containing the details + This static method returns an array() containing the details of all modules loaded into the address space of the current project, the array elements are object of @c wxDynamicLibraryDetails class. The array will be empty if an error occurred. @@ -356,6 +358,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/editlbox.h b/interface/editlbox.h index c6c3bec5d4..ea02e10aff 100644 --- a/interface/editlbox.h +++ b/interface/editlbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: editlbox.h -// Purpose: documentation for wxEditableListBox class +// Purpose: interface of wxEditableListBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxadv} @category{FIXME} - @seealso - wxListBox + @see wxListBox */ class wxEditableListBox : public wxPanel { @@ -88,3 +87,4 @@ public: */ void SetStrings(const wxArrayString& strings); }; + diff --git a/interface/encconv.h b/interface/encconv.h index f21e5ebea6..b72f847817 100644 --- a/interface/encconv.h +++ b/interface/encconv.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: encconv.h -// Purpose: documentation for wxEncodingConverter class +// Purpose: interface of wxEncodingConverter // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -20,9 +20,8 @@ @library{wxbase} @category{misc} - @seealso - wxFontMapper, wxMBConv, @ref overview_nonenglishoverview "Writing non-English - applications" + @see wxFontMapper, wxMBConv, @ref overview_nonenglishoverview "Writing + non-English applications" */ class wxEncodingConverter : public wxObject { @@ -120,3 +119,4 @@ public: bool Init(wxFontEncoding input_enc, wxFontEncoding output_enc, int method = wxCONVERT_STRICT); }; + diff --git a/interface/event.h b/interface/event.h index 5c1d73ef13..9dde84415d 100644 --- a/interface/event.h +++ b/interface/event.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: event.h -// Purpose: documentation for wxKeyEvent class +// Purpose: interface of wxKeyEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -47,7 +47,7 @@ 1, the ASCII value of this key combination. You may discover how the other keys on your system behave interactively by - running the text wxWidgets sample and pressing some keys + running the text() wxWidgets sample and pressing some keys in any of the text controls shown in it. @b Note: If a key down (@c EVT_KEY_DOWN) event is caught and @@ -104,7 +104,7 @@ public: /** Returns the virtual key code. ASCII events return normal ASCII values, while non-ASCII events return values such as @b WXK_LEFT for the - left cursor key. See Keycodes for a full list of + left cursor key. See Keycodes() for a full list of the virtual key codes. Note that in Unicode build, the returned value is meaningful only if the user entered a character that can be represented in current locale's default @@ -216,7 +216,7 @@ public: long m_keyCode @b Deprecated: Please use GetKeyCode() instead! - Virtual keycode. See Keycodes for a list of identifiers. + Virtual keycode. See Keycodes() for a list of identifiers. */ @@ -251,6 +251,7 @@ public: }; + /** @class wxJoystickEvent @wxheader{event.h} @@ -261,8 +262,7 @@ public: @library{wxcore} @category{events} - @seealso - wxJoystick + @see wxJoystick */ class wxJoystickEvent : public wxEvent { @@ -351,6 +351,7 @@ public: }; + /** @class wxScrollWinEvent @wxheader{event.h} @@ -360,8 +361,7 @@ public: @library{wxcore} @category{events} - @seealso - wxScrollEvent, @ref overview_eventhandlingoverview + @see wxScrollEvent, @ref overview_eventhandlingoverview */ class wxScrollWinEvent : public wxEvent { @@ -387,6 +387,7 @@ public: }; + /** @class wxSysColourChangedEvent @wxheader{event.h} @@ -398,8 +399,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxSysColourChangedEvent : public wxEvent { @@ -411,6 +411,7 @@ public: }; + /** @class wxWindowCreateEvent @wxheader{event.h} @@ -424,8 +425,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview, wxWindowDestroyEvent + @see @ref overview_eventhandlingoverview, wxWindowDestroyEvent */ class wxWindowCreateEvent : public wxCommandEvent { @@ -437,6 +437,7 @@ public: }; + /** @class wxPaintEvent @wxheader{event.h} @@ -451,8 +452,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxPaintEvent : public wxEvent { @@ -464,6 +464,7 @@ public: }; + /** @class wxMaximizeEvent @wxheader{event.h} @@ -476,8 +477,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview, wxTopLevelWindow::Maximize, + @see @ref overview_eventhandlingoverview, wxTopLevelWindow::Maximize, wxTopLevelWindow::IsMaximized */ class wxMaximizeEvent : public wxEvent @@ -490,6 +490,7 @@ public: }; + /** @class wxUpdateUIEvent @wxheader{event.h} @@ -500,8 +501,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxUpdateUIEvent : public wxCommandEvent { @@ -643,6 +643,7 @@ public: }; + /** @class wxClipboardTextEvent @wxheader{event.h} @@ -667,8 +668,7 @@ public: @library{wxcore} @category{events} - @seealso - wxClipboard + @see wxClipboard */ class wxClipboardTextEvent : public wxCommandEvent { @@ -681,6 +681,7 @@ public: }; + /** @class wxMouseEvent @wxheader{event.h} @@ -727,8 +728,7 @@ public: @library{wxcore} @category{events} - @seealso - wxKeyEvent::CmdDown + @see wxKeyEvent::CmdDown */ class wxMouseEvent : public wxEvent { @@ -902,7 +902,8 @@ public: Currently this function is implemented only in wxMac and returns -1 for the other platforms (you can still distinguish simple clicks from double-clicks as they generate different kinds of events however). - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} */ int GetClickCount() const; @@ -1140,6 +1141,7 @@ public: }; + /** @class wxDropFilesEvent @wxheader{event.h} @@ -1150,14 +1152,13 @@ public: wxWindow::DragAcceptFiles. Important note: this is a separate implementation to the more general - drag and drop implementation documented here. It uses the + drag and drop implementation documented here(). It uses the older, Windows message-based approach of dropping files. @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxDropFilesEvent : public wxEvent { @@ -1203,6 +1204,7 @@ public: }; + /** @class wxCommandEvent @wxheader{event.h} @@ -1317,6 +1319,7 @@ public: }; + /** @class wxActivateEvent @wxheader{event.h} @@ -1327,8 +1330,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview, wxApp::IsActive + @see @ref overview_eventhandlingoverview, wxApp::IsActive */ class wxActivateEvent : public wxEvent { @@ -1346,6 +1348,7 @@ public: }; + /** @class wxContextMenuEvent @wxheader{event.h} @@ -1357,7 +1360,7 @@ public: means that the event originated from a keyboard context button event, and you should compute a suitable position yourself, - for example by calling wxGetMousePosition. + for example by calling wxGetMousePosition(). When a keyboard context menu button is pressed on Windows, a right-click event with default position is sent first, @@ -1368,8 +1371,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_wxcommandevent "Command events", @ref + @see @ref overview_wxcommandevent "Command events", @ref overview_eventhandlingoverview */ class wxContextMenuEvent : public wxCommandEvent @@ -1399,6 +1401,7 @@ public: }; + /** @class wxEraseEvent @wxheader{event.h} @@ -1421,8 +1424,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxEraseEvent : public wxEvent { @@ -1439,6 +1441,7 @@ public: }; + /** @class wxFocusEvent @wxheader{event.h} @@ -1454,8 +1457,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxFocusEvent : public wxEvent { @@ -1474,6 +1476,7 @@ public: }; + /** @class wxChildFocusEvent @wxheader{event.h} @@ -1489,8 +1492,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxChildFocusEvent : public wxCommandEvent { @@ -1512,6 +1514,7 @@ public: }; + /** @class wxMouseCaptureLostEvent @wxheader{event.h} @@ -1530,8 +1533,7 @@ public: @library{wxcore} @category{events} - @seealso - wxMouseCaptureChangedEvent, @ref overview_eventhandlingoverview, + @see wxMouseCaptureChangedEvent, @ref overview_eventhandlingoverview, wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture */ class wxMouseCaptureLostEvent : public wxEvent @@ -1544,6 +1546,7 @@ public: }; + /** @class wxNotifyEvent @wxheader{event.h} @@ -1558,8 +1561,7 @@ public: @library{wxcore} @category{events} - @seealso - wxNotebookEvent + @see wxNotebookEvent */ class wxNotifyEvent : public wxCommandEvent { @@ -1593,6 +1595,7 @@ public: }; + /** @class wxHelpEvent @wxheader{event.h} @@ -1621,8 +1624,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxContextHelp, wxDialog, @ref overview_eventhandlingoverview + @see wxContextHelp, wxDialog, @ref overview_eventhandlingoverview */ class wxHelpEvent : public wxCommandEvent { @@ -1651,7 +1653,7 @@ public: MS Windows. The application may handle events generated using the keyboard or mouse - differently, e.g. by using wxGetMousePosition + differently, e.g. by using wxGetMousePosition() for the mouse events. @see SetOrigin() @@ -1678,12 +1680,13 @@ public: }; + /** @class wxScrollEvent @wxheader{event.h} A scroll event holds information about events sent from stand-alone - scrollbars and sliders. Note that + scrollbars() and sliders(). Note that starting from wxWidgets 2.1, scrolled windows send the wxScrollWinEvent which does not derive from wxCommandEvent, but from wxEvent directly - don't confuse these two kinds of @@ -1693,8 +1696,7 @@ public: @library{wxcore} @category{events} - @seealso - wxScrollBar, wxSlider, wxSpinButton, , wxScrollWinEvent, @ref + @see wxScrollBar, wxSlider, wxSpinButton, , wxScrollWinEvent, @ref overview_eventhandlingoverview */ class wxScrollEvent : public wxCommandEvent @@ -1719,6 +1721,7 @@ public: }; + /** @class wxIdleEvent @wxheader{event.h} @@ -1730,7 +1733,7 @@ public: happens and only then is the next idle event sent again. If you need to ensure a continuous stream of idle events, you can either use wxIdleEvent::RequestMore method in your handler or call - wxWakeUpIdle periodically (for example from timer + wxWakeUpIdle() periodically (for example from timer event), but note that both of these approaches (and especially the first one) increase the system load and so should be avoided if possible. @@ -1743,8 +1746,8 @@ public: @library{wxbase} @category{events} - @seealso - @ref overview_eventhandlingoverview, wxUpdateUIEvent, wxWindow::OnInternalIdle + @see @ref overview_eventhandlingoverview, wxUpdateUIEvent, + wxWindow::OnInternalIdle */ class wxIdleEvent : public wxEvent { @@ -1811,6 +1814,7 @@ public: }; + /** @class wxInitDialogEvent @wxheader{event.h} @@ -1822,8 +1826,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxInitDialogEvent : public wxEvent { @@ -1835,6 +1838,7 @@ public: }; + /** @class wxWindowDestroyEvent @wxheader{event.h} @@ -1855,8 +1859,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview, wxWindowCreateEvent + @see @ref overview_eventhandlingoverview, wxWindowCreateEvent */ class wxWindowDestroyEvent : public wxCommandEvent { @@ -1868,6 +1871,7 @@ public: }; + /** @class wxNavigationKeyEvent @wxheader{event.h} @@ -1883,8 +1887,7 @@ public: @library{wxcore} @category{events} - @seealso - wxWindow::Navigate, wxWindow::NavigateIn + @see wxWindow::Navigate, wxWindow::NavigateIn */ class wxNavigationKeyEvent { @@ -1948,6 +1951,7 @@ public: }; + /** @class wxMouseCaptureChangedEvent @wxheader{event.h} @@ -1963,8 +1967,7 @@ public: @library{wxcore} @category{events} - @seealso - wxMouseCaptureLostEvent, @ref overview_eventhandlingoverview, + @see wxMouseCaptureLostEvent, @ref overview_eventhandlingoverview, wxWindow::CaptureMouse, wxWindow::ReleaseMouse, wxWindow::GetCapture */ class wxMouseCaptureChangedEvent : public wxEvent @@ -1984,6 +1987,7 @@ public: }; + /** @class wxCloseEvent @wxheader{event.h} @@ -2011,8 +2015,8 @@ public: @library{wxcore} @category{events} - @seealso - wxWindow::Close, @ref overview_windowdeletionoverview "Window deletion overview" + @see wxWindow::Close, @ref overview_windowdeletionoverview "Window deletion + overview" */ class wxCloseEvent : public wxEvent { @@ -2062,6 +2066,7 @@ public: }; + /** @class wxMenuEvent @wxheader{event.h} @@ -2076,8 +2081,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_wxcommandevent "Command events", @ref + @see @ref overview_wxcommandevent "Command events", @ref overview_eventhandlingoverview */ class wxMenuEvent : public wxEvent @@ -2110,6 +2114,7 @@ public: }; + /** @class wxEventBlocker @wxheader{event.h} @@ -2137,8 +2142,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - @ref overview_eventhandlingoverview, wxEvtHandler + @see @ref overview_eventhandlingoverview, wxEvtHandler */ class wxEventBlocker : public wxEvtHandler { @@ -2167,6 +2171,7 @@ public: }; + /** @class wxEvtHandler @wxheader{event.h} @@ -2184,8 +2189,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_eventhandlingoverview + @see @ref overview_eventhandlingoverview */ class wxEvtHandler : public wxObject { @@ -2456,6 +2460,7 @@ public: }; + /** @class wxIconizeEvent @wxheader{event.h} @@ -2467,8 +2472,7 @@ public: @library{wxcore} @category{events} - @seealso - @ref overview_eventhandlingoverview, wxTopLevelWindow::Iconize, + @see @ref overview_eventhandlingoverview, wxTopLevelWindow::Iconize, wxTopLevelWindow::IsIconized */ class wxIconizeEvent : public wxEvent @@ -2487,6 +2491,7 @@ public: }; + /** @class wxMoveEvent @wxheader{event.h} @@ -2496,8 +2501,7 @@ public: @library{wxcore} @category{events} - @seealso - wxPoint, @ref overview_eventhandlingoverview + @see wxPoint, @ref overview_eventhandlingoverview */ class wxMoveEvent : public wxEvent { @@ -2514,6 +2518,7 @@ public: }; + /** @class wxEvent @wxheader{event.h} @@ -2530,8 +2535,7 @@ public: @library{wxbase} @category{events} - @seealso - wxCommandEvent, wxMouseEvent + @see wxCommandEvent, wxMouseEvent */ class wxEvent : public wxObject { @@ -2545,7 +2549,7 @@ public: Returns a copy of the event. Any event that is posted to the wxWidgets event system for later action (via wxEvtHandler::AddPendingEvent or - wxPostEvent) must implement this method. All wxWidgets + wxPostEvent()) must implement this method. All wxWidgets events fully implement this method, but any derived events implemented by the user should also implement this method just in case they (or some event derived from them) are ever posted. @@ -2664,6 +2668,7 @@ public: }; + /** @class wxSizeEvent @wxheader{event.h} @@ -2690,8 +2695,7 @@ public: @library{wxcore} @category{events} - @seealso - wxSize, @ref overview_eventhandlingoverview + @see wxSize, @ref overview_eventhandlingoverview */ class wxSizeEvent : public wxEvent { @@ -2708,6 +2712,7 @@ public: }; + /** @class wxSetCursorEvent @wxheader{event.h} @@ -2721,8 +2726,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - ::wxSetCursor, wxWindow::wxSetCursor + @see ::wxSetCursor, wxWindow::wxSetCursor */ class wxSetCursorEvent : public wxEvent { @@ -2761,3 +2765,4 @@ public: */ void SetCursor(const wxCursor& cursor); }; + diff --git a/interface/fdrepdlg.h b/interface/fdrepdlg.h index 598806acf7..84fd6047a5 100644 --- a/interface/fdrepdlg.h +++ b/interface/fdrepdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fdrepdlg.h -// Purpose: documentation for wxFindDialogEvent class +// Purpose: interface of wxFindDialogEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -48,6 +48,7 @@ public: }; + /** @class wxFindReplaceData @wxheader{fdrepdlg.h} @@ -105,6 +106,7 @@ public: }; + /** @class wxFindReplaceDialog @wxheader{fdrepdlg.h} @@ -156,3 +158,4 @@ public: */ const wxFindReplaceData* GetData() const; }; + diff --git a/interface/ffile.h b/interface/ffile.h index 44465f22da..10ee707a0c 100644 --- a/interface/ffile.h +++ b/interface/ffile.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: ffile.h -// Purpose: documentation for wxFFile class +// Purpose: interface of wxFFile // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -19,8 +19,7 @@ @library{wxbase} @category{file} - @seealso - wxFFile::IsOpened + @see wxFFile::IsOpened */ class wxFFile { @@ -190,3 +189,4 @@ public: */ FILE* fp() const; }; + diff --git a/interface/file.h b/interface/file.h index 898d0af608..a2a28297ef 100644 --- a/interface/file.h +++ b/interface/file.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: file.h -// Purpose: documentation for wxTempFile class +// Purpose: interface of wxTempFile // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -119,6 +119,7 @@ public: }; + /** @class wxFile @wxheader{file.h} @@ -321,3 +322,4 @@ public: */ int fd() const; }; + diff --git a/interface/fileconf.h b/interface/fileconf.h index 79838869f6..abcddfd9ad 100644 --- a/interface/fileconf.h +++ b/interface/fileconf.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fileconf.h -// Purpose: documentation for wxFileConfig class +// Purpose: interface of wxFileConfig // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -23,8 +23,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxFileConfig::Save + @see wxFileConfig::Save */ class wxFileConfig : public wxConfigBase { @@ -80,7 +79,8 @@ public: @c SetUmask(0077). This function doesn't do anything on non-Unix platforms. - @see wxCHANGE_UMASK + @see wxCHANGE_UMASK() */ void SetUmask(int mode); }; + diff --git a/interface/filectrl.h b/interface/filectrl.h index 47403cd33c..54e93df8f1 100644 --- a/interface/filectrl.h +++ b/interface/filectrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: filectrl.h -// Purpose: documentation for wxFileCtrl class +// Purpose: interface of wxFileCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -33,8 +33,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxGenericDirCtrl + @see wxGenericDirCtrl */ class wxFileCtrl : public wxWindow { @@ -170,6 +169,7 @@ public: }; + /** @class wxFileCtrlEvent @wxheader{filectrl.h} @@ -212,3 +212,4 @@ public: */ wxFileCtrlEvent::SetFiles(const wxArrayString files); }; + diff --git a/interface/filedlg.h b/interface/filedlg.h index a7ca2bf85a..3432e5ff55 100644 --- a/interface/filedlg.h +++ b/interface/filedlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: filedlg.h -// Purpose: documentation for wxFileDialog class +// Purpose: interface of wxFileDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -41,8 +41,8 @@ @library{wxcore} @category{cmndlg} - @seealso - @ref overview_wxfiledialogoverview "wxFileDialog overview", wxFileSelector + @see @ref overview_wxfiledialogoverview "wxFileDialog overview", + wxFileSelector() */ class wxFileDialog : public wxDialog { @@ -200,6 +200,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/filefn.h b/interface/filefn.h index 2b857579f3..35be908047 100644 --- a/interface/filefn.h +++ b/interface/filefn.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: filefn.h -// Purpose: documentation for wxPathList class +// Purpose: interface of wxPathList // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,8 +21,7 @@ @library{wxbase} @category{file} - @seealso - wxArrayString, wxStandardPaths, wxFileName + @see wxArrayString, wxStandardPaths, wxFileName */ class wxPathList : public wxArrayString { @@ -89,13 +88,14 @@ public: Note in fact that wxPathList can be used to store both relative and absolute paths so that if you Added() relative paths, then the current working directory - (see wxGetCwd and wxSetWorkingDirectory) + (see wxGetCwd() and wxSetWorkingDirectory()) may affect the value returned by this function! */ wxString FindValidPath(const wxString& file) const; }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -228,13 +228,13 @@ bool wxFileExists(const wxString& filename); /** Returns @true if the @a pattern matches the @e text; if @a dot_special is @true, filenames beginning with a dot are not matched - with wildcard characters. See wxIsWild. + with wildcard characters. See wxIsWild(). */ bool wxMatchWild(const wxString& pattern, const wxString& text, bool dot_special); /** - @b NB: This function is deprecated: use wxGetCwd instead. + @b NB: This function is deprecated: use wxGetCwd() instead. Copies the current working directory into the buffer if supplied, or copies the working directory into new storage (which you must delete yourself) if the buffer is @NULL. @@ -248,7 +248,7 @@ wxString wxGetWorkingDirectory(char* buf = NULL, int sz = 1000); wxString wxPathOnly(const wxString& path); /** - Returns @true if the pattern contains wildcards. See wxMatchWild. + Returns @true if the pattern contains wildcards. See wxMatchWild(). */ bool wxIsWild(const wxString& pattern); @@ -296,14 +296,14 @@ bool wxMkdir(const wxString& dir, int perm = 0777); bool wxIsAbsolutePath(const wxString& filename); /** - Returns the next file that matches the path passed to wxFindFirstFile. - See wxFindFirstFile for an example. + Returns the next file that matches the path passed to wxFindFirstFile(). + See wxFindFirstFile() for an example. */ wxString wxFindNextFile(); /** This function does directory searching; returns the first file - that matches the path @e spec, or the empty string. Use wxFindNextFile to + that matches the path @e spec, or the empty string. Use wxFindNextFile() to get the next matching file. Neither will report the current directory "." or the parent directory "..". */ diff --git a/interface/filename.h b/interface/filename.h index 87370bb5e3..d5dd8572d8 100644 --- a/interface/filename.h +++ b/interface/filename.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: filename.h -// Purpose: documentation for wxFileName class +// Purpose: interface of wxFileName // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -44,7 +44,7 @@ a complete file name (such as when interpreting user input) you need to use the static function wxFileName::DirExists (or its identical variants wxDir::Exists and - wxDirExists) and construct the wxFileName + wxDirExists()) and construct the wxFileName instance accordingly. This will only work if the directory actually exists, of course: @@ -62,8 +62,7 @@ @library{wxbase} @category{file} - @seealso - wxFileName::GetCwd + @see wxFileName::GetCwd */ class wxFileName { @@ -1002,3 +1001,4 @@ public: const bool operator operator==(const wxString& filename) const; //@} }; + diff --git a/interface/filepicker.h b/interface/filepicker.h index 7f749aacaf..8e79a58213 100644 --- a/interface/filepicker.h +++ b/interface/filepicker.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: filepicker.h -// Purpose: documentation for wxFilePickerCtrl class +// Purpose: interface of wxFilePickerCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -45,8 +45,7 @@ @category{miscpickers} @appearance{filepickerctrl.png} - @seealso - wxFileDialog, wxFileDirPickerEvent + @see wxFileDialog, wxFileDirPickerEvent */ class wxFilePickerCtrl : public wxPickerBase { @@ -128,6 +127,7 @@ public: }; + /** @class wxDirPickerCtrl @wxheader{filepicker.h} @@ -163,8 +163,7 @@ public: @category{miscpickers} @appearance{dirpickerctrl.png} - @seealso - wxDirDialog, wxFileDirPickerEvent + @see wxDirDialog, wxFileDirPickerEvent */ class wxDirPickerCtrl : public wxPickerBase { @@ -242,6 +241,7 @@ public: }; + /** @class wxFileDirPickerEvent @wxheader{filepicker.h} @@ -252,8 +252,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxfilepickerctrl + @see wxfilepickerctrl() */ class wxFileDirPickerEvent : public wxCommandEvent { @@ -275,3 +274,4 @@ public: */ void SetPath(const wxString& path); }; + diff --git a/interface/filesys.h b/interface/filesys.h index 2367b97f0e..08ff29fe0b 100644 --- a/interface/filesys.h +++ b/interface/filesys.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: filesys.h -// Purpose: documentation for wxFileSystem class +// Purpose: interface of wxFileSystem // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -12,14 +12,13 @@ This class provides an interface for opening files on different file systems. It can handle absolute and/or local filenames. - It uses a system of handlers to + It uses a system of handlers() to provide access to user-defined virtual file systems. @library{wxbase} @category{vfs} - @seealso - wxFileSystemHandler, wxFSFile, Overview + @see wxFileSystemHandler, wxFSFile, Overview() */ class wxFileSystem : public wxObject { @@ -31,7 +30,7 @@ public: /** This static function adds new handler into the list of - handlers which provide access to virtual FS. + handlers() which provide access to virtual FS. Note that if two handlers for the same protocol are added, the last one added takes precedence. */ @@ -77,7 +76,7 @@ public: const wxString& file); /** - Works like wxFindFirstFile. Returns name of the first + Works like wxFindFirstFile(). Returns name of the first filename (within filesystem's current path) that matches @e wildcard. @a flags may be one of wxFILE (only files), wxDIR (only directories) or 0 (both). @@ -126,6 +125,7 @@ public: }; + /** @class wxFSFile @wxheader{filesys.h} @@ -143,8 +143,7 @@ public: @library{wxbase} @category{vfs} - @seealso - wxFileSystemHandler, wxFileSystem, Overview + @see wxFileSystemHandler, wxFileSystem, Overview() */ class wxFSFile : public wxObject { @@ -216,6 +215,7 @@ public: }; + /** @class wxFileSystemHandler @wxheader{filesys.h} @@ -228,7 +228,7 @@ public: of opening the file: GetProtocol, GetLeftLocation, GetRightLocation, GetAnchor, GetMimeTypeFromExt. - Please have a look at overview if you don't know how locations + Please have a look at overview() if you don't know how locations are constructed. Also consult @ref overview_fs "list of available handlers". @@ -239,8 +239,7 @@ public: @library{wxbase} @category{vfs} - @seealso - wxFileSystem, wxFSFile, Overview + @see wxFileSystem, wxFSFile, Overview() */ class wxFileSystemHandler : public wxObject { @@ -260,7 +259,7 @@ public: virtual bool CanOpen(const wxString& location); /** - Works like wxFindFirstFile. Returns name of the first + Works like wxFindFirstFile(). Returns name of the first filename (within filesystem's current path) that matches @e wildcard. @a flags may be one of wxFILE (only files), wxDIR (only directories) or 0 (both). @@ -324,3 +323,4 @@ public: virtual wxFSFile* OpenFile(wxFileSystem& fs, const wxString& location); }; + diff --git a/interface/font.h b/interface/font.h index 1e3f2fe6a7..9f706987b8 100644 --- a/interface/font.h +++ b/interface/font.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: font.h -// Purpose: documentation for wxFont class +// Purpose: interface of wxFont // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,19 +29,10 @@ @category{gdi} @stdobjects - Objects: - wxNullFont - Pointers: - wxNORMAL_FONT + ::Objects:, ::wxNullFont, ::Pointers:, ::wxNORMAL_FONT, ::wxSMALL_FONT, + ::wxITALIC_FONT, ::wxSWISS_FONT, - wxSMALL_FONT - - wxITALIC_FONT - - wxSWISS_FONT - - @seealso - @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText, + @see @ref overview_wxfontoverview, wxDC::SetFont, wxDC::DrawText, wxDC::GetTextExtent, wxFontDialog, wxSystemSettings */ class wxFont : public wxGDIObject @@ -658,3 +649,43 @@ public: */ bool operator ==(const wxFont& font); }; + + +/** + FIXME +*/ +wxFont Objects: +; + +/** + FIXME +*/ +wxFont wxNullFont; + +/** + FIXME +*/ +wxFont Pointers: +; + +/** + FIXME +*/ +wxFont wxNORMAL_FONT; + +/** + FIXME +*/ +wxFont wxSMALL_FONT; + +/** + FIXME +*/ +wxFont wxITALIC_FONT; + +/** + FIXME +*/ +wxFont wxSWISS_FONT; + + diff --git a/interface/fontdlg.h b/interface/fontdlg.h index 5b8dcedfd4..ae936116cf 100644 --- a/interface/fontdlg.h +++ b/interface/fontdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fontdlg.h -// Purpose: documentation for wxFontDialog class +// Purpose: interface of wxFontDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,8 +15,7 @@ @library{wxcore} @category{cmndlg} - @seealso - Overview, wxFontData, wxGetFontFromUser + @see Overview(), wxFontData, wxGetFontFromUser() */ class wxFontDialog : public wxDialog { @@ -64,6 +63,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/fontenum.h b/interface/fontenum.h index 400cefc14a..8cf2da6104 100644 --- a/interface/fontenum.h +++ b/interface/fontenum.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fontenum.h -// Purpose: documentation for wxFontEnumerator class +// Purpose: interface of wxFontEnumerator // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -13,7 +13,7 @@ wxFontEnumerator enumerates either all available fonts on the system or only the ones with given attributes - either only fixed-width (suited for use in programs such as terminal emulators and the like) or the fonts available in - the given encoding. + the given encoding(). To do this, you just have to call one of EnumerateXXX() functions - either wxFontEnumerator::EnumerateFacenames or @@ -26,9 +26,8 @@ @library{wxcore} @category{FIXME} - @seealso - @ref overview_wxfontencodingoverview, @ref overview_samplefont "Font sample", - wxFont, wxFontMapper + @see @ref overview_wxfontencodingoverview, @ref overview_samplefont "Font + sample", wxFont, wxFontMapper */ class wxFontEnumerator { @@ -83,3 +82,4 @@ public: virtual bool OnFontEncoding(const wxString& font, const wxString& encoding); }; + diff --git a/interface/fontmap.h b/interface/fontmap.h index f3591f369f..457ce50c9f 100644 --- a/interface/fontmap.h +++ b/interface/fontmap.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fontmap.h -// Purpose: documentation for wxFontMapper class +// Purpose: interface of wxFontMapper // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -31,8 +31,7 @@ @library{wxcore} @category{misc} - @seealso - wxEncodingConverter, @ref overview_nonenglishoverview "Writing non-English + @see wxEncodingConverter, @ref overview_nonenglishoverview "Writing non-English applications" */ class wxFontMapper @@ -174,3 +173,4 @@ public: */ void SetDialogTitle(const wxString& title); }; + diff --git a/interface/fontpicker.h b/interface/fontpicker.h index 5d1313bb36..3741ff2c4b 100644 --- a/interface/fontpicker.h +++ b/interface/fontpicker.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fontpicker.h -// Purpose: documentation for wxFontPickerCtrl class +// Purpose: interface of wxFontPickerCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -40,8 +40,7 @@ @category{miscpickers} @appearance{fontpickerctrl.png} - @seealso - wxFontDialog, wxFontPickerEvent + @see wxFontDialog, wxFontPickerEvent */ class wxFontPickerCtrl : public wxPickerBase { @@ -119,6 +118,7 @@ public: }; + /** @class wxFontPickerEvent @wxheader{fontpicker.h} @@ -129,8 +129,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxFontPickerCtrl + @see wxFontPickerCtrl */ class wxFontPickerEvent : public wxCommandEvent { @@ -151,3 +150,4 @@ public: */ void SetFont(const wxFont& f); }; + diff --git a/interface/frame.h b/interface/frame.h index 44c7104feb..070270286f 100644 --- a/interface/frame.h +++ b/interface/frame.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: frame.h -// Purpose: documentation for wxFrame class +// Purpose: interface of wxFrame // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -82,8 +82,7 @@ @library{wxcore} @category{managedwnd} - @seealso - wxMDIParentFrame, wxMDIChildFrame, wxMiniFrame, wxDialog + @see wxMDIParentFrame, wxMDIChildFrame, wxMiniFrame, wxDialog */ class wxFrame : public wxTopLevelWindow { @@ -380,3 +379,4 @@ public: */ void SetToolBar(wxToolBar* toolBar); }; + diff --git a/interface/fs_mem.h b/interface/fs_mem.h index 7c33133036..f58f101ee4 100644 --- a/interface/fs_mem.h +++ b/interface/fs_mem.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: fs_mem.h -// Purpose: documentation for wxMemoryFSHandler class +// Purpose: interface of wxMemoryFSHandler // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -61,8 +61,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxMemoryFSHandler::AddFileWithMimeType + @see wxMemoryFSHandler::AddFileWithMimeType */ class wxMemoryFSHandler : public wxFileSystemHandler { @@ -81,7 +80,7 @@ public: The @a type argument is one of @c wxBITMAP_TYPE_XXX constants. Note that you must use a @a type value (aka image format) that wxWidgets can save (e.g. JPG, PNG, see wxImage - documentation)! + documentation())! @see AddFileWithMimeType() */ @@ -97,7 +96,8 @@ public: Like AddFile(), but lets you explicitly specify added file's MIME type. This version should be used whenever you know the MIME type, because it makes accessing the files faster. - This function is new since wxWidgets version 2.8.5 + + @wxsince{2.8.5} @see AddFile() */ @@ -115,3 +115,4 @@ public: */ static void RemoveFile(const wxString& filename); }; + diff --git a/interface/gauge.h b/interface/gauge.h index eeb2ce7a60..1490ecb8b6 100644 --- a/interface/gauge.h +++ b/interface/gauge.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: gauge.h -// Purpose: documentation for wxGauge class +// Purpose: interface of wxGauge // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -40,8 +40,7 @@ @category{ctrl} @appearance{gauge.png} - @seealso - wxSlider, wxScrollBar + @see wxSlider, wxScrollBar */ class wxGauge : public wxControl { @@ -179,3 +178,4 @@ public: */ void SetValue(int pos); }; + diff --git a/interface/gbsizer.h b/interface/gbsizer.h index e9ea8f5ef8..9036d1edad 100644 --- a/interface/gbsizer.h +++ b/interface/gbsizer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: gbsizer.h -// Purpose: documentation for wxGBPosition class +// Purpose: interface of wxGBPosition // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -60,6 +60,7 @@ public: }; + /** @class wxGridBagSizer @wxheader{gbsizer.h} @@ -220,6 +221,7 @@ public: }; + /** @class wxGBSizerItem @wxheader{gbsizer.h} @@ -304,6 +306,7 @@ public: }; + /** @class wxGBSpan @wxheader{gbsizer.h} @@ -357,3 +360,4 @@ public: */ bool operator operator==(const wxGBSpan& o) const; }; + diff --git a/interface/gdicmn.h b/interface/gdicmn.h index 8d05fbffaa..8256fa8a27 100644 --- a/interface/gdicmn.h +++ b/interface/gdicmn.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: gdicmn.h -// Purpose: documentation for wxRealPoint class +// Purpose: interface of wxRealPoint // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,7 @@ @library{wxcore} @category{data} - @seealso - wxPoint + @see wxPoint */ class wxRealPoint { @@ -36,6 +35,7 @@ public: }; + /** @class wxRect @wxheader{gdicmn.h} @@ -45,8 +45,7 @@ public: @library{wxcore} @category{data} - @seealso - wxPoint, wxSize + @see wxPoint, wxSize */ class wxRect { @@ -324,6 +323,7 @@ public: }; + /** @class wxBrushList @wxheader{gdicmn.h} @@ -333,8 +333,7 @@ public: @library{wxcore} @category{gdi} - @seealso - wxBrush + @see wxBrush */ class wxBrushList : public wxList { @@ -360,6 +359,7 @@ public: }; + /** @class wxPoint @wxheader{gdicmn.h} @@ -372,8 +372,7 @@ public: @library{wxcore} @category{data} - @seealso - wxRealPoint + @see wxRealPoint */ class wxPoint { @@ -419,6 +418,7 @@ public: }; + /** @class wxColourDatabase @wxheader{gdicmn.h} @@ -436,8 +436,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxColour + @see wxColour */ class wxColourDatabase { @@ -474,6 +473,7 @@ public: }; + /** @class wxFontList @wxheader{gdicmn.h} @@ -491,8 +491,7 @@ public: @library{wxcore} @category{gdi} - @seealso - wxFont + @see wxFont */ class wxFontList : public wxList { @@ -516,6 +515,7 @@ public: }; + /** @class wxSize @wxheader{gdicmn.h} @@ -535,8 +535,7 @@ public: @library{wxcore} @category{data} - @seealso - wxPoint, wxRealPoint + @see wxPoint, wxRealPoint */ class wxSize { @@ -666,6 +665,7 @@ public: }; + /** @class wxPenList @wxheader{gdicmn.h} @@ -700,8 +700,7 @@ public: @library{wxcore} @category{gdi} - @seealso - wxPen + @see wxPen */ class wxPenList { @@ -735,6 +734,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -772,7 +772,7 @@ wxSize wxGetDisplaySizeMM(); for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to avoid using @c #ifdefs when creating icons. - @see @ref overview_wxbitmapoverview, wxBITMAP + @see @ref overview_wxbitmapoverview, wxBITMAP() */ wxICON(); @@ -786,7 +786,7 @@ bool wxColourDisplay(); for which they exist, i.e. Windows and OS2) or from an XPM file. It allows to avoid using @c #ifdefs when creating bitmaps. - @see @ref overview_wxbitmapoverview, wxICON + @see @ref overview_wxbitmapoverview, wxICON() */ #define wxBITMAP() /* implementation is private */ diff --git a/interface/gdiobj.h b/interface/gdiobj.h index 917b0870e1..52464ff191 100644 --- a/interface/gdiobj.h +++ b/interface/gdiobj.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: gdiobj.h -// Purpose: documentation for wxGDIObject class +// Purpose: interface of wxGDIObject // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -23,8 +23,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxPen, wxBrush, wxFont + @see wxPen, wxBrush, wxFont */ class wxGDIObject : public wxObject { @@ -34,3 +33,4 @@ public: */ wxGDIObject(); }; + diff --git a/interface/glcanvas.h b/interface/glcanvas.h index 5b015bb87e..0a56f9e12d 100644 --- a/interface/glcanvas.h +++ b/interface/glcanvas.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: glcanvas.h -// Purpose: documentation for wxGLContext class +// Purpose: interface of wxGLContext // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -38,8 +38,7 @@ @library{wxgl} @category{gl} - @seealso - wxGLCanvas + @see wxGLCanvas */ class wxGLContext : public wxObject { @@ -73,6 +72,7 @@ public: }; + /** @class wxGLCanvas @wxheader{glcanvas.h} @@ -112,8 +112,7 @@ public: @library{wxgl} @category{gl} - @seealso - wxGLContext + @see wxGLContext */ class wxGLCanvas : public wxWindow { @@ -198,3 +197,4 @@ public: */ bool SwapBuffers(); }; + diff --git a/interface/graphics.h b/interface/graphics.h index 44c444ac66..c7808e8128 100644 --- a/interface/graphics.h +++ b/interface/graphics.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: graphics.h -// Purpose: documentation for wxGraphicsPath class +// Purpose: interface of wxGraphicsPath // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -157,6 +157,7 @@ public: }; + /** @class wxGraphicsObject @wxheader{graphics.h} @@ -167,8 +168,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxGraphicsBrush, wxGraphicsPen, wxGraphicsMatrix, wxGraphicsPath + @see wxGraphicsBrush, wxGraphicsPen, wxGraphicsMatrix, wxGraphicsPath */ class wxGraphicsObject : public wxObject { @@ -186,6 +186,7 @@ public: }; + /** @class wxGraphicsContext @wxheader{graphics.h} @@ -198,8 +199,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxGraphicsRenderer:: CreateContext + @see wxGraphicsRenderer:: CreateContext */ class wxGraphicsContext : public wxGraphicsObject { @@ -458,6 +458,7 @@ public: }; + /** @class wxGraphicsRenderer @wxheader{graphics.h} @@ -552,6 +553,7 @@ public: }; + /** @class wxGraphicsBrush @wxheader{graphics.h} @@ -567,6 +569,7 @@ public: }; + /** @class wxGraphicsFont @wxheader{graphics.h} @@ -582,6 +585,7 @@ public: }; + /** @class wxGraphicsPen @wxheader{graphics.h} @@ -597,6 +601,7 @@ public: }; + /** @class wxGraphicsMatrix @wxheader{graphics.h} @@ -680,3 +685,4 @@ public: */ void Translate(wxDouble dx, wxDouble dy); }; + diff --git a/interface/grid.h b/interface/grid.h index 61227206f7..5dd981d5da 100644 --- a/interface/grid.h +++ b/interface/grid.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: grid.h -// Purpose: documentation for wxGridCellFloatRenderer class +// Purpose: interface of wxGridCellFloatRenderer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,8 +15,7 @@ @library{wxadv} @category{FIXME} - @seealso - wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellStringRenderer, + @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellStringRenderer, wxGridCellBoolRenderer */ class wxGridCellFloatRenderer : public wxGridCellStringRenderer @@ -57,6 +56,7 @@ public: }; + /** @class wxGridTableBase @wxheader{grid.h} @@ -276,6 +276,7 @@ public: }; + /** @class wxGridCellEditor @wxheader{grid.h} @@ -289,8 +290,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellTextEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, + @see wxGridCellTextEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, wxGridCellNumberEditor, wxGridCellChoiceEditor */ class wxGridCellEditor @@ -383,6 +383,7 @@ public: }; + /** @class wxGridCellTextEditor @wxheader{grid.h} @@ -392,8 +393,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, + @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, wxGridCellNumberEditor, wxGridCellChoiceEditor */ class wxGridCellTextEditor : public wxGridCellEditor @@ -412,6 +412,7 @@ public: }; + /** @class wxGridCellStringRenderer @wxheader{grid.h} @@ -422,8 +423,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer, + @see wxGridCellRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer, wxGridCellBoolRenderer */ class wxGridCellStringRenderer : public wxGridCellRenderer @@ -436,6 +436,7 @@ public: }; + /** @class wxGridCellChoiceEditor @wxheader{grid.h} @@ -445,8 +446,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, + @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, wxGridCellTextEditor, wxGridCellNumberEditor */ class wxGridCellChoiceEditor : public wxGridCellEditor @@ -475,6 +475,7 @@ public: }; + /** @class wxGridEditorCreatedEvent @wxheader{grid.h} @@ -530,6 +531,7 @@ public: }; + /** @class wxGridRangeSelectEvent @wxheader{grid.h} @@ -614,6 +616,7 @@ public: }; + /** @class wxGridCellRenderer @wxheader{grid.h} @@ -628,9 +631,8 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellStringRenderer, wxGridCellNumberRenderer, wxGridCellFloatRenderer, - wxGridCellBoolRenderer + @see wxGridCellStringRenderer, wxGridCellNumberRenderer, + wxGridCellFloatRenderer, wxGridCellBoolRenderer */ class wxGridCellRenderer { @@ -660,6 +662,7 @@ public: }; + /** @class wxGridCellNumberEditor @wxheader{grid.h} @@ -669,8 +672,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, + @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellBoolEditor, wxGridCellTextEditor, wxGridCellChoiceEditor */ class wxGridCellNumberEditor : public wxGridCellTextEditor @@ -700,6 +702,7 @@ public: }; + /** @class wxGridSizeEvent @wxheader{grid.h} @@ -759,6 +762,7 @@ public: }; + /** @class wxGridCellNumberRenderer @wxheader{grid.h} @@ -768,8 +772,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer, + @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer, wxGridCellBoolRenderer */ class wxGridCellNumberRenderer : public wxGridCellStringRenderer @@ -782,6 +785,7 @@ public: }; + /** @class wxGridCellAttr @wxheader{grid.h} @@ -933,6 +937,7 @@ public: }; + /** @class wxGridCellBoolRenderer @wxheader{grid.h} @@ -943,8 +948,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer, + @see wxGridCellRenderer, wxGridCellStringRenderer, wxGridCellFloatRenderer, wxGridCellNumberRenderer */ class wxGridCellBoolRenderer : public wxGridCellRenderer @@ -957,6 +961,7 @@ public: }; + /** @class wxGridEvent @wxheader{grid.h} @@ -1027,6 +1032,7 @@ public: }; + /** @class wxGridCellFloatEditor @wxheader{grid.h} @@ -1036,8 +1042,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellEditor, wxGridCellNumberEditor, wxGridCellBoolEditor, + @see wxGridCellEditor, wxGridCellNumberEditor, wxGridCellBoolEditor, wxGridCellTextEditor, wxGridCellChoiceEditor */ class wxGridCellFloatEditor : public wxGridCellTextEditor @@ -1058,6 +1063,7 @@ public: }; + /** @class wxGrid @wxheader{grid.h} @@ -1108,8 +1114,7 @@ public: @library{wxadv} @category{miscwnd} - @seealso - @ref overview_gridoverview "wxGrid overview" + @see @ref overview_gridoverview "wxGrid overview" */ class wxGrid : public wxScrolledWindow { @@ -2708,6 +2713,7 @@ public: }; + /** @class wxGridCellBoolEditor @wxheader{grid.h} @@ -2717,8 +2723,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxGridCellEditor, wxGridCellFloatEditor, wxGridCellNumberEditor, + @see wxGridCellEditor, wxGridCellFloatEditor, wxGridCellNumberEditor, wxGridCellTextEditor, wxGridCellChoiceEditor */ class wxGridCellBoolEditor : public wxGridCellEditor @@ -2747,6 +2752,7 @@ public: }; + /** @class wxGridUpdateLocker @wxheader{grid.h} @@ -2803,3 +2809,4 @@ public: */ void Create(wxGrid* grid); }; + diff --git a/interface/hash.h b/interface/hash.h index 6de44b96a8..b7bfc1091a 100644 --- a/interface/hash.h +++ b/interface/hash.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: hash.h -// Purpose: documentation for wxHashTable class +// Purpose: interface of wxHashTable // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -20,8 +20,7 @@ @library{wxbase} @category{containers} - @seealso - wxList + @see wxList */ class wxHashTable : public wxObject { @@ -105,3 +104,4 @@ public: void Put(const char* key, wxObject* object); //@} }; + diff --git a/interface/hashmap.h b/interface/hashmap.h index 46996d7c5a..bfba745898 100644 --- a/interface/hashmap.h +++ b/interface/hashmap.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: hashmap.h -// Purpose: documentation for wxHashMap class +// Purpose: interface of wxHashMap // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -103,3 +103,4 @@ public: */ size_type size() const; }; + diff --git a/interface/hashset.h b/interface/hashset.h index 42b7c87d62..1470b29ef0 100644 --- a/interface/hashset.h +++ b/interface/hashset.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: hashset.h -// Purpose: documentation for wxHashSet class +// Purpose: interface of wxHashSet // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -96,3 +96,4 @@ public: */ size_type size() const; }; + diff --git a/interface/help.h b/interface/help.h index 0a8609ca2e..68b1425330 100644 --- a/interface/help.h +++ b/interface/help.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: help.h -// Purpose: documentation for wxHelpController class +// Purpose: interface of wxHelpController // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -56,7 +56,7 @@ The default browser is Netscape Navigator. The 'help' sample shows its use. wxWinceHelpController, for controlling a simple @c .htm help controller for Windows CE applications. - wxHtmlHelpController, a sophisticated help controller using wxHTML, in + wxHtmlHelpController, a sophisticated help controller using wxHTML(), in a similar style to the Microsoft HTML Help viewer and using some of the same files. Although it has an API compatible with other help controllers, it has more @@ -72,8 +72,7 @@ @library{wxbase} @category{help} - @seealso - wxHtmlHelpController, wxHTML + @see wxHtmlHelpController, wxHTML() */ class wxHelpController : public wxObject { @@ -244,3 +243,4 @@ public: */ virtual void SetViewer(const wxString& viewer, long flags); }; + diff --git a/interface/html/helpctrl.h b/interface/html/helpctrl.h index 516455866f..ee3869a63b 100644 --- a/interface/html/helpctrl.h +++ b/interface/html/helpctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/helpctrl.h -// Purpose: documentation for wxHtmlHelpController class +// Purpose: interface of wxHtmlHelpController // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,7 +24,7 @@ wxHTML uses Microsoft's HTML Help Workshop project files (.hhp, .hhk, .hhc) as its - native format. The file format is described here. + native format. The file format is described here(). Have a look at docs/html/ directory where sample project files are stored. You can use Tex2RTF to produce these files when generating HTML, if you set @b @@ -35,8 +35,7 @@ @library{wxhtml} @category{help} - @seealso - @ref overview_wxhelpcontroller "Information about wxBestHelpController", + @see @ref overview_wxhelpcontroller "Information about wxBestHelpController", wxHtmlHelpFrame, wxHtmlHelpDialog, wxHtmlHelpWindow, wxHtmlModalHelp */ class wxHtmlHelpController @@ -159,6 +158,7 @@ public: }; + /** @class wxHtmlModalHelp @headerfile helpctrl.h wx/html/helpctrl.h @@ -199,3 +199,4 @@ public: const wxString& topic = wxEmptyString, int style = wxHF_DEFAULT_STYLE | wxHF_DIALOG | wxHF_MODAL); }; + diff --git a/interface/html/helpdata.h b/interface/html/helpdata.h index 9081a44897..f124c123a1 100644 --- a/interface/html/helpdata.h +++ b/interface/html/helpdata.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/helpdata.h -// Purpose: documentation for wxHtmlHelpData class +// Purpose: interface of wxHtmlHelpData // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -66,3 +66,4 @@ public: */ void SetTempDir(const wxString& path); }; + diff --git a/interface/html/helpdlg.h b/interface/html/helpdlg.h index 10351df5bc..3b689e837d 100644 --- a/interface/html/helpdlg.h +++ b/interface/html/helpdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/helpdlg.h -// Purpose: documentation for wxHtmlHelpDialog class +// Purpose: interface of wxHtmlHelpDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -79,3 +79,4 @@ public: void WriteCustomization(wxConfigBase* cfg, const wxString& path = wxEmptyString); }; + diff --git a/interface/html/helpfrm.h b/interface/html/helpfrm.h index 99be55b90e..90d084eb5b 100644 --- a/interface/html/helpfrm.h +++ b/interface/html/helpfrm.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/helpfrm.h -// Purpose: documentation for wxHtmlHelpFrame class +// Purpose: interface of wxHtmlHelpFrame // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -79,3 +79,4 @@ public: void WriteCustomization(wxConfigBase* cfg, const wxString& path = wxEmptyString); }; + diff --git a/interface/html/helpwnd.h b/interface/html/helpwnd.h index 42123e7905..192661a073 100644 --- a/interface/html/helpwnd.h +++ b/interface/html/helpwnd.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/helpwnd.h -// Purpose: documentation for wxHtmlHelpWindow class +// Purpose: interface of wxHtmlHelpWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -165,3 +165,4 @@ public: void WriteCustomization(wxConfigBase* cfg, const wxString& path = wxEmptyString); }; + diff --git a/interface/html/htmlcell.h b/interface/html/htmlcell.h index 66475f0780..d4127f8b29 100644 --- a/interface/html/htmlcell.h +++ b/interface/html/htmlcell.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/htmlcell.h -// Purpose: documentation for wxHtmlColourCell class +// Purpose: interface of wxHtmlColourCell // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -53,6 +53,7 @@ public: }; + /** @class wxHtmlWidgetCell @headerfile htmlcell.h wx/html/htmlcell.h @@ -86,6 +87,7 @@ public: }; + /** @class wxHtmlCell @headerfile htmlcell.h wx/html/htmlcell.h @@ -102,8 +104,7 @@ public: @library{wxhtml} @category{FIXME} - @seealso - @ref overview_cells "Cells Overview", wxHtmlContainerCell + @see @ref overview_cells "Cells Overview", wxHtmlContainerCell */ class wxHtmlCell : public wxObject { @@ -312,6 +313,7 @@ public: }; + /** @class wxHtmlContainerCell @headerfile htmlcell.h wx/html/htmlcell.h @@ -322,8 +324,7 @@ public: @library{wxhtml} @category{FIXME} - @seealso - @ref overview_cells "Cells Overview" + @see @ref overview_cells "Cells Overview" */ class wxHtmlContainerCell : public wxHtmlCell { @@ -676,6 +677,7 @@ public: }; + /** @class wxHtmlLinkInfo @headerfile htmlcell.h wx/html/htmlcell.h @@ -727,3 +729,4 @@ public: */ wxString GetTarget(); }; + diff --git a/interface/html/htmlfilt.h b/interface/html/htmlfilt.h index aea59f70bf..9a40dbcff1 100644 --- a/interface/html/htmlfilt.h +++ b/interface/html/htmlfilt.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/htmlfilt.h -// Purpose: documentation for wxHtmlFilter class +// Purpose: interface of wxHtmlFilter // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,7 @@ @library{wxhtml} @category{FIXME} - @seealso - Overview + @see Overview() */ class wxHtmlFilter : public wxObject { @@ -39,3 +38,4 @@ public: */ wxString ReadFile(const wxFSFile& file); }; + diff --git a/interface/html/htmlpars.h b/interface/html/htmlpars.h index f9cc0bcf92..c11115af3a 100644 --- a/interface/html/htmlpars.h +++ b/interface/html/htmlpars.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/htmlpars.h -// Purpose: documentation for wxHtmlTagHandler class +// Purpose: interface of wxHtmlTagHandler // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -14,8 +14,7 @@ @library{wxhtml} @category{html} - @seealso - Overview, wxHtmlTag + @see Overview(), wxHtmlTag */ class wxHtmlTagHandler : public wxObject { @@ -63,6 +62,7 @@ public: }; + /** @class wxHtmlParser @headerfile htmlpars.h wx/html/htmlpars.h @@ -88,8 +88,7 @@ public: @library{wxhtml} @category{html} - @seealso - @ref overview_cells "Cells Overview", @ref overview_handlers "Tag Handlers + @see @ref overview_cells "Cells Overview", @ref overview_handlers "Tag Handlers Overview", wxHtmlTag */ class wxHtmlParser @@ -268,3 +267,4 @@ public: */ void StopParsing(); }; + diff --git a/interface/html/htmltag.h b/interface/html/htmltag.h index 9e10b396de..6a6ef9606e 100644 --- a/interface/html/htmltag.h +++ b/interface/html/htmltag.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/htmltag.h -// Purpose: documentation for wxHtmlTag class +// Purpose: interface of wxHtmlTag // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -127,3 +127,4 @@ public: wxString ScanParam(const wxString& par, const wxChar* format, void* value) const; }; + diff --git a/interface/html/htmlwin.h b/interface/html/htmlwin.h index 2c13a2fc9a..5481b9570c 100644 --- a/interface/html/htmlwin.h +++ b/interface/html/htmlwin.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/htmlwin.h -// Purpose: documentation for wxHtmlWindow class +// Purpose: interface of wxHtmlWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -36,8 +36,7 @@ @library{wxhtml} @category{html} - @seealso - wxHtmlLinkEvent, wxHtmlCellEvent + @see wxHtmlLinkEvent, wxHtmlCellEvent */ class wxHtmlWindow : public wxScrolledWindow { @@ -395,6 +394,7 @@ public: }; + /** @class wxHtmlLinkEvent @headerfile htmlwin.h wx/html/htmlwin.h @@ -420,6 +420,7 @@ public: }; + /** @class wxHtmlCellEvent @headerfile htmlwin.h wx/html/htmlwin.h @@ -465,3 +466,4 @@ public: */ bool SetLinkClicked(bool linkclicked); }; + diff --git a/interface/html/htmprint.h b/interface/html/htmprint.h index e5b66c3d9f..7e5cb99a06 100644 --- a/interface/html/htmprint.h +++ b/interface/html/htmprint.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/htmprint.h -// Purpose: documentation for wxHtmlDCRenderer class +// Purpose: interface of wxHtmlDCRenderer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -93,6 +93,7 @@ public: }; + /** @class wxHtmlEasyPrinting @headerfile htmprint.h wx/html/htmprint.h @@ -232,6 +233,7 @@ public: }; + /** @class wxHtmlPrintout @headerfile htmprint.h wx/html/htmprint.h @@ -325,3 +327,4 @@ public: float right = 25.2, float spaces = 5); }; + diff --git a/interface/html/winpars.h b/interface/html/winpars.h index eae544e95d..4b6a71af1d 100644 --- a/interface/html/winpars.h +++ b/interface/html/winpars.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: html/winpars.h -// Purpose: documentation for wxHtmlTagsModule class +// Purpose: interface of wxHtmlTagsModule // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,8 @@ @library{wxhtml} @category{FIXME} - @seealso - @ref overview_handlers "Tag Handlers", wxHtmlTagHandler, wxHtmlWinTagHandler, + @see @ref overview_handlers "Tag Handlers", wxHtmlTagHandler, + wxHtmlWinTagHandler, */ class wxHtmlTagsModule : public wxModule { @@ -36,6 +36,7 @@ public: }; + /** @class wxHtmlWinTagHandler @headerfile winpars.h wx/html/winpars.h @@ -60,6 +61,7 @@ public: }; + /** @class wxHtmlWinParser @headerfile winpars.h wx/html/winpars.h @@ -72,8 +74,7 @@ public: @library{wxhtml} @category{html} - @seealso - @ref overview_handlers "Handlers overview" + @see @ref overview_handlers "Handlers overview" */ class wxHtmlWinParser : public wxHtmlParser { @@ -90,13 +91,13 @@ public: //@} /** - Adds module to the list of wxHtmlWinParser tag handler. + Adds module() to the list of wxHtmlWinParser tag handler. */ static void AddModule(wxHtmlTagsModule module); /** Closes the container, sets actual container to the parent one - and returns pointer to it (see Overview). + and returns pointer to it (see Overview()). */ wxHtmlContainerCell* CloseContainer(); @@ -139,7 +140,7 @@ public: int GetCharWidth() const; /** - Returns pointer to the currently opened container (see Overview). + Returns pointer to the currently opened container (see Overview()). Common use: */ wxHtmlContainerCell* GetContainer() const; @@ -218,7 +219,7 @@ public: wxHtmlWindow* GetWindow(); /** - Opens new container and returns pointer to it (see Overview). + Opens new container and returns pointer to it (see Overview()). */ wxHtmlContainerCell* OpenContainer(); @@ -310,3 +311,4 @@ public: */ void SetLinkColor(const wxColour& clr); }; + diff --git a/interface/htmllbox.h b/interface/htmllbox.h index 761935808a..455d5d0c06 100644 --- a/interface/htmllbox.h +++ b/interface/htmllbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: htmllbox.h -// Purpose: documentation for wxHtmlListBox class +// Purpose: interface of wxHtmlListBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -20,8 +20,7 @@ @category{ctrl} @appearance{htmllistbox.png} - @seealso - wxSimpleHtmlListBox + @see wxSimpleHtmlListBox */ class wxHtmlListBox : public wxVListBox { @@ -130,6 +129,7 @@ public: }; + /** @class wxSimpleHtmlListBox @wxheader{htmllbox.h} @@ -179,8 +179,7 @@ public: @category{ctrl} @appearance{simplehtmllistbox.png} - @seealso - wxSimpleHtmlListBox::Create + @see wxSimpleHtmlListBox::Create */ class wxSimpleHtmlListBox : public wxHtmlListBox { @@ -238,3 +237,4 @@ public: const wxString& name = "simpleHtmlListBox"); //@} }; + diff --git a/interface/hyperlink.h b/interface/hyperlink.h index 05bda19292..665a8ec43e 100644 --- a/interface/hyperlink.h +++ b/interface/hyperlink.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: hyperlink.h -// Purpose: documentation for wxHyperlinkEvent class +// Purpose: interface of wxHyperlinkEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -37,6 +37,7 @@ public: }; + /** @class wxHyperlinkCtrl @wxheader{hyperlink.h} @@ -46,7 +47,7 @@ public: clicks on the hyperlink, a wxHyperlinkEvent is sent but if that event is not handled (or it's skipped; see wxEvent::Skip), then a call to - wxLaunchDefaultBrowser is done with the + wxLaunchDefaultBrowser() is done with the hyperlink's URL. Note that standard wxWindow functions like wxWindow::SetBackgroundColour, @@ -73,8 +74,7 @@ public: @category{ctrl} @appearance{hyperlinkctrl.png} - @seealso - wxURL, wxHyperlinkEvent + @see wxURL, wxHyperlinkEvent */ class wxHyperlinkCtrl : public wxControl { @@ -183,3 +183,4 @@ public: long style, const wxString& name = "hyperlink"); }; + diff --git a/interface/icon.h b/interface/icon.h index d520862da0..c66d073aed 100644 --- a/interface/icon.h +++ b/interface/icon.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: icon.h -// Purpose: documentation for wxIcon class +// Purpose: interface of wxIcon // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -25,11 +25,9 @@ @category{gdi} @stdobjects - Objects: - wxNullIcon + ::Objects:, ::wxNullIcon, - @seealso - @ref overview_wxbitmapoverview "Bitmap and icon overview", @ref + @see @ref overview_wxbitmapoverview "Bitmap and icon overview", @ref overview_supportedbitmapformats "supported bitmap file formats", wxDC::DrawIcon, wxCursor */ class wxIcon : public wxBitmap @@ -37,7 +35,7 @@ class wxIcon : public wxBitmap public: //@{ /** - Loads an icon from the specified location. + Loads an icon from the specified location(). @param bits Specifies an array of pixel values. @@ -314,3 +312,17 @@ public: */ wxIcon operator =(const wxIcon& icon); }; + + +/** + FIXME +*/ +wxIcon Objects: +; + +/** + FIXME +*/ +wxIcon wxNullIcon; + + diff --git a/interface/iconbndl.h b/interface/iconbndl.h index a19ea45440..1ac83d47c5 100644 --- a/interface/iconbndl.h +++ b/interface/iconbndl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: iconbndl.h -// Purpose: documentation for wxIconBundle class +// Purpose: interface of wxIconBundle // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,7 +18,7 @@ @category{FIXME} @stdobjects - wxNullIconBundle + ::wxNullIconBundle, */ class wxIconBundle : public wxGDIObject { @@ -79,3 +79,11 @@ public: */ bool operator ==(const wxIconBundle& ic); }; + + +/** + FIXME +*/ +wxIconBundle wxNullIconBundle; + + diff --git a/interface/iconloc.h b/interface/iconloc.h index 855736748c..4ed130a56c 100644 --- a/interface/iconloc.h +++ b/interface/iconloc.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: iconloc.h -// Purpose: documentation for wxIconLocation class +// Purpose: interface of wxIconLocation // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -25,8 +25,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxIcon, wxFileType::GetIcon + @see wxIcon, wxFileType::GetIcon */ class wxIconLocation { @@ -37,3 +36,4 @@ public: */ bool IsOk() const; }; + diff --git a/interface/image.h b/interface/image.h index d2b9ec7bf7..c3ae734275 100644 --- a/interface/image.h +++ b/interface/image.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: image.h -// Purpose: documentation for wxImageHandler class +// Purpose: interface of wxImageHandler // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -22,8 +22,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxImage, wxInitAllImageHandlers + @see wxImage, wxInitAllImageHandlers() */ class wxImageHandler : public wxObject { @@ -137,6 +136,7 @@ public: }; + /** @class wxImage @wxheader{image.h} @@ -161,8 +161,7 @@ public: @library{wxcore} @category{gdi} - @seealso - wxBitmap, wxInitAllImageHandlers + @see wxBitmap, wxInitAllImageHandlers() */ class wxImage : public wxObject { @@ -869,7 +868,7 @@ public: This function is called by wxWidgets on startup, and shouldn't be called by the user. - @see wxImageHandler, wxInitAllImageHandlers, wxQuantize + @see wxImageHandler, wxInitAllImageHandlers(), wxQuantize */ static void InitStandardHandlers(); @@ -1463,6 +1462,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/imaglist.h b/interface/imaglist.h index c045a0dee4..f66d1dbdc5 100644 --- a/interface/imaglist.h +++ b/interface/imaglist.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: imaglist.h -// Purpose: documentation for wxImageList class +// Purpose: interface of wxImageList // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,8 +21,7 @@ @library{wxcore} @category{gdi} - @seealso - wxTreeCtrl, wxListCtrl + @see wxTreeCtrl, wxListCtrl */ class wxImageList : public wxObject { @@ -206,3 +205,4 @@ public: bool Replace(int index, const wxIcon& icon); //@} }; + diff --git a/interface/init.h b/interface/init.h index ba0ac3249b..2872ccc251 100644 --- a/interface/init.h +++ b/interface/init.h @@ -1,13 +1,13 @@ ///////////////////////////////////////////////////////////////////////////// // Name: init.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// /** -Free resources allocated by a successful call to wxEntryStart. +Free resources allocated by a successful call to wxEntryStart(). */ void wxEntryCleanup(); diff --git a/interface/intl.h b/interface/intl.h index e7608edf26..14a954db63 100644 --- a/interface/intl.h +++ b/interface/intl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: intl.h -// Purpose: documentation for wxLocale class +// Purpose: interface of wxLocale // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -54,8 +54,7 @@ @library{wxbase} @category{FIXME} - @seealso - @ref overview_internationalization, @ref overview_sampleinternat "Internat + @see @ref overview_internationalization, @ref overview_sampleinternat "Internat sample", wxXLocale */ class wxLocale @@ -104,8 +103,8 @@ public: @a msgIdLanguage and @e msgIdCharset. @a msgIdLanguage specifies the language of "msgid" strings in source code (i.e. arguments to GetString(), - wxGetTranslation and the - _ macro). It is used if AddCatalog cannot find any + wxGetTranslation() and the + _() macro). It is used if AddCatalog cannot find any catalog for current language: if the language is same as source code language, then strings from source code are used instead. @a msgIdCharset lets you specify the charset used for msgids in sources @@ -178,7 +177,7 @@ public: const wxString& domain = wxEmptyString) const; /** - Returns wxLanguage constant of current language. + Returns wxLanguage() constant of current language. Note that you can call this function only if you used the form of Init() that takes wxLanguage argument. */ @@ -234,8 +233,8 @@ public: message catalog is found @a origString is returned if 'n == 1', otherwise @e origString2. See GNU gettext manual for additional information on plural forms handling. - This method is called by the wxGetTranslation - function and _ macro. + This method is called by the wxGetTranslation() + function and _() macro. @remarks Domains are searched in the last to first order, i.e. catalogs added later override those added before. @@ -256,7 +255,7 @@ public: /** Tries to detect the user's default font encoding. - Returns wxFontEncoding value or + Returns wxFontEncoding() value or @b wxFONTENCODING_SYSTEM if it couldn't be determined. */ static wxFontEncoding GetSystemEncoding() const; @@ -273,7 +272,7 @@ public: /** Tries to detect the user's default language setting. - Returns wxLanguage value or + Returns wxLanguage() value or @b wxLANGUAGE_UNKNOWN if the language-guessing algorithm failed. */ static int GetSystemLanguage() const; @@ -364,7 +363,8 @@ public: FindLanguageInfo() to obtain its wxLanguageInfo structure. See AddLanguage() for the wxLanguageInfo description. - This function is new since wxWidgets version 2.7.1. + + @wxsince{2.7.1}. */ static bool IsAvailable(int lang); @@ -390,6 +390,7 @@ public: }; + /** @class wxXLocale @wxheader{intl.h} @@ -452,8 +453,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxLocale + @see wxLocale */ class wxXLocale { @@ -532,13 +532,14 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ /** - This macro is identical to _ but for the plural variant - of wxGetTranslation. + This macro is identical to _() but for the plural variant + of wxGetTranslation(). */ #define const wxString wxPLURAL(const wxString& sing, const wxString& plur, @@ -549,9 +550,9 @@ size_t n) /* implementation is private */ value of its argument. However it does have a purpose which is to mark the literal strings for the extraction into the message catalog created by @c xgettext program. Usually - this is achieved using _ but that macro not only marks + this is achieved using _() but that macro not only marks the string for extraction but also expands into a - wxGetTranslation function call which means that it + wxGetTranslation() function call which means that it cannot be used in some situations, notably for static array initialization. Here is an example which should make it more clear: suppose that you have a @@ -585,18 +586,18 @@ size_t n) /* implementation is private */ #define const wxChar* wxTRANSLATE(const char* s) /* implementation is private */ /** - This macro expands into a call to wxGetTranslation + This macro expands into a call to wxGetTranslation() function, so it marks the message for the extraction by @c xgettext just as - wxTRANSLATE does, but also returns the translation of + wxTRANSLATE() does, but also returns the translation of the string for the current locale during execution. - Don't confuse this macro with _T! + Don't confuse this macro with _T()! */ const wxString _(const wxString& s); //@{ /** This function returns the translation of string @a str in the current - locale. If the string is not found in any of the loaded + locale(). If the string is not found in any of the loaded message catalogs (see @ref overview_internationalization "internationalization overview"), the original string is returned. In debug build, an error message is logged -- this @@ -604,7 +605,7 @@ const wxString _(const wxString& s); @a domain is specified then only that domain/catalog is searched for a matching string. As this function is used very often, an alternative (and also common in Unix world) syntax is - provided: the _ macro is defined to do the same thing + provided: the _() macro is defined to do the same thing as wxGetTranslation. The second form is used when retrieving translation of string that has different singular and plural form in English or different plural forms in some @@ -616,14 +617,14 @@ const wxString _(const wxString& s); otherwise @e strPlural. See GNU gettext manual for additional information on plural forms handling. For a shorter alternative - see the wxPLURAL macro. + see the wxPLURAL() macro. Both versions call wxLocale::GetString. Note that this function is not suitable for literal strings in Unicode builds, since the literal strings must be enclosed into - _T or wxT macro which makes them + _T() or wxT() macro which makes them unrecognised by @c xgettext, and so they are not extracted to the message - catalog. Instead, use the _ and - wxPLURAL macro for all literal strings. + catalog. Instead, use the _() and + wxPLURAL() macro for all literal strings. */ const wxString wxGetTranslation(const wxString& str, const wxString& domain = wxEmptyString); diff --git a/interface/ipc.h b/interface/ipc.h index 811564e9e4..c6bd35c787 100644 --- a/interface/ipc.h +++ b/interface/ipc.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: ipc.h -// Purpose: documentation for wxConnection class +// Purpose: interface of wxConnection // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -28,8 +28,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxClient, wxServer, @ref overview_ipcoverview "Interprocess communications + @see wxClient, wxServer, @ref overview_ipcoverview "Interprocess communications overview" */ class wxConnection : public wxObject @@ -210,6 +209,7 @@ public: }; + /** @class wxClient @wxheader{ipc.h} @@ -234,9 +234,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxServer, wxConnection, @ref overview_ipcoverview "Interprocess communications - overview" + @see wxServer, wxConnection, @ref overview_ipcoverview "Interprocess + communications overview" */ class wxClient : public wxObject { @@ -289,6 +288,7 @@ public: }; + /** @class wxServer @wxheader{ipc.h} @@ -312,8 +312,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxClient, wxConnection, IPC, overview + @see wxClient, wxConnection, IPC, overview() */ class wxServer { @@ -348,3 +347,4 @@ public: */ virtual wxConnectionBase* OnAcceptConnection(const wxString& topic); }; + diff --git a/interface/joystick.h b/interface/joystick.h index 52bad0c9fa..266d41a9e0 100644 --- a/interface/joystick.h +++ b/interface/joystick.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: joystick.h -// Purpose: documentation for wxJoystick class +// Purpose: interface of wxJoystick // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,8 +15,7 @@ @library{wxadv} @category{FIXME} - @seealso - wxJoystickEvent + @see wxJoystickEvent */ class wxJoystick : public wxObject { @@ -270,3 +269,4 @@ public: */ void SetMovementThreshold(int threshold); }; + diff --git a/interface/layout.h b/interface/layout.h index 2ff6b2d3f2..cdfc160005 100644 --- a/interface/layout.h +++ b/interface/layout.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: layout.h -// Purpose: documentation for wxIndividualLayoutConstraint class +// Purpose: interface of wxIndividualLayoutConstraint // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -20,9 +20,8 @@ @library{wxcore} @category{winlayout} - @seealso - @ref overview_constraintsoverview "Overview and examples", wxLayoutConstraints, - wxWindow::SetConstraints. + @see @ref overview_constraintsoverview "Overview and examples", + wxLayoutConstraints, wxWindow::SetConstraints. */ class wxIndividualLayoutConstraint : public wxObject { @@ -180,11 +179,12 @@ public: }; + /** @class wxLayoutConstraints @wxheader{layout.h} - @b Note: constraints are now deprecated and you should use sizers instead. + @b Note: constraints are now deprecated and you should use sizers() instead. Objects of this class can be associated with a window to define its layout constraints, with respect to siblings or its parent. @@ -224,8 +224,7 @@ public: @library{wxcore} @category{winlayout} - @seealso - @ref overview_constraintsoverview "Overview and examples", + @see @ref overview_constraintsoverview "Overview and examples", wxIndividualLayoutConstraint, wxWindow::SetConstraints */ class wxLayoutConstraints : public wxObject @@ -283,3 +282,4 @@ public: Constraint for the width. */ }; + diff --git a/interface/laywin.h b/interface/laywin.h index 98e4d1a125..59f704333f 100644 --- a/interface/laywin.h +++ b/interface/laywin.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: laywin.h -// Purpose: documentation for wxLayoutAlgorithm class +// Purpose: interface of wxLayoutAlgorithm // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -90,8 +90,7 @@ @library{wxadv} @category{winlayout} - @seealso - wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview + @see wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview */ class wxLayoutAlgorithm : public wxObject { @@ -135,6 +134,7 @@ public: }; + /** @class wxSashLayoutWindow @wxheader{laywin.h} @@ -152,8 +152,7 @@ public: @library{wxadv} @category{miscwnd} - @seealso - wxLayoutAlgorithm, wxSashWindow, @ref overview_eventhandlingoverview + @see wxLayoutAlgorithm, wxSashWindow, @ref overview_eventhandlingoverview */ class wxSashLayoutWindow : public wxSashWindow { @@ -276,6 +275,7 @@ public: }; + /** @class wxQueryLayoutInfoEvent @wxheader{laywin.h} @@ -288,8 +288,7 @@ public: @library{wxadv} @category{events} - @seealso - wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm. + @see wxCalculateLayoutEvent, wxSashLayoutWindow, wxLayoutAlgorithm. */ class wxQueryLayoutInfoEvent : public wxEvent { @@ -366,6 +365,7 @@ public: }; + /** @class wxCalculateLayoutEvent @wxheader{laywin.h} @@ -377,8 +377,7 @@ public: @library{wxadv} @category{events} - @seealso - wxQueryLayoutInfoEvent, wxSashLayoutWindow, wxLayoutAlgorithm. + @see wxQueryLayoutInfoEvent, wxSashLayoutWindow, wxLayoutAlgorithm. */ class wxCalculateLayoutEvent : public wxEvent { @@ -414,3 +413,4 @@ public: */ void SetRect(const wxRect& rect); }; + diff --git a/interface/link.h b/interface/link.h index 5cf6774bc9..28f39ec619 100644 --- a/interface/link.h +++ b/interface/link.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: link.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -8,7 +8,7 @@ /** This macro can be used in conjunction with the -wxFORCE_LINK_MODULE macro to force +wxFORCE_LINK_MODULE() macro to force the linker to include in its output a specific object file. In particular, you should use this macro in the source file which you want to force for inclusion. The @c moduleName needs to be a name not already @@ -20,13 +20,13 @@ to be e.g. the same name of the source file (even if it's a good choice). /** This macro can be used in conjunction with the -wxFORCE_LINK_THIS_MODULE macro to force +wxFORCE_LINK_THIS_MODULE() macro to force the linker to include in its output a specific object file. In particular, you should use this macro in a source file which you know for sure is linked in the output (e.g. the source file containing the "main()" of your app). The @c moduleName is the name of the module you want to forcefully link -(i.e. the name you used in the relative wxFORCE_LINK_THIS_MODULE macro. +(i.e. the name you used in the relative wxFORCE_LINK_THIS_MODULE() macro. */ #define wxFORCE_LINK_MODULE() /* implementation is private */ diff --git a/interface/list.h b/interface/list.h index 218b4e5f0c..6988f7feb8 100644 --- a/interface/list.h +++ b/interface/list.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: list.h -// Purpose: documentation for wxList class +// Purpose: interface of wxList // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -37,8 +37,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxArrayT, wxVectorT + @see wxArrayT(), wxVectorT() */ class wxList { @@ -305,6 +304,7 @@ public: }; + /** @class wxNode @wxheader{list.h} @@ -327,8 +327,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxList, wxHashTable + @see wxList, wxHashTable */ class wxNode { @@ -360,3 +359,4 @@ public: */ void SetData(T* data); }; + diff --git a/interface/listbook.h b/interface/listbook.h index a6b21fad18..f0e7245365 100644 --- a/interface/listbook.h +++ b/interface/listbook.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: listbook.h -// Purpose: documentation for wxListbook class +// Purpose: interface of wxListbook // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -37,8 +37,7 @@ @library{wxcore} @category{miscwnd} - @seealso - wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample" + @see wxBookCtrl(), wxNotebook, @ref overview_samplenotebook "notebook sample" */ class wxListbook : public wxBookCtrl overview { @@ -55,3 +54,4 @@ public: const wxString& name = wxEmptyStr); //@} }; + diff --git a/interface/listbox.h b/interface/listbox.h index fd357dc193..497bac585c 100644 --- a/interface/listbox.h +++ b/interface/listbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: listbox.h -// Purpose: documentation for wxListBox class +// Purpose: interface of wxListBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -56,8 +56,7 @@ @category{ctrl} @appearance{listbox.png} - @seealso - wxChoice, wxComboBox, wxListCtrl, wxCommandEvent + @see wxChoice, wxComboBox, wxListCtrl, wxCommandEvent */ class wxListBox : public wxControlWithItems { @@ -163,7 +162,8 @@ public: /** Returns the item located at @e point, or @c wxNOT_FOUND if there is no item located at @e point. - This function is new since wxWidgets version 2.7.0. It is currently implemented + + @wxsince{2.7.0}. It is currently implemented for wxMSW, wxMac and wxGTK2 ports. @@ -236,3 +236,4 @@ public: void SetFirstItem(const wxString& string); //@} }; + diff --git a/interface/listctrl.h b/interface/listctrl.h index 8506202c8a..96f624a37f 100644 --- a/interface/listctrl.h +++ b/interface/listctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: listctrl.h -// Purpose: documentation for wxListCtrl class +// Purpose: interface of wxListCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -40,7 +40,7 @@ @b Mac Note: Starting with 2.8, wxListCtrl uses a native implementation for report mode, and uses a generic implementation for other modes. You can use the generic implementation for report mode as well by setting the - mac.listctrl.always_use_generic wxSystemOption to + mac.listctrl.always_use_generic wxSystemOption() to 1. @beginStyleTable @@ -86,9 +86,8 @@ @category{ctrl} @appearance{listctrl.png} - @seealso - @ref overview_wxlistctrloverview "wxListCtrl overview", wxListView, wxListBox, - wxTreeCtrl, wxImageList, wxListEvent, wxListItem + @see @ref overview_wxlistctrloverview "wxListCtrl overview", wxListView, + wxListBox, wxTreeCtrl, wxImageList, wxListEvent, wxListItem */ class wxListCtrl : public wxControl { @@ -442,7 +441,8 @@ public: for GetItemRect(). @a code can be one of @c wxLIST_RECT_BOUNDS, @c wxLIST_RECT_ICON or @c wxLIST_RECT_LABEL. - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ bool GetSubItemRect(long item, long subItem, wxRect& rect, int code = wxLIST_RECT_BOUNDS) const; @@ -874,7 +874,8 @@ The m_stateMask and m_state members take flags from the following: be either an integer or a pointer cast to the @c wxUIntPtr type which is guaranteed to be large enough to be able to contain all integer types and pointers. - This function is new since wxWidgets version 2.8.4 + + @wxsince{2.8.4} */ bool SetItemPtrData(long item, wxUIntPtr data); @@ -932,6 +933,7 @@ The m_stateMask and m_state members take flags from the following: }; + /** @class wxListEvent @wxheader{listctrl.h} @@ -941,8 +943,7 @@ The m_stateMask and m_state members take flags from the following: @library{wxbase} @category{events} - @seealso - wxListCtrl + @see wxListCtrl */ class wxListEvent : public wxNotifyEvent { @@ -1029,6 +1030,7 @@ public: }; + /** @class wxListItemAttr @wxheader{listctrl.h} @@ -1039,8 +1041,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxlistctrloverview "wxListCtrl overview", wxListCtrl, wxListItem + @see @ref overview_wxlistctrloverview "wxListCtrl overview", wxListCtrl, + wxListItem */ class wxListItemAttr { @@ -1103,6 +1105,7 @@ public: }; + /** @class wxListView @wxheader{listctrl.h} @@ -1121,8 +1124,7 @@ public: @category{ctrl} @appearance{listview.png} - @seealso - wxListView::SetColumnImage + @see wxListView::SetColumnImage */ class wxListView : public wxListCtrl { @@ -1200,6 +1202,7 @@ public: }; + /** @class wxListItem @wxheader{listctrl.h} @@ -1407,3 +1410,4 @@ public: */ void SetWidth(int width); }; + diff --git a/interface/log.h b/interface/log.h index f02715016c..5061e46125 100644 --- a/interface/log.h +++ b/interface/log.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: log.h -// Purpose: documentation for wxLogWindow class +// Purpose: interface of wxLogWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -19,8 +19,7 @@ @library{wxbase} @category{logging} - @seealso - wxLogTextCtrl + @see wxLogTextCtrl */ class wxLogWindow : public wxLogInterposer { @@ -79,6 +78,7 @@ public: }; + /** @class wxLogInterposerTemp @wxheader{log.h} @@ -106,6 +106,7 @@ public: }; + /** @class wxLogChain @wxheader{log.h} @@ -186,6 +187,7 @@ public: }; + /** @class wxLogGui @wxheader{log.h} @@ -207,6 +209,7 @@ public: }; + /** @class wxLogStream @wxheader{log.h} @@ -219,8 +222,7 @@ public: @library{wxbase} @category{logging} - @seealso - wxLogStderr, wxStreamToTextRedirector + @see wxLogStderr, wxStreamToTextRedirector */ class wxLogStream : public wxLog { @@ -233,6 +235,7 @@ public: }; + /** @class wxLogStderr @wxheader{log.h} @@ -244,8 +247,7 @@ public: @library{wxbase} @category{logging} - @seealso - wxLogStream + @see wxLogStream */ class wxLogStderr : public wxLog { @@ -258,6 +260,7 @@ public: }; + /** @class wxLogBuffer @wxheader{log.h} @@ -295,6 +298,7 @@ public: }; + /** @class wxLogInterposer @wxheader{log.h} @@ -323,6 +327,7 @@ public: }; + /** @class wxLogTextCtrl @wxheader{log.h} @@ -334,8 +339,7 @@ public: @library{wxbase} @category{logging} - @seealso - wxTextCtrl, wxStreamToTextRedirector + @see wxTextCtrl, wxStreamToTextRedirector */ class wxLogTextCtrl : public wxLog { @@ -348,6 +352,7 @@ public: }; + /** @class wxLog @wxheader{log.h} @@ -371,15 +376,14 @@ public: @library{wxcore} @category{logging} - @seealso - wxLog::RemoveTraceMask, wxLog::GetTraceMasks + @see wxLog::RemoveTraceMask, wxLog::GetTraceMasks */ class wxLog { public: /** Add the @a mask to the list of allowed masks for - wxLogTrace. + wxLogTrace(). @see RemoveTraceMask(), GetTraceMasks() */ @@ -398,7 +402,7 @@ public: without writing a new log target class (which, aside of being a matter of several minutes, allows you to do anything you want). The verbose messages are the trace messages which are not disabled in the - release mode and are generated by wxLogVerbose. They + release mode and are generated by wxLogVerbose(). They are not normally shown to the user because they present little interest, but may be activated, for example, in order to help the user find some program problem. @@ -406,7 +410,7 @@ public: the (application global) @e trace mask. There are two ways to specify it: either by using SetTraceMask() and GetTraceMask() and using - wxLogTrace which takes an integer mask or by using + wxLogTrace() which takes an integer mask or by using AddTraceMask() for string trace masks. The difference between bit-wise and string trace masks is that a message using integer trace mask will only be logged if all bits of the mask are set in the @@ -423,7 +427,7 @@ public: the preferred way of working with trace messages. The integer trace mask is kept for compatibility and for additional (but very rarely needed) flexibility only. - The standard trace masks are given in wxLogTrace + The standard trace masks are given in wxLogTrace() documentation. Finally, the @e wxLog::DoLog() function automatically prepends a time stamp to all the messages. The format of the time stamp may be changed: it can be @@ -575,7 +579,7 @@ public: /** Returns @true if the @a mask is one of allowed masks for - wxLogTrace. + wxLogTrace(). See also: AddTraceMask(), RemoveTraceMask() */ @@ -614,7 +618,7 @@ public: /** Remove the @a mask from the list of allowed masks for - wxLogTrace. + wxLogTrace(). See also: AddTraceMask() */ static void RemoveTraceMask(const wxString& mask); @@ -683,6 +687,7 @@ public: }; + /** @class wxLogNull @wxheader{log.h} @@ -746,6 +751,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -755,7 +761,7 @@ public: call even before the application has been initialized or if it is currently in some other strange state (for example, about to crash). Under Windows this function shows a message box using a native dialog instead of - wxMessageBox (which might be unsafe to call), elsewhere + wxMessageBox() (which might be unsafe to call), elsewhere it simply prints the message to the standard output using the title as prefix. @param title @@ -764,7 +770,7 @@ public: @param text The text to show to the user - @see wxLogFatalError + @see wxLogFatalError() */ void wxSafeShowMessage(const wxString& title, const wxString& text); diff --git a/interface/longlong.h b/interface/longlong.h index d985c58b47..c30c66e90d 100644 --- a/interface/longlong.h +++ b/interface/longlong.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: longlong.h -// Purpose: documentation for wxLongLong class +// Purpose: interface of wxLongLong // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -30,10 +30,10 @@ If a native (i.e. supported directly by the compiler) 64 bit integer type was found to exist, @e wxLongLong_t macro will be defined to correspond to it. Also, in this case only, two additional macros will be defined: - wxLongLongFmtSpec for printing 64 bit integers + wxLongLongFmtSpec() for printing 64 bit integers using the standard @c printf() function (but see also wxLongLong::ToString for a more portable solution) and - wxLL for defining 64 bit integer compile-time constants. + wxLL() for defining 64 bit integer compile-time constants. @library{wxbase} @category{data} @@ -133,12 +133,14 @@ public: /** Assignment operator from unsigned long long. The sign bit will be copied too. - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ wxLongLong& operator operator=(const wxULongLong& ll); }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -155,7 +157,7 @@ public: #endif @endcode - @see wxLL + @see wxLL() */ @@ -169,7 +171,7 @@ public: #endif @endcode - @see wxLL, wxLongLong + @see wxLL(), wxLongLong */ wxLongLong_t wxULL(number); @@ -183,7 +185,7 @@ wxLongLong_t wxULL(number); #endif @endcode - @see wxULL, wxLongLong + @see wxULL(), wxLongLong */ wxLongLong_t wxLL(number); diff --git a/interface/math.h b/interface/math.h index 8e9d46ac17..cb05148368 100644 --- a/interface/math.h +++ b/interface/math.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: math.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license diff --git a/interface/mdi.h b/interface/mdi.h index 6700295387..c5543a403b 100644 --- a/interface/mdi.h +++ b/interface/mdi.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: mdi.h -// Purpose: documentation for wxMDIClientWindow class +// Purpose: interface of wxMDIClientWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxMDIChildFrame, wxMDIParentFrame, wxFrame + @see wxMDIChildFrame, wxMDIParentFrame, wxFrame */ class wxMDIClientWindow : public wxWindow { @@ -53,6 +52,7 @@ public: }; + /** @class wxMDIParentFrame @wxheader{mdi.h} @@ -101,8 +101,7 @@ public: @library{wxcore} @category{managedwnd} - @seealso - wxMDIChildFrame, wxMDIClientWindow, wxFrame, wxDialog + @see wxMDIChildFrame, wxMDIClientWindow, wxFrame, wxDialog */ class wxMDIParentFrame : public wxFrame { @@ -286,6 +285,7 @@ public: }; + /** @class wxMDIChildFrame @wxheader{mdi.h} @@ -323,8 +323,7 @@ public: @library{wxcore} @category{managedwnd} - @seealso - wxMDIClientWindow, wxMDIParentFrame, wxFrame + @see wxMDIClientWindow, wxMDIParentFrame, wxFrame */ class wxMDIChildFrame : public wxFrame { @@ -403,3 +402,4 @@ public: */ void Restore(); }; + diff --git a/interface/mediactrl.h b/interface/mediactrl.h index 26c90330ee..04dfa0a4bf 100644 --- a/interface/mediactrl.h +++ b/interface/mediactrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: mediactrl.h -// Purpose: documentation for wxMediaEvent class +// Purpose: interface of wxMediaEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -22,6 +22,7 @@ public: }; + /** @class wxMediaCtrl @wxheader{mediactrl.h} @@ -36,8 +37,7 @@ public: @library{wxmedia} @category{media} - @seealso - wxMediaEvent + @see wxMediaEvent */ class wxMediaCtrl : public wxControl { @@ -368,7 +368,7 @@ public: /** Stops the media. - See Operation for an overview of how + See Operation() for an overview of how stopping works. */ bool Stop(); @@ -397,3 +397,4 @@ public: original size without any extra assistance needed from the user. */ }; + diff --git a/interface/memory.h b/interface/memory.h index aa3b52849a..472e76cc04 100644 --- a/interface/memory.h +++ b/interface/memory.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: memory.h -// Purpose: documentation for wxDebugStreamBuf class +// Purpose: interface of wxDebugStreamBuf // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,8 +21,7 @@ @library{wxbase} @category{FIXME} - @seealso - Overview + @see Overview() */ class wxDebugStreamBuf { @@ -31,6 +30,7 @@ public: }; + /** @class wxDebugContext @wxheader{memory.h} @@ -45,8 +45,7 @@ public: @library{wxbase} @category{debugging} - @seealso - Overview + @see Overview() */ class wxDebugContext { @@ -234,6 +233,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/menu.h b/interface/menu.h index 3bb6333361..c572a85446 100644 --- a/interface/menu.h +++ b/interface/menu.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: menu.h -// Purpose: documentation for wxMenuBar class +// Purpose: interface of wxMenuBar // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,8 +15,7 @@ @library{wxcore} @category{menus} - @seealso - wxMenu, @ref overview_eventhandlingoverview + @see wxMenu, @ref overview_eventhandlingoverview */ class wxMenuBar : public wxWindow { @@ -344,6 +343,7 @@ public: }; + /** @class wxMenu @wxheader{menu.h} @@ -385,8 +385,7 @@ public: @library{wxcore} @category{menus} - @seealso - wxMenuBar, wxWindow::PopupMenu, @ref overview_eventhandlingoverview, @ref + @see wxMenuBar, wxWindow::PopupMenu, @ref overview_eventhandlingoverview, @ref overview_wxfilehistory "wxFileHistory (most recently used files menu)" */ class wxMenu : public wxEvtHandler @@ -800,3 +799,4 @@ public: */ void UpdateUI(wxEvtHandler* source = NULL) const; }; + diff --git a/interface/menuitem.h b/interface/menuitem.h index a2762af1b2..9be6f3b21d 100644 --- a/interface/menuitem.h +++ b/interface/menuitem.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: menuitem.h -// Purpose: documentation for wxMenuItem class +// Purpose: interface of wxMenuItem // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -20,8 +20,7 @@ @library{wxcore} @category{menus} - @seealso - wxMenuBar, wxMenu + @see wxMenuBar, wxMenu */ class wxMenuItem : public wxObject { @@ -283,3 +282,4 @@ public: */ void SetTextColour(const wxColour& colour); }; + diff --git a/interface/metafile.h b/interface/metafile.h index ced2a09fdc..78b060ed68 100644 --- a/interface/metafile.h +++ b/interface/metafile.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: metafile.h -// Purpose: documentation for wxMetafileDC class +// Purpose: interface of wxMetafileDC // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -30,8 +30,7 @@ @library{wxcore} @category{dc} - @seealso - wxMetafile, wxDC + @see wxMetafile, wxDC */ class wxMetafileDC : public wxDC { @@ -56,6 +55,7 @@ public: }; + /** @class wxMetafile @wxheader{metafile.h} @@ -69,8 +69,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxMetafileDC + @see wxMetafileDC */ class wxMetafile : public wxObject { @@ -113,6 +112,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/mimetype.h b/interface/mimetype.h index 70d72c0fcc..0a9e88592b 100644 --- a/interface/mimetype.h +++ b/interface/mimetype.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: mimetype.h -// Purpose: documentation for wxMimeTypesManager class +// Purpose: interface of wxMimeTypesManager // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -38,8 +38,7 @@ @library{wxbase} @category{misc} - @seealso - wxFileType + @see wxFileType */ class wxMimeTypesManager { @@ -156,6 +155,7 @@ public: }; + /** @class wxFileType @wxheader{mimetype.h} @@ -192,8 +192,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxMimeTypesManager + @see wxMimeTypesManager */ class wxFileType { @@ -294,7 +293,7 @@ public: /** With the first version of this method, if the @true is returned, the string pointed to by @a command is filled with the command which must be - executed (see wxExecute) in order to open the file of the + executed (see wxExecute()) in order to open the file of the given type. In this case, the name of the file as well as any other parameters is retrieved from MessageParameters() class. @@ -310,7 +309,7 @@ public: /** If the function returns @true, the string pointed to by @a command is filled - with the command which must be executed (see wxExecute) in + with the command which must be executed (see wxExecute()) in order to print the file of the given type. The name of the file is retrieved from MessageParameters() class. */ @@ -342,3 +341,4 @@ public: ever derive from MessageParameters class for a Windows-only program. */ }; + diff --git a/interface/minifram.h b/interface/minifram.h index 232c259bb9..10aa4bf3fb 100644 --- a/interface/minifram.h +++ b/interface/minifram.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: minifram.h -// Purpose: documentation for wxMiniFrame class +// Purpose: interface of wxMiniFrame // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -48,8 +48,7 @@ @library{wxcore} @category{managedwnd} - @seealso - wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog + @see wxMDIParentFrame, wxMDIChildFrame, wxFrame, wxDialog */ class wxMiniFrame : public wxFrame { @@ -110,3 +109,4 @@ public: long style = wxCAPTION | wxRESIZE_BORDER, const wxString& name = "frame"); }; + diff --git a/interface/module.h b/interface/module.h index ed39fec075..f3b4402308 100644 --- a/interface/module.h +++ b/interface/module.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: module.h -// Purpose: documentation for wxModule class +// Purpose: interface of wxModule // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -92,13 +92,13 @@ public: //@{ /** Call this function from the constructor of the derived class. @a dep must be - the CLASSINFO of a wxModule-derived class and the + the CLASSINFO() of a wxModule-derived class and the corresponding module will be loaded before and unloaded after this module. The second version of this function allows a dependency to be added by name without access to the class info. This is useful when a module is declared entirely in a source file and there is no header for the declaration - of the module needed by CLASSINFO, however errors are + of the module needed by CLASSINFO(), however errors are not detected until run-time, instead of compile-time, then. Note that circular dependencies are detected and result in a fatal error. @@ -123,3 +123,4 @@ public: */ virtual bool OnInit(); }; + diff --git a/interface/msgdlg.h b/interface/msgdlg.h index c7a88ab7b6..0e434b7a6c 100644 --- a/interface/msgdlg.h +++ b/interface/msgdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: msgdlg.h -// Purpose: documentation for wxMessageDialog class +// Purpose: interface of wxMessageDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,7 @@ @library{wxcore} @category{cmndlg} - @seealso - @ref overview_wxmessagedialogoverview "wxMessageDialog overview" + @see @ref overview_wxmessagedialogoverview "wxMessageDialog overview" */ class wxMessageDialog : public wxDialog { @@ -225,6 +224,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/msgqueue.h b/interface/msgqueue.h index 1a22c706aa..c506eeb576 100644 --- a/interface/msgqueue.h +++ b/interface/msgqueue.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: msgqueue.h -// Purpose: documentation for wxMessageQueue class +// Purpose: interface of wxMessageQueue // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @nolibrary @category{FIXME} - @seealso - wxThread + @see wxThread */ class wxMessageQueue { @@ -68,3 +67,4 @@ public: */ wxMessageQueue(); }; + diff --git a/interface/mstream.h b/interface/mstream.h index c4a6d363c3..37319f10b2 100644 --- a/interface/mstream.h +++ b/interface/mstream.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: mstream.h -// Purpose: documentation for wxMemoryOutputStream class +// Purpose: interface of wxMemoryOutputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -14,8 +14,7 @@ @library{wxbase} @category{streams} - @seealso - wxStreamBuffer + @see wxStreamBuffer */ class wxMemoryOutputStream : public wxOutputStream { @@ -46,6 +45,7 @@ public: }; + /** @class wxMemoryInputStream @wxheader{mstream.h} @@ -54,8 +54,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxStreamBuffer, wxMemoryOutputStream + @see wxStreamBuffer, wxMemoryOutputStream */ class wxMemoryInputStream : public wxInputStream { @@ -85,3 +84,4 @@ public: */ wxStreamBuffer* GetInputStreamBuffer() const; }; + diff --git a/interface/msw/ole/activex.h b/interface/msw/ole/activex.h index c5a6ec65dc..d3a0c9fdef 100644 --- a/interface/msw/ole/activex.h +++ b/interface/msw/ole/activex.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: msw/ole/activex.h -// Purpose: documentation for wxActiveXEvent class +// Purpose: interface of wxActiveXEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -52,6 +52,7 @@ public: }; + /** @class wxActiveXContainer @headerfile ole/activex.h wx/msw/ole/activex.h @@ -73,8 +74,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxActiveXEvent + @see wxActiveXEvent */ class wxActiveXContainer : public wxControl { @@ -91,3 +91,4 @@ public: */ wxActiveXContainer(wxWindow* parent, REFIID iid, IUnknown* pUnk); }; + diff --git a/interface/msw/ole/automtn.h b/interface/msw/ole/automtn.h index 20fefcc838..d753fe9bb0 100644 --- a/interface/msw/ole/automtn.h +++ b/interface/msw/ole/automtn.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: msw/ole/automtn.h -// Purpose: documentation for wxAutomationObject class +// Purpose: interface of wxAutomationObject // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -34,8 +34,7 @@ @library{wxcore} @category{misc} - @seealso - wxVariant + @see wxVariant */ class wxAutomationObject : public wxObject { @@ -193,3 +192,4 @@ public: */ void SetDispatchPtr(WXIDISPATCH* dispatchPtr); }; + diff --git a/interface/msw/registry.h b/interface/msw/registry.h index c9b07218d7..6b2ccdcee6 100644 --- a/interface/msw/registry.h +++ b/interface/msw/registry.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: msw/registry.h -// Purpose: documentation for wxRegKey class +// Purpose: interface of wxRegKey // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -187,3 +187,4 @@ public: const wxMemoryBuffer& buf); //@} }; + diff --git a/interface/notebook.h b/interface/notebook.h index 7c0e03bc6c..e9e5f480c7 100644 --- a/interface/notebook.h +++ b/interface/notebook.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: notebook.h -// Purpose: documentation for wxNotebookEvent class +// Purpose: interface of wxNotebookEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxcore} @category{events} - @seealso - wxNotebook + @see wxNotebook */ class wxNotebookEvent : public wxNotifyEvent { @@ -73,6 +72,7 @@ public: }; + /** @class wxNotebook @wxheader{notebook.h} @@ -111,8 +111,7 @@ public: @library{wxcore} @category{miscwnd} - @seealso - wxBookCtrl, wxNotebookEvent, wxImageList, @ref overview_samplenotebook + @see wxBookCtrl(), wxNotebookEvent, wxImageList, @ref overview_samplenotebook "notebook sample" */ class wxNotebook : public wxBookCtrl overview @@ -422,3 +421,4 @@ public: */ int SetSelection(size_t page); }; + diff --git a/interface/notifmsg.h b/interface/notifmsg.h index 7d6ecd94f6..ecc14510e9 100644 --- a/interface/notifmsg.h +++ b/interface/notifmsg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: notifmsg.h -// Purpose: documentation for wxNotificationMessage class +// Purpose: interface of wxNotificationMessage // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -86,3 +86,4 @@ public: */ bool Show(int timeout = Timeout_Auto); }; + diff --git a/interface/numdlg.h b/interface/numdlg.h index dca6c50834..4729b7a7f1 100644 --- a/interface/numdlg.h +++ b/interface/numdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: numdlg.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license diff --git a/interface/object.h b/interface/object.h index 70371a2ca6..3024b4c8f2 100644 --- a/interface/object.h +++ b/interface/object.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: object.h -// Purpose: documentation for wxObjectRefData class +// Purpose: interface of wxObjectRefData // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxObject, wxObjectDataPtrT, @ref overview_trefcount "Reference counting" + @see wxObject, wxObjectDataPtrT(), @ref overview_trefcount "Reference counting" */ class wxObjectRefData { @@ -60,6 +59,7 @@ public: }; + /** @class wxObject @wxheader{object.h} @@ -83,8 +83,7 @@ public: @library{wxbase} @category{rtti} - @seealso - wxClassInfo, @ref overview_debuggingoverview, wxObjectRefData + @see wxClassInfo, @ref overview_debuggingoverview, wxObjectRefData */ class wxObject { @@ -224,6 +223,7 @@ public: }; + /** @class wxClassInfo @wxheader{object.h} @@ -235,8 +235,7 @@ public: @library{wxbase} @category{rtti} - @seealso - Overview, wxObject + @see Overview(), wxObject */ class wxClassInfo { @@ -301,6 +300,7 @@ public: }; + /** @class wxObjectDataPtrT @wxheader{object.h} @@ -321,8 +321,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxObject, wxObjectRefData, @ref overview_trefcount "Reference counting" + @see wxObject, wxObjectRefData, @ref overview_trefcount "Reference counting" */ class wxObjectDataPtr { @@ -380,6 +379,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -420,7 +420,7 @@ public: Same as @c reinterpret_castT(x) if the compiler supports reinterpret cast or @c (T)x for old compilers. - @see wx_const_cast, wx_static_cast + @see wx_const_cast(), wx_static_cast() */ T wx_reinterpret_cast(); @@ -435,7 +435,7 @@ T wx_reinterpret_cast(); This macro expands into @c const_castclassname *(ptr) if the compiler supports @e const_cast or into an old, C-style cast, otherwise. - @see wx_const_cast, wxDynamicCast, wxStaticCast + @see wx_const_cast(), wxDynamicCast(), wxStaticCast() */ classname* wxConstCast(); @@ -468,7 +468,7 @@ classname* wxConstCast(); tests whether @c this pointer is non-@NULL which is always @true), so this macro should be used to avoid them. - @see wxDynamicCast + @see wxDynamicCast() */ classname* wxDynamicCastThis(); @@ -492,7 +492,7 @@ wxObject* wxCreateDynamicObject(const wxString& className); system and also declare that the objects of this class should be dynamically creatable from run-time type information. Notice that this implies that the class should have a default constructor, if this is not the case consider using - DECLARE_CLASS. + DECLARE_CLASS(). Example: @code @@ -511,11 +511,11 @@ wxObject* wxCreateDynamicObject(const wxString& className); /** Same as @c const_castT(x) if the compiler supports const cast or - @c (T)x for old compilers. Unlike wxConstCast, + @c (T)x for old compilers. Unlike wxConstCast(), the cast it to the type @e T and not to @c T * and also the order of arguments is the same as for the standard cast. - @see wx_reinterpret_cast, wx_static_cast + @see wx_reinterpret_cast(), wx_static_cast() */ T wx_const_cast(); @@ -548,8 +548,8 @@ T wx_const_cast(); } @endcode - @see @ref overview_runtimeclassoverview "RTTI overview", wxDynamicCastThis, - wxConstCast, wxStaticCast + @see @ref overview_runtimeclassoverview "RTTI overview", wxDynamicCastThis(), + wxConstCast(), wxStaticCast() */ classname* wxDynamicCast(); @@ -570,18 +570,18 @@ classname* wxDynamicCast(); result if @c wxDynamicCast(ptr, classname) == @NULL) and then returns the result of executing an equivalent of @c static_castclassname *(ptr). - @see wx_static_cast, wxDynamicCast, wxConstCast + @see wx_static_cast(), wxDynamicCast(), wxConstCast() */ classname* wxStaticCast(); /** Same as @c static_castT(x) if the compiler supports static cast or - @c (T)x for old compilers. Unlike wxStaticCast, + @c (T)x for old compilers. Unlike wxStaticCast(), there are no checks being done and the meaning of the macro arguments is exactly the same as for the standard static cast, i.e. @e T is the full type name and star is not appended to it. - @see wx_const_cast, wx_reinterpret_cast, wx_truncate_cast + @see wx_const_cast(), wx_reinterpret_cast(), wx_truncate_cast() */ T wx_static_cast(); diff --git a/interface/odcombo.h b/interface/odcombo.h index e052631403..1163eb05b9 100644 --- a/interface/odcombo.h +++ b/interface/odcombo.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: odcombo.h -// Purpose: documentation for wxOwnerDrawnComboBox class +// Purpose: interface of wxOwnerDrawnComboBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -41,8 +41,7 @@ @category{ctrl} @appearance{ownerdrawncombobox.png} - @seealso - wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent + @see wxComboCtrl, wxComboBox, wxVListBox, wxCommandEvent */ class wxOwnerDrawnComboBox : public wxComboCtrl { @@ -181,3 +180,4 @@ public: */ wxCoord OnMeasureItemWidth(size_t item) const; }; + diff --git a/interface/palette.h b/interface/palette.h index 06273aeec9..2630124016 100644 --- a/interface/palette.h +++ b/interface/palette.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: palette.h -// Purpose: documentation for wxPalette class +// Purpose: interface of wxPalette // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -27,11 +27,9 @@ @category{gdi} @stdobjects - Objects: - wxNullPalette + ::Objects:, ::wxNullPalette, - @seealso - wxDC::SetPalette, wxBitmap + @see wxDC::SetPalette, wxBitmap */ class wxPalette : public wxGDIObject { @@ -141,3 +139,17 @@ public: */ wxPalette operator =(const wxPalette& palette); }; + + +/** + FIXME +*/ +wxPalette Objects: +; + +/** + FIXME +*/ +wxPalette wxNullPalette; + + diff --git a/interface/panel.h b/interface/panel.h index d7e1f6985f..b6dcc2f644 100644 --- a/interface/panel.h +++ b/interface/panel.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: panel.h -// Purpose: documentation for wxPanel class +// Purpose: interface of wxPanel // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -28,8 +28,7 @@ @library{wxbase} @category{miscwnd} - @seealso - wxDialog + @see wxDialog */ class wxPanel : public wxWindow { @@ -132,3 +131,4 @@ public: */ virtual void SetFocusIgnoringChildren(); }; + diff --git a/interface/pen.h b/interface/pen.h index 56ee53f991..9a9a2833ac 100644 --- a/interface/pen.h +++ b/interface/pen.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: pen.h -// Purpose: documentation for wxPen class +// Purpose: interface of wxPen // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,31 +18,10 @@ @category{gdi} @stdobjects - Objects: - wxNullPen - Pointers: - wxRED_PEN + ::Objects:, ::wxNullPen, ::Pointers:, ::wxRED_PEN, ::wxCYAN_PEN, ::wxGREEN_PEN, + ::wxBLACK_PEN, ::wxWHITE_PEN, ::wxTRANSPARENT_PEN, ::wxBLACK_DASHED_PEN, ::wxGREY_PEN, ::wxMEDIUM_GREY_PEN, ::wxLIGHT_GREY_PEN, - wxCYAN_PEN - - wxGREEN_PEN - - wxBLACK_PEN - - wxWHITE_PEN - - wxTRANSPARENT_PEN - - wxBLACK_DASHED_PEN - - wxGREY_PEN - - wxMEDIUM_GREY_PEN - - wxLIGHT_GREY_PEN - - @seealso - wxPenList, wxDC, wxDC::SetPen + @see wxPenList, wxDC, wxDC::SetPen */ class wxPen : public wxGDIObject { @@ -390,3 +369,73 @@ public: */ bool operator ==(const wxPen& pen); }; + + +/** + FIXME +*/ +wxPen Objects: +; + +/** + FIXME +*/ +wxPen wxNullPen; + +/** + FIXME +*/ +wxPen Pointers: +; + +/** + FIXME +*/ +wxPen wxRED_PEN; + +/** + FIXME +*/ +wxPen wxCYAN_PEN; + +/** + FIXME +*/ +wxPen wxGREEN_PEN; + +/** + FIXME +*/ +wxPen wxBLACK_PEN; + +/** + FIXME +*/ +wxPen wxWHITE_PEN; + +/** + FIXME +*/ +wxPen wxTRANSPARENT_PEN; + +/** + FIXME +*/ +wxPen wxBLACK_DASHED_PEN; + +/** + FIXME +*/ +wxPen wxGREY_PEN; + +/** + FIXME +*/ +wxPen wxMEDIUM_GREY_PEN; + +/** + FIXME +*/ +wxPen wxLIGHT_GREY_PEN; + + diff --git a/interface/pickerbase.h b/interface/pickerbase.h index a68e1b7612..94792952fc 100644 --- a/interface/pickerbase.h +++ b/interface/pickerbase.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: pickerbase.h -// Purpose: documentation for wxPickerBase class +// Purpose: interface of wxPickerBase // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -28,8 +28,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxColourPickerCtrl + @see wxColourPickerCtrl */ class wxPickerBase : public wxControl { @@ -107,3 +106,4 @@ public: */ void SetTextCtrlProportion(int prop); }; + diff --git a/interface/platform.h b/interface/platform.h index 8033275713..651e779d55 100644 --- a/interface/platform.h +++ b/interface/platform.h @@ -1,13 +1,13 @@ ///////////////////////////////////////////////////////////////////////////// // Name: platform.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license ///////////////////////////////////////////////////////////////////////////// /** -Same as wxCHECK_VERSION but also checks that +Same as wxCHECK_VERSION() but also checks that @c wxSUBRELEASE_NUMBER is at least @e subrel. */ #define bool wxCHECK_VERSION_FULL(major, minor, release, subrel) /* implementation is private */ diff --git a/interface/platinfo.h b/interface/platinfo.h index 4c1388f899..89c07a0291 100644 --- a/interface/platinfo.h +++ b/interface/platinfo.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: platinfo.h -// Purpose: documentation for wxPlatformInfo class +// Purpose: interface of wxPlatformInfo // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,8 @@ @library{wxbase} @category{FIXME} - @seealso - wxGetOSVersion, wxIsPlatformLittleEndian, wxIsPlatform64Bit, wxAppTraits + @see wxGetOSVersion(), wxIsPlatformLittleEndian(), wxIsPlatform64Bit(), + wxAppTraits */ class wxPlatformInfo : public wxObject { @@ -100,7 +100,7 @@ public: /** Returns the run-time major version of the OS associated with this wxPlatformInfo instance. - See wxGetOsVersion for more info. + See wxGetOsVersion() for more info. @see CheckOSVersion() */ @@ -109,7 +109,7 @@ public: /** Returns the run-time minor version of the OS associated with this wxPlatformInfo instance. - See wxGetOsVersion for more info. + See wxGetOsVersion() for more info. @see CheckOSVersion() */ @@ -241,3 +241,4 @@ public: */ bool operator==(const wxPlatformInfo& t) const; }; + diff --git a/interface/position.h b/interface/position.h index 2813de6c23..52662c53d5 100644 --- a/interface/position.h +++ b/interface/position.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: position.h -// Purpose: documentation for wxPosition class +// Purpose: interface of wxPosition // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxPoint, wxSize + @see wxPoint, wxSize */ class wxPosition { @@ -78,3 +77,4 @@ public: */ void SetRow(int row); }; + diff --git a/interface/power.h b/interface/power.h index 87a4ae1e0a..8cf91500ff 100644 --- a/interface/power.h +++ b/interface/power.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: power.h -// Purpose: documentation for wxPowerEvent class +// Purpose: interface of wxPowerEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxGetPowerType, wxGetBatteryState + @see wxGetPowerType(), wxGetBatteryState() */ class wxPowerEvent : public wxEvent { @@ -36,3 +35,4 @@ public: */ void Veto(); }; + diff --git a/interface/print.h b/interface/print.h index 5ad64366d1..bcc5110241 100644 --- a/interface/print.h +++ b/interface/print.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: print.h -// Purpose: documentation for wxPreviewControlBar class +// Purpose: interface of wxPreviewControlBar // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxbase} @category{printing} - @seealso - wxPreviewFrame, wxPreviewCanvas, wxPrintPreview + @see wxPreviewFrame, wxPreviewCanvas, wxPrintPreview */ class wxPreviewControlBar : public wxPanel { @@ -84,6 +83,7 @@ public: }; + /** @class wxPreviewCanvas @wxheader{print.h} @@ -94,8 +94,7 @@ public: @library{wxbase} @category{printing} - @seealso - wxPreviewFrame, wxPreviewControlBar, wxPrintPreview + @see wxPreviewFrame, wxPreviewControlBar, wxPrintPreview */ class wxPreviewCanvas : public wxScrolledWindow { @@ -121,6 +120,7 @@ public: }; + /** @class wxPreviewFrame @wxheader{print.h} @@ -132,8 +132,7 @@ public: @library{wxbase} @category{printing} - @seealso - wxPreviewCanvas, wxPreviewControlBar, wxPrintPreview + @see wxPreviewCanvas, wxPreviewControlBar, wxPrintPreview */ class wxPreviewFrame : public wxFrame { @@ -184,6 +183,7 @@ public: }; + /** @class wxPrintPreview @wxheader{print.h} @@ -198,8 +198,7 @@ public: @library{wxbase} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", wxPrinterDC, + @see @ref overview_printingoverview "Printing framework overview", wxPrinterDC, wxPrintDialog, wxPrintout, wxPrinter, wxPreviewCanvas, wxPreviewControlBar, wxPreviewFrame. */ class wxPrintPreview : public wxObject @@ -331,6 +330,7 @@ public: }; + /** @class wxPrinter @wxheader{print.h} @@ -345,8 +345,7 @@ public: @library{wxbase} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", wxPrinterDC, + @see @ref overview_printingoverview "Printing framework overview", wxPrinterDC, wxPrintDialog, wxPrintout, wxPrintPreview. */ class wxPrinter : public wxObject @@ -435,6 +434,7 @@ public: }; + /** @class wxPrintout @wxheader{print.h} @@ -464,8 +464,7 @@ public: @library{wxbase} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", wxPrinterDC, + @see @ref overview_printingoverview "Printing framework overview", wxPrinterDC, wxPrintDialog, wxPageSetupDialog, wxPrinter, wxPrintPreview */ class wxPrintout : public wxObject @@ -729,3 +728,4 @@ public: */ void SetLogicalOrigin(wxCoord x, wxCoord y); }; + diff --git a/interface/printdlg.h b/interface/printdlg.h index 5560dec200..df3df450c9 100644 --- a/interface/printdlg.h +++ b/interface/printdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: printdlg.h -// Purpose: documentation for wxPrintDialog class +// Purpose: interface of wxPrintDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,7 @@ @library{wxcore} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", @ref + @see @ref overview_printingoverview "Printing framework overview", @ref overview_wxprintdialogoverview "wxPrintDialog Overview" */ class wxPrintDialog : public wxDialog @@ -61,6 +60,7 @@ public: }; + /** @class wxPageSetupDialog @wxheader{printdlg.h} @@ -90,9 +90,8 @@ public: @library{wxcore} @category{printing} - @seealso - @ref overview_printingoverview "Printing framework overview", wxPrintDialog, - wxPageSetupDialogData + @see @ref overview_printingoverview "Printing framework overview", + wxPrintDialog, wxPageSetupDialogData */ class wxPageSetupDialog : public wxDialog { @@ -122,3 +121,4 @@ public: */ int ShowModal(); }; + diff --git a/interface/process.h b/interface/process.h index 5487817c8d..13b22ec0f1 100644 --- a/interface/process.h +++ b/interface/process.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: process.h -// Purpose: documentation for wxProcess class +// Purpose: interface of wxProcess // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -11,7 +11,7 @@ @wxheader{process.h} The objects of this class are used in conjunction with the - wxExecute function. When a wxProcess object is passed to + wxExecute() function. When a wxProcess object is passed to wxExecute(), its wxProcess::OnTerminate virtual method is called when the process terminates. This allows the program to be (asynchronously) notified about the process termination and also retrieve its @@ -26,7 +26,7 @@ wxProcess also supports IO redirection of the child process. For this, you have to call its wxProcess::Redirect method before passing it to - wxExecute. If the child process was launched successfully, + wxExecute(). If the child process was launched successfully, wxProcess::GetInputStream, wxProcess::GetOutputStream and wxProcess::GetErrorStream can then be used to retrieve @@ -39,8 +39,7 @@ @library{wxbase} @category{appmanagement} - @seealso - wxExecute, @ref overview_sampleexec "exec sample" + @see wxExecute(), @ref overview_sampleexec "exec sample" */ class wxProcess : public wxEvtHandler { @@ -164,7 +163,7 @@ public: to work you should have created the process passing wxEXEC_MAKE_GROUP_LEADER. Returns the element of @c wxKillError enum: - @see Exists(), wxKill, @ref overview_sampleexec "Exec sample" + @see Exists(), wxKill(), @ref overview_sampleexec "Exec sample" */ static wxKillError Kill(int pid, wxSignal signal = wxSIGNONE, int flags = wxKILL_NOCHILDREN); @@ -201,7 +200,7 @@ public: @returns A pointer to new wxProcess object or @NULL on error. - @see wxExecute + @see wxExecute() */ static wxProcess* Open(const wxString& cmd, int flags = wxEXEC_ASYNC); @@ -216,6 +215,7 @@ public: }; + /** @class wxProcessEvent @wxheader{process.h} @@ -225,8 +225,7 @@ public: @library{wxbase} @category{events} - @seealso - wxProcess, @ref overview_eventhandlingoverview + @see wxProcess, @ref overview_eventhandlingoverview */ class wxProcessEvent : public wxEvent { @@ -247,3 +246,4 @@ public: */ int GetPid() const; }; + diff --git a/interface/progdlg.h b/interface/progdlg.h index 6fd996201e..5ac4ef8ab1 100644 --- a/interface/progdlg.h +++ b/interface/progdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: progdlg.h -// Purpose: documentation for wxProgressDialog class +// Purpose: interface of wxProgressDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -113,3 +113,4 @@ public: virtual bool Update(int value, const wxString& newmsg = "", bool* skip = NULL); }; + diff --git a/interface/propdlg.h b/interface/propdlg.h index 93cc064a3f..ff00333f92 100644 --- a/interface/propdlg.h +++ b/interface/propdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: propdlg.h -// Purpose: documentation for wxPropertySheetDialog class +// Purpose: interface of wxPropertySheetDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -179,3 +179,4 @@ public: */ void SetSheetStyle(long style); }; + diff --git a/interface/protocol/ftp.h b/interface/protocol/ftp.h index 46c531dc76..8688cd6903 100644 --- a/interface/protocol/ftp.h +++ b/interface/protocol/ftp.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: protocol/ftp.h -// Purpose: documentation for wxFTP class +// Purpose: interface of wxFTP // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -75,8 +75,7 @@ @library{wxnet} @category{net} - @seealso - wxSocketBase + @see wxSocketBase */ class wxFTP : public wxProtocol { @@ -249,3 +248,4 @@ public: */ void SetUser(const wxString& user); }; + diff --git a/interface/protocol/http.h b/interface/protocol/http.h index ecbba75b79..9ea510b233 100644 --- a/interface/protocol/http.h +++ b/interface/protocol/http.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: protocol/http.h -// Purpose: documentation for wxHTTP class +// Purpose: interface of wxHTTP // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -14,8 +14,7 @@ @library{wxnet} @category{net} - @seealso - wxSocketBase, wxURL + @see wxSocketBase, wxURL */ class wxHTTP : public wxProtocol { @@ -63,3 +62,4 @@ public: */ void SetHeader(const wxString& header, const wxString& h_data); }; + diff --git a/interface/protocol/protocol.h b/interface/protocol/protocol.h index aaab5c0df1..43e6d9842a 100644 --- a/interface/protocol/protocol.h +++ b/interface/protocol/protocol.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: protocol/protocol.h -// Purpose: documentation for wxProtocol class +// Purpose: interface of wxProtocol // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -14,8 +14,7 @@ @library{wxnet} @category{FIXME} - @seealso - wxSocketBase, wxURL + @see wxSocketBase, wxURL */ class wxProtocol : public wxSocketClient { @@ -110,3 +109,4 @@ public: */ void SetUser(const wxString& user); }; + diff --git a/interface/ptr_scpd.h b/interface/ptr_scpd.h index cdb46b6074..830ede02a3 100644 --- a/interface/ptr_scpd.h +++ b/interface/ptr_scpd.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: ptr_scpd.h -// Purpose: documentation for wxScopedPtr class +// Purpose: interface of wxScopedPtr // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,7 +15,7 @@ use macros instead. Since wxWidgets 2.9.0 there is also a templated version of this class - with the same name. See wxScopedPtrT. + with the same name. See wxScopedPtrT(). A smart pointer holds a pointer to an object. The memory used by the object is deleted when the smart pointer goes out of scope. This class is different from @@ -26,8 +26,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxScopedArray + @see wxScopedArray */ class wxScopedPtr { @@ -84,6 +83,7 @@ public: }; + /** @class wxScopedArray @wxheader{ptr_scpd.h} @@ -95,8 +95,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxScopedPtr + @see wxScopedPtr */ class wxScopedArray { @@ -134,6 +133,7 @@ public: }; + /** @class wxScopedTiedPtr @wxheader{ptr_scpd.h} @@ -171,6 +171,7 @@ public: }; + /** @class wxScopedPtrT @wxheader{ptr_scpd.h} @@ -181,8 +182,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxSharedPtr, wxWeakRef + @see wxSharedPtr, wxWeakRef */ class wxScopedPtr { @@ -240,3 +240,4 @@ public: */ void swap(wxScopedPtr& ot); }; + diff --git a/interface/ptr_shrd.h b/interface/ptr_shrd.h index 52ad2b2c93..3554d09fff 100644 --- a/interface/ptr_shrd.h +++ b/interface/ptr_shrd.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: ptr_shrd.h -// Purpose: documentation for wxSharedPtr class +// Purpose: interface of wxSharedPtr // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -12,14 +12,13 @@ A smart pointer with non-intrusive reference counting. It is modeled after @b boost::shared_ptr and can be used with STL containers - and wxVector - unlike @b std::auto_ptr - and wxScopedPtr. + and wxVector() - unlike @b std::auto_ptr + and wxScopedPtr(). @library{wxbase} @category{FIXME} - @seealso - wxScopedPtr, wxWeakRef, wxObjectDataPtr + @see wxScopedPtr, wxWeakRef, wxObjectDataPtr */ class wxSharedPtr { @@ -83,3 +82,4 @@ public: */ long use_count() const; }; + diff --git a/interface/quantize.h b/interface/quantize.h index afa4b21c1c..4ba79d58a7 100644 --- a/interface/quantize.h +++ b/interface/quantize.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: quantize.h -// Purpose: documentation for wxQuantize class +// Purpose: interface of wxQuantize // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -55,3 +55,4 @@ public: int flags = wxQUANTIZE_INCLUDE_WINDOWS_COLOURS|wxQUANTIZE_FILL_DESTINATION_IMAGE|wxQUANTIZE_RETURN_8BIT_DATA); //@} }; + diff --git a/interface/radiobox.h b/interface/radiobox.h index e8241a9a48..d43fbbbbee 100644 --- a/interface/radiobox.h +++ b/interface/radiobox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: radiobox.h -// Purpose: documentation for wxRadioBox class +// Purpose: interface of wxRadioBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -35,8 +35,7 @@ @category{ctrl} @appearance{radiobox.png} - @seealso - @ref overview_eventhandlingoverview, wxRadioButton, wxCheckBox + @see @ref overview_eventhandlingoverview, wxRadioButton, wxCheckBox */ class wxRadioBox : public wxControlWithItems { @@ -297,3 +296,4 @@ public: */ void SetStringSelection(const wxString& string); }; + diff --git a/interface/radiobut.h b/interface/radiobut.h index 367aa692f9..fb80e686f1 100644 --- a/interface/radiobut.h +++ b/interface/radiobut.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: radiobut.h -// Purpose: documentation for wxRadioButton class +// Purpose: interface of wxRadioButton // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -41,8 +41,7 @@ @category{ctrl} @appearance{radiobutton.png} - @seealso - @ref overview_eventhandlingoverview, wxRadioBox, wxCheckBox + @see @ref overview_eventhandlingoverview, wxRadioBox, wxCheckBox */ class wxRadioButton : public wxControl { @@ -113,3 +112,4 @@ public: */ void SetValue(const bool value); }; + diff --git a/interface/recguard.h b/interface/recguard.h index 333940c61d..1aae24aa39 100644 --- a/interface/recguard.h +++ b/interface/recguard.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: recguard.h -// Purpose: documentation for wxRecursionGuardFlag class +// Purpose: interface of wxRecursionGuardFlag // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -27,6 +27,7 @@ public: }; + /** @class wxRecursionGuard @wxheader{recguard.h} @@ -93,3 +94,4 @@ public: */ bool IsInside() const; }; + diff --git a/interface/regex.h b/interface/regex.h index ed0eb41abc..419a1107f1 100644 --- a/interface/regex.h +++ b/interface/regex.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: regex.h -// Purpose: documentation for wxRegEx class +// Purpose: interface of wxRegEx // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,7 +21,7 @@ Regular expressions, as defined by POSIX, come in two flavours: @e extended and @e basic. The builtin library also adds a third flavour - of expression advanced, which is not available + of expression advanced(), which is not available when using the system library. Unicode is fully supported only when using the builtin library. @@ -37,8 +37,7 @@ @library{wxbase} @category{data} - @seealso - wxRegEx::ReplaceFirst + @see wxRegEx::ReplaceFirst */ class wxRegEx { @@ -140,3 +139,4 @@ public: */ int ReplaceFirst(wxString* text, const wxString& replacement) const; }; + diff --git a/interface/region.h b/interface/region.h index 834ddb3c6a..89059cb114 100644 --- a/interface/region.h +++ b/interface/region.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: region.h -// Purpose: documentation for wxRegionIterator class +// Purpose: interface of wxRegionIterator // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -22,8 +22,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxPaintEvent + @see wxPaintEvent */ class wxRegionIterator : public wxObject { @@ -97,6 +96,7 @@ public: }; + /** @class wxRegion @wxheader{region.h} @@ -113,8 +113,7 @@ public: @library{wxcore} @category{data} - @seealso - wxRegionIterator + @see wxRegionIterator */ class wxRegion : public wxGDIObject { @@ -274,3 +273,4 @@ public: */ void operator =(const wxRegion& region); }; + diff --git a/interface/renderer.h b/interface/renderer.h index 22277bf446..d57cc69a8a 100644 --- a/interface/renderer.h +++ b/interface/renderer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: renderer.h -// Purpose: documentation for wxSplitterRenderParams class +// Purpose: interface of wxSplitterRenderParams // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -42,6 +42,7 @@ public: }; + /** @class wxDelegateRendererNative @wxheader{renderer.h} @@ -96,6 +97,7 @@ public: }; + /** @class wxRendererNative @wxheader{renderer.h} @@ -321,6 +323,7 @@ public: }; + /** @class wxRendererVersion @wxheader{renderer.h} @@ -336,7 +339,7 @@ public: each time a new virtual method is added and so, at least for the compilers using a common C++ object model, the calling program is compatible with any renderer which has the age greater or equal to its age. This verification is - done by IsCompatible method. + done by IsCompatible() method. @library{wxbase} @category{FIXME} @@ -364,3 +367,4 @@ public: The version component. */ }; + diff --git a/interface/richtext/richtextbuffer.h b/interface/richtext/richtextbuffer.h index 0d063d6300..31b30625c5 100644 --- a/interface/richtext/richtextbuffer.h +++ b/interface/richtext/richtextbuffer.h @@ -15,8 +15,7 @@ @library{wxrichtext} @category{richtext} - @seealso - wxTextAttr, wxRichTextCtrl + @see wxTextAttr, wxRichTextCtrl */ class wxRichTextBuffer { @@ -771,6 +770,7 @@ public: }; + /** @class wxRichTextFileHandler @headerfile richtextbuffer.h wx/richtext/richtextbuffer.h @@ -911,6 +911,7 @@ public: }; + /** @class wxRichTextRange @headerfile richtextbuffer.h wx/richtext/richtextbuffer.h @@ -1031,3 +1032,4 @@ public: */ bool operator==(const wxRichTextRange& range) const; }; + diff --git a/interface/richtext/richtextctrl.h b/interface/richtext/richtextctrl.h index 9d00ebf1fe..c5c7004ec7 100644 --- a/interface/richtext/richtextctrl.h +++ b/interface/richtext/richtextctrl.h @@ -102,6 +102,7 @@ public: }; + /** @class wxRichTextCtrl @headerfile richtextctrl.h wx/richtext/richtextctrl.h @@ -1403,3 +1404,4 @@ public: */ long XYToPosition(long x, long y) const; }; + diff --git a/interface/richtext/richtextformatdlg.h b/interface/richtext/richtextformatdlg.h index 2943d95271..c5d00abc7a 100644 --- a/interface/richtext/richtextformatdlg.h +++ b/interface/richtext/richtextformatdlg.h @@ -81,6 +81,7 @@ public: }; + /** @class wxRichTextFormattingDialog @headerfile richtextformatdlg.h wx/richtext/richtextformatdlg.h @@ -249,3 +250,4 @@ public: */ bool UpdateDisplay(); }; + diff --git a/interface/richtext/richtexthtml.h b/interface/richtext/richtexthtml.h index 40dc37ba52..99e51abe0f 100644 --- a/interface/richtext/richtexthtml.h +++ b/interface/richtext/richtexthtml.h @@ -108,3 +108,4 @@ public: */ void SetTemporaryImageLocations(const wxArrayString& locations); }; + diff --git a/interface/richtext/richtextprint.h b/interface/richtext/richtextprint.h index 769d5651f7..2c70bdbf5d 100644 --- a/interface/richtext/richtextprint.h +++ b/interface/richtext/richtextprint.h @@ -156,6 +156,7 @@ public: }; + /** @class wxRichTextPrintout @headerfile richtextprint.h wx/richtext/richtextprint.h @@ -234,6 +235,7 @@ public: }; + /** @class wxRichTextPrinting @headerfile richtextprint.h wx/richtext/richtextprint.h @@ -392,3 +394,4 @@ public: */ void SetTitle(const wxString& title); }; + diff --git a/interface/richtext/richtextstyledlg.h b/interface/richtext/richtextstyledlg.h index ca124cffd0..38ad39121d 100644 --- a/interface/richtext/richtextstyledlg.h +++ b/interface/richtext/richtextstyledlg.h @@ -174,3 +174,4 @@ public: */ int GetFlags() const; }; + diff --git a/interface/richtext/richtextstyles.h b/interface/richtext/richtextstyles.h index 99a5b1273c..6bffbb61e6 100644 --- a/interface/richtext/richtextstyles.h +++ b/interface/richtext/richtextstyles.h @@ -105,6 +105,7 @@ public: }; + /** @class wxRichTextStyleDefinition @headerfile richtextstyles.h wx/richtext/richtextstyles.h @@ -178,6 +179,7 @@ public: }; + /** @class wxRichTextParagraphStyleDefinition @headerfile richtextstyles.h wx/richtext/richtextstyles.h @@ -213,6 +215,7 @@ public: }; + /** @class wxRichTextStyleListBox @headerfile richtextstyles.h wx/richtext/richtextstyles.h @@ -225,9 +228,8 @@ public: @library{wxrichtext} @category{richtext} - @seealso - wxRichTextStyleComboCtrl, @ref overview_wxrichtextctrloverview "wxRichTextCtrl - overview" + @see wxRichTextStyleComboCtrl, @ref overview_wxrichtextctrloverview + "wxRichTextCtrl overview" */ class wxRichTextStyleListBox : public wxHtmlListBox { @@ -336,6 +338,7 @@ public: }; + /** @class wxRichTextStyleComboCtrl @headerfile richtextstyles.h wx/richtext/richtextstyles.h @@ -348,9 +351,8 @@ public: @library{wxrichtext} @category{richtext} - @seealso - wxRichTextStyleListBox, @ref overview_wxrichtextctrloverview "wxRichTextCtrl - overview" + @see wxRichTextStyleListBox, @ref overview_wxrichtextctrloverview + "wxRichTextCtrl overview" */ class wxRichTextStyleComboCtrl : public wxComboCtrl { @@ -396,6 +398,7 @@ public: }; + /** @class wxRichTextCharacterStyleDefinition @headerfile richtextstyles.h wx/richtext/richtextstyles.h @@ -421,6 +424,7 @@ public: }; + /** @class wxRichTextListStyleDefinition @headerfile richtextstyles.h wx/richtext/richtextstyles.h @@ -523,6 +527,7 @@ public: }; + /** @class wxRichTextStyleSheet @headerfile richtextstyles.h wx/richtext/richtextstyles.h @@ -669,3 +674,4 @@ public: */ void SetName(const wxString& name); }; + diff --git a/interface/richtext/richtextsymboldlg.h b/interface/richtext/richtextsymboldlg.h index 7ac9f77adf..f862372780 100644 --- a/interface/richtext/richtextsymboldlg.h +++ b/interface/richtext/richtextsymboldlg.h @@ -187,3 +187,4 @@ public: */ bool UseNormalFont() const; }; + diff --git a/interface/richtext/richtextxml.h b/interface/richtext/richtextxml.h index 9032d0fa21..f469e5401a 100644 --- a/interface/richtext/richtextxml.h +++ b/interface/richtext/richtextxml.h @@ -99,3 +99,4 @@ public: */ bool ImportXML(wxRichTextBuffer* buffer, wxXmlNode* node); }; + diff --git a/interface/sashwin.h b/interface/sashwin.h index bae169d61e..668efc79e6 100644 --- a/interface/sashwin.h +++ b/interface/sashwin.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: sashwin.h -// Purpose: documentation for wxSashWindow class +// Purpose: interface of wxSashWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -41,8 +41,7 @@ @library{wxadv} @category{miscwnd} - @seealso - wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview + @see wxSashEvent, wxSashLayoutWindow, @ref overview_eventhandlingoverview */ class wxSashWindow : public wxWindow { @@ -169,6 +168,7 @@ public: }; + /** @class wxSashEvent @wxheader{sashwin.h} @@ -179,8 +179,7 @@ public: @library{wxadv} @category{FIXME} - @seealso - wxSashWindow, @ref overview_eventhandlingoverview + @see wxSashWindow, @ref overview_eventhandlingoverview */ class wxSashEvent : public wxCommandEvent { @@ -211,3 +210,4 @@ public: */ wxSashEdgePosition GetEdge() const; }; + diff --git a/interface/sckipc.h b/interface/sckipc.h index ffb819cc57..4a3db2f305 100644 --- a/interface/sckipc.h +++ b/interface/sckipc.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: sckipc.h -// Purpose: documentation for wxTCPServer class +// Purpose: interface of wxTCPServer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -19,8 +19,7 @@ @library{wxnet} @category{FIXME} - @seealso - wxTCPClient, wxTCPConnection, @ref overview_ipcoverview "IPC overview" + @see wxTCPClient, wxTCPConnection, @ref overview_ipcoverview "IPC overview" */ class wxTCPServer : public wxObject { @@ -51,6 +50,7 @@ public: }; + /** @class wxTCPClient @wxheader{sckipc.h} @@ -71,8 +71,7 @@ public: @library{wxnet} @category{FIXME} - @seealso - wxTCPServer, wxTCPConnection, @ref overview_ipcoverview "Interprocess + @see wxTCPServer, wxTCPConnection, @ref overview_ipcoverview "Interprocess communications overview" */ class wxTCPClient : public wxObject @@ -115,6 +114,7 @@ public: }; + /** @class wxTCPConnection @wxheader{sckipc.h} @@ -138,8 +138,7 @@ public: @library{wxnet} @category{FIXME} - @seealso - wxTCPClient, wxTCPServer, @ref overview_ipcoverview "Interprocess + @see wxTCPClient, wxTCPServer, @ref overview_ipcoverview "Interprocess communications overview" */ class wxTCPConnection : public wxObject @@ -304,3 +303,4 @@ public: */ bool StopAdvise(const wxString& item); }; + diff --git a/interface/sckstrm.h b/interface/sckstrm.h index 02795708fe..a29d0ef6f8 100644 --- a/interface/sckstrm.h +++ b/interface/sckstrm.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: sckstrm.h -// Purpose: documentation for wxSocketOutputStream class +// Purpose: interface of wxSocketOutputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,7 @@ @library{wxnet} @category{streams} - @seealso - wxSocketBase + @see wxSocketBase */ class wxSocketOutputStream : public wxOutputStream { @@ -31,6 +30,7 @@ public: }; + /** @class wxSocketInputStream @wxheader{sckstrm.h} @@ -42,8 +42,7 @@ public: @library{wxnet} @category{streams} - @seealso - wxSocketBase + @see wxSocketBase */ class wxSocketInputStream : public wxInputStream { @@ -54,3 +53,4 @@ public: */ wxSocketInputStream(wxSocketBase& s); }; + diff --git a/interface/scopeguard.h b/interface/scopeguard.h index 345c171447..0a68edd65b 100644 --- a/interface/scopeguard.h +++ b/interface/scopeguard.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: scopeguard.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -8,7 +8,7 @@ //@{ /** - This family of macros is similar to wxON_BLOCK_EXIT + This family of macros is similar to wxON_BLOCK_EXIT() but calls a method of the given object instead of a free function. */ wxON_BLOCK_EXIT_OBJ0(obj, method); @@ -33,7 +33,7 @@ wxON_BLOCK_EXIT_OBJ2(obj, method, p1, p2); published in December 2000 issue of C/C++ Users Journal for more details. - @see wxON_BLOCK_EXIT_OBJ + @see wxON_BLOCK_EXIT_OBJ() */ wxON_BLOCK_EXIT0(func); wxON_BLOCK_EXIT1(func, p1); diff --git a/interface/scrolbar.h b/interface/scrolbar.h index 4ea95c9ad3..1bca4db859 100644 --- a/interface/scrolbar.h +++ b/interface/scrolbar.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: scrolbar.h -// Purpose: documentation for wxScrollBar class +// Purpose: interface of wxScrollBar // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -26,8 +26,7 @@ @category{ctrl} @appearance{scrollbar.png} - @seealso - @ref overview_scrollingoverview "Scrolling overview", @ref + @see @ref overview_scrollingoverview "Scrolling overview", @ref overview_eventhandlingoverview, wxScrolledWindow */ class wxScrollBar : public wxControl @@ -146,3 +145,4 @@ public: */ void SetThumbPosition(int viewStart); }; + diff --git a/interface/scrolwin.h b/interface/scrolwin.h index 5806b95c52..0f32474945 100644 --- a/interface/scrolwin.h +++ b/interface/scrolwin.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: scrolwin.h -// Purpose: documentation for wxScrolledWindow class +// Purpose: interface of wxScrolledWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -96,8 +96,7 @@ @library{wxcore} @category{miscwnd} - @seealso - wxScrollBar, wxClientDC, wxPaintDC, wxVScrolledWindow + @see wxScrollBar, wxClientDC, wxPaintDC, wxVScrolledWindow */ class wxScrolledWindow : public wxPanel { @@ -347,3 +346,4 @@ public: */ void SetTargetWindow(wxWindow* window); }; + diff --git a/interface/settings.h b/interface/settings.h index 2ccb88d62d..dcfb92374a 100644 --- a/interface/settings.h +++ b/interface/settings.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: settings.h -// Purpose: documentation for wxSystemSettings class +// Purpose: interface of wxSystemSettings // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,7 @@ @library{wxcore} @category{misc} - @seealso - wxFont, wxColour + @see wxFont, wxColour */ class wxSystemSettings : public wxObject { @@ -404,3 +403,4 @@ public: */ static wxSystemScreenType GetScreenType(); }; + diff --git a/interface/sizer.h b/interface/sizer.h index eb59f52bef..e5b7c9777e 100644 --- a/interface/sizer.h +++ b/interface/sizer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: sizer.h -// Purpose: documentation for wxStdDialogButtonSizer class +// Purpose: interface of wxStdDialogButtonSizer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -36,8 +36,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxSizer, @ref overview_sizeroverview "Sizer overview", + @see wxSizer, @ref overview_sizeroverview "Sizer overview", wxDialog::CreateButtonSizer */ class wxStdDialogButtonSizer : public wxBoxSizer @@ -89,6 +88,7 @@ public: }; + /** @class wxSizerItem @wxheader{sizer.h} @@ -297,6 +297,7 @@ public: }; + /** @class wxSizerFlags @wxheader{sizer.h} @@ -335,8 +336,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxSizer + @see wxSizer */ class wxSizerFlags { @@ -453,6 +453,7 @@ public: }; + /** @class wxNotebookSizer @wxheader{sizer.h} @@ -473,8 +474,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxSizer, wxNotebook, @ref overview_sizeroverview "Sizer overview" + @see wxSizer, wxNotebook, @ref overview_sizeroverview "Sizer overview" */ class wxNotebookSizer : public wxSizer { @@ -491,6 +491,7 @@ public: }; + /** @class wxFlexGridSizer @wxheader{sizer.h} @@ -513,8 +514,7 @@ public: @library{wxcore} @category{winlayout} - @seealso - wxSizer, @ref overview_sizeroverview "Sizer overview" + @see wxSizer, @ref overview_sizeroverview "Sizer overview" */ class wxFlexGridSizer : public wxGridSizer { @@ -535,7 +535,7 @@ public: Specifies that column @a idx (starting from zero) should be grown if there is extra space available to the sizer. The @a proportion parameter has the same meaning as the stretch factor for - the sizers except that if all proportions are 0, + the sizers() except that if all proportions are 0, then all columns are resized equally (instead of not being resized at all). */ void AddGrowableCol(size_t idx, int proportion = 0); @@ -602,6 +602,7 @@ public: }; + /** @class wxSizer @wxheader{sizer.h} @@ -666,8 +667,7 @@ public: @library{wxcore} @category{winlayout} - @seealso - @ref overview_sizeroverview "Sizer overview" + @see @ref overview_sizeroverview "Sizer overview" */ class wxSizer : public wxObject { @@ -1238,6 +1238,7 @@ public: }; + /** @class wxGridSizer @wxheader{sizer.h} @@ -1250,8 +1251,7 @@ public: @library{wxcore} @category{winlayout} - @seealso - wxSizer, @ref overview_sizeroverview "Sizer overview" + @see wxSizer, @ref overview_sizeroverview "Sizer overview" */ class wxGridSizer : public wxSizer { @@ -1310,6 +1310,7 @@ public: }; + /** @class wxStaticBoxSizer @wxheader{sizer.h} @@ -1323,8 +1324,8 @@ public: @library{wxcore} @category{winlayout} - @seealso - wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizeroverview "Sizer overview" + @see wxSizer, wxStaticBox, wxBoxSizer, @ref overview_sizeroverview "Sizer + overview" */ class wxStaticBoxSizer : public wxBoxSizer { @@ -1348,6 +1349,7 @@ public: }; + /** @class wxBoxSizer @wxheader{sizer.h} @@ -1363,8 +1365,7 @@ public: @library{wxcore} @category{winlayout} - @seealso - wxSizer, @ref overview_sizeroverview "Sizer overview" + @see wxSizer, @ref overview_sizeroverview "Sizer overview" */ class wxBoxSizer : public wxSizer { @@ -1395,3 +1396,4 @@ public: */ void RecalcSizes(); }; + diff --git a/interface/slider.h b/interface/slider.h index 1f9e7c66c8..c85d98be3d 100644 --- a/interface/slider.h +++ b/interface/slider.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: slider.h -// Purpose: documentation for wxSlider class +// Purpose: interface of wxSlider // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -45,8 +45,7 @@ @category{ctrl} @appearance{slider.png} - @seealso - @ref overview_eventhandlingoverview, wxScrollBar + @see @ref overview_eventhandlingoverview, wxScrollBar */ class wxSlider : public wxControl { @@ -279,3 +278,4 @@ public: */ void SetValue(int value); }; + diff --git a/interface/snglinst.h b/interface/snglinst.h index 8547d6e199..b9db36b69e 100644 --- a/interface/snglinst.h +++ b/interface/snglinst.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: snglinst.h -// Purpose: documentation for wxSingleInstanceChecker class +// Purpose: interface of wxSingleInstanceChecker // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -48,7 +48,7 @@ } @endcode - Note using wxGetUserId to construct the name: this + Note using wxGetUserId() to construct the name: this allows different user to run the application concurrently which is usually the intended goal. If you don't use the user name in the wxSingleInstanceChecker name, only one user would be able to run the application at a time. @@ -104,3 +104,4 @@ public: */ bool IsAnotherRunning() const; }; + diff --git a/interface/socket.h b/interface/socket.h index b95dafd1d5..471a96dec2 100644 --- a/interface/socket.h +++ b/interface/socket.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: socket.h -// Purpose: documentation for wxIPV4address class +// Purpose: interface of wxIPV4address // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -60,6 +60,7 @@ public: }; + /** @class wxSocketServer @wxheader{socket.h} @@ -68,9 +69,8 @@ public: @library{wxnet} @category{net} - @seealso - wxSocketServer::WaitForAccept, wxSocketBase::SetNotify, wxSocketBase::Notify, - wxSocketServer::AcceptWith + @see wxSocketServer::WaitForAccept, wxSocketBase::SetNotify, + wxSocketBase::Notify, wxSocketServer::AcceptWith */ class wxSocketServer : public wxSocketBase { @@ -148,6 +148,7 @@ public: }; + /** @class wxIPaddress @wxheader{socket.h} @@ -220,6 +221,7 @@ public: }; + /** @class wxSocketClient @wxheader{socket.h} @@ -228,8 +230,8 @@ public: @library{wxnet} @category{net} - @seealso - wxSocketClient::WaitOnConnect, wxSocketBase::SetNotify, wxSocketBase::Notify + @see wxSocketClient::WaitOnConnect, wxSocketBase::SetNotify, + wxSocketBase::Notify */ class wxSocketClient : public wxSocketBase { @@ -301,6 +303,7 @@ public: }; + /** @class wxSockAddress @wxheader{socket.h} @@ -310,8 +313,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxSocketBase, wxIPaddress, wxIPV4address + @see wxSocketBase, wxIPaddress, wxIPV4address */ class wxSockAddress : public wxObject { @@ -338,6 +340,7 @@ public: }; + /** @class wxSocketEvent @wxheader{socket.h} @@ -347,8 +350,7 @@ public: @library{wxnet} @category{net} - @seealso - wxSocketBase, wxSocketClient, wxSocketServer + @see wxSocketBase, wxSocketClient, wxSocketServer */ class wxSocketEvent : public wxEvent { @@ -377,6 +379,7 @@ public: }; + /** @class wxSocketBase @wxheader{socket.h} @@ -396,8 +399,7 @@ public: @library{wxnet} @category{net} - @seealso - wxSocketEvent, wxSocketClient, wxSocketServer, @ref overview_samplesockets + @see wxSocketEvent, wxSocketClient, wxSocketServer, @ref overview_samplesockets "Sockets sample" */ class wxSocketBase : public wxObject @@ -1022,6 +1024,7 @@ public: }; + /** @class wxDatagramSocket @wxheader{socket.h} @@ -1030,8 +1033,7 @@ public: @library{wxnet} @category{FIXME} - @seealso - wxSocketBase::Error, wxSocketBase::LastError, wxSocketBase::LastCount, + @see wxSocketBase::Error, wxSocketBase::LastError, wxSocketBase::LastCount, wxSocketBase::SetFlags, */ class wxDatagramSocket : public wxSocketBase @@ -1091,3 +1093,4 @@ public: const void* buffer, wxUint32 nbytes); }; + diff --git a/interface/sound.h b/interface/sound.h index 2fff9caf3a..3338471cdd 100644 --- a/interface/sound.h +++ b/interface/sound.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: sound.h -// Purpose: documentation for wxSound class +// Purpose: interface of wxSound // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -104,3 +104,4 @@ public: */ static void Stop(); }; + diff --git a/interface/spinbutt.h b/interface/spinbutt.h index 1844319f9a..0e9ff39674 100644 --- a/interface/spinbutt.h +++ b/interface/spinbutt.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: spinbutt.h -// Purpose: documentation for wxSpinEvent class +// Purpose: interface of wxSpinEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -16,8 +16,7 @@ @library{wxcore} @category{events} - @seealso - wxSpinButton and wxSpinCtrl + @see wxSpinButton and wxSpinCtrl */ class wxSpinEvent : public wxNotifyEvent { @@ -39,6 +38,7 @@ public: }; + /** @class wxSpinButton @wxheader{spinbutt.h} @@ -70,8 +70,7 @@ public: @category{ctrl} @appearance{spinbutton.png} - @seealso - wxSpinCtrl + @see wxSpinCtrl */ class wxSpinButton : public wxControl { @@ -161,3 +160,4 @@ public: */ void SetValue(int value); }; + diff --git a/interface/spinctrl.h b/interface/spinctrl.h index 884216ec7f..94dd210d2a 100644 --- a/interface/spinctrl.h +++ b/interface/spinctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: spinctrl.h -// Purpose: documentation for wxSpinCtrl class +// Purpose: interface of wxSpinCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @category{ctrl} @appearance{spinctrl.png} - @seealso - @ref overview_eventhandlingoverview, wxSpinButton, wxControl + @see @ref overview_eventhandlingoverview, wxSpinButton, wxControl */ class wxSpinCtrl : public wxControl { @@ -120,3 +119,4 @@ public: void SetValue(int value); //@} }; + diff --git a/interface/splash.h b/interface/splash.h index ef06a2a4dd..ae408f6bb0 100644 --- a/interface/splash.h +++ b/interface/splash.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: splash.h -// Purpose: documentation for wxSplashScreen class +// Purpose: interface of wxSplashScreen // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -83,3 +83,4 @@ public: */ void OnCloseWindow(wxCloseEvent& event); }; + diff --git a/interface/splitter.h b/interface/splitter.h index 9c86b3675d..145f7db491 100644 --- a/interface/splitter.h +++ b/interface/splitter.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: splitter.h -// Purpose: documentation for wxSplitterWindow class +// Purpose: interface of wxSplitterWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -41,8 +41,7 @@ @library{wxcore} @category{miscwnd} - @seealso - wxSplitterEvent + @see wxSplitterEvent */ class wxSplitterWindow : public wxWindow { @@ -365,6 +364,7 @@ public: }; + /** @class wxSplitterEvent @wxheader{splitter.h} @@ -379,8 +379,7 @@ public: @library{wxcore} @category{events} - @seealso - wxSplitterWindow, @ref overview_eventhandlingoverview + @see wxSplitterWindow, @ref overview_eventhandlingoverview */ class wxSplitterEvent : public wxNotifyEvent { @@ -437,3 +436,4 @@ public: */ void SetSashPosition(int pos); }; + diff --git a/interface/srchctrl.h b/interface/srchctrl.h index 9990bd775c..461894d29b 100644 --- a/interface/srchctrl.h +++ b/interface/srchctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: srchctrl.h -// Purpose: documentation for wxSearchCtrl class +// Purpose: interface of wxSearchCtrl // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -43,8 +43,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxTextCtrl::Create, wxValidator + @see wxTextCtrl::Create, wxValidator */ class wxSearchCtrl : public wxTextCtrl { @@ -126,3 +125,4 @@ public: */ virtual void ShowSearchButton(bool show); }; + diff --git a/interface/sstream.h b/interface/sstream.h index a4d4420794..a950a75848 100644 --- a/interface/sstream.h +++ b/interface/sstream.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: sstream.h -// Purpose: documentation for wxStringInputStream class +// Purpose: interface of wxStringInputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -28,6 +28,7 @@ public: }; + /** @class wxStringOutputStream @wxheader{sstream.h} @@ -59,3 +60,4 @@ public: */ const wxString GetString() const; }; + diff --git a/interface/stackwalk.h b/interface/stackwalk.h index 630a736dac..2944e170da 100644 --- a/interface/stackwalk.h +++ b/interface/stackwalk.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stackwalk.h -// Purpose: documentation for wxStackWalker class +// Purpose: interface of wxStackWalker // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -43,8 +43,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxStackFrame + @see wxStackFrame */ class wxStackWalker { @@ -85,6 +84,7 @@ public: }; + /** @class wxStackFrame @wxheader{stackwalk.h} @@ -97,8 +97,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxStackWalker + @see wxStackWalker */ class wxStackFrame { @@ -167,3 +166,4 @@ public: */ bool HasSourceLocation() const; }; + diff --git a/interface/statbmp.h b/interface/statbmp.h index 635bd3516b..07afe1f13d 100644 --- a/interface/statbmp.h +++ b/interface/statbmp.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: statbmp.h -// Purpose: documentation for wxStaticBitmap class +// Purpose: interface of wxStaticBitmap // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -20,8 +20,7 @@ @category{ctrl} @appearance{staticbitmap.png} - @seealso - wxStaticBitmap, wxStaticBox + @see wxStaticBitmap, wxStaticBox */ class wxStaticBitmap : public wxControl { @@ -102,3 +101,4 @@ public: */ virtual void SetIcon(const wxIcon& label); }; + diff --git a/interface/statbox.h b/interface/statbox.h index 3475a407f8..6f7b19d804 100644 --- a/interface/statbox.h +++ b/interface/statbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: statbox.h -// Purpose: documentation for wxStaticBox class +// Purpose: interface of wxStaticBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -27,8 +27,7 @@ @category{ctrl} @appearance{staticbox.png} - @seealso - wxStaticText + @see wxStaticText */ class wxStaticBox : public wxControl { @@ -81,3 +80,4 @@ public: long style = 0, const wxString& name = "staticBox"); }; + diff --git a/interface/statline.h b/interface/statline.h index a4a99eb630..346d021ab9 100644 --- a/interface/statline.h +++ b/interface/statline.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: statline.h -// Purpose: documentation for wxStaticLine class +// Purpose: interface of wxStaticLine // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -23,8 +23,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxStaticBox + @see wxStaticBox */ class wxStaticLine : public wxControl { @@ -80,3 +79,4 @@ public: */ bool IsVertical() const; }; + diff --git a/interface/stattext.h b/interface/stattext.h index 5018856dde..9f058e57ed 100644 --- a/interface/stattext.h +++ b/interface/stattext.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stattext.h -// Purpose: documentation for wxStaticText class +// Purpose: interface of wxStaticText // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -42,8 +42,7 @@ @category{ctrl} @appearance{statictext.png} - @seealso - wxStaticBitmap, wxStaticBox + @see wxStaticBitmap, wxStaticBox */ class wxStaticText : public wxControl { @@ -203,7 +202,9 @@ public: most @a width pixels wide if possible (the lines are broken at words boundaries so it might not be the case if words are too long). If @e width is negative, no wrapping is done. - This function is new since wxWidgets version 2.6.2 + + @wxsince{2.6.2} */ void Wrap(int width); }; + diff --git a/interface/statusbr.h b/interface/statusbr.h index feb372b72c..eaf84eafc2 100644 --- a/interface/statusbr.h +++ b/interface/statusbr.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: statusbr.h -// Purpose: documentation for wxStatusBar class +// Purpose: interface of wxStatusBar // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -31,8 +31,7 @@ @library{wxcore} @category{miscwnd} - @seealso - wxFrame, @ref overview_samplestatbar "Status bar sample" + @see wxFrame, @ref overview_samplestatbar "Status bar sample" */ class wxStatusBar : public wxWindow { @@ -231,3 +230,4 @@ public: */ virtual void SetStatusWidths(int n, int* widths); }; + diff --git a/interface/stc/stc.h b/interface/stc/stc.h index d467db2d7a..53f286e8f4 100644 --- a/interface/stc/stc.h +++ b/interface/stc/stc.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stc/stc.h -// Purpose: documentation for wxStyledTextEvent class +// Purpose: interface of wxStyledTextEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -250,6 +250,7 @@ public: }; + /** @class wxStyledTextCtrl @headerfile stc.h wx/stc/stc.h @@ -274,8 +275,7 @@ public: @library{wxbase} @category{stc} - @seealso - wxStyledTextEvent + @see wxStyledTextEvent */ class wxStyledTextCtrl : public wxControl { @@ -2743,3 +2743,4 @@ public: */ void ZoomOut(); }; + diff --git a/interface/stdpaths.h b/interface/stdpaths.h index 365a2846c7..ae6564053b 100644 --- a/interface/stdpaths.h +++ b/interface/stdpaths.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stdpaths.h -// Purpose: documentation for wxStandardPaths class +// Purpose: interface of wxStandardPaths // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -41,8 +41,7 @@ @library{wxbase} @category{file} - @seealso - wxFileConfig + @see wxFileConfig */ class wxStandardPaths { @@ -81,7 +80,8 @@ public: Unix: @c ~ (the home directory) Windows: @c C:\Documents and Settings\@e username\Documents Mac: @c ~/Documents - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ wxString GetDocumentsDir() const; @@ -121,7 +121,8 @@ public: @c @e lang.lproj under Mac OS X) but is something quite different for message catalog category under Unix where it returns the standard @c @e prefix/share/locale/@e lang/LC_MESSAGES directory. - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ wxString GetLocalizedResourcesDir(const wxString& lang, ResourceCat category = ResourceCat_None) const; @@ -147,7 +148,8 @@ public: Unix: @c @e prefix/share/@e appname Windows: the directory where the executable file is located Mac: @c @e appname.app/Contents/Resources bundle subdirectory - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} @see GetLocalizedResourcesDir() */ @@ -158,7 +160,8 @@ public: files, it is best to use wxFileName::CreateTempFileName for correct behaviour when multiple processes are attempting to create temporary files. - This function is new since wxWidgets version 2.7.2 + + @wxsince{2.7.2} */ wxString GetTempDir() const; @@ -217,3 +220,4 @@ public: */ void UseAppInfo(int info); }; + diff --git a/interface/stockitem.h b/interface/stockitem.h index d61fd0f907..e99dac6765 100644 --- a/interface/stockitem.h +++ b/interface/stockitem.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stockitem.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license diff --git a/interface/stopwatch.h b/interface/stopwatch.h index 6d778331b2..982cb0571c 100644 --- a/interface/stopwatch.h +++ b/interface/stopwatch.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stopwatch.h -// Purpose: documentation for wxStopWatch class +// Purpose: interface of wxStopWatch // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -28,8 +28,7 @@ @library{wxbase} @category{misc} - @seealso - wxTimer + @see wxTimer */ class wxStopWatch { @@ -68,6 +67,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/strconv.h b/interface/strconv.h index 7e76e2125a..f92e7f2436 100644 --- a/interface/strconv.h +++ b/interface/strconv.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: strconv.h -// Purpose: documentation for wxMBConvUTF7 class +// Purpose: interface of wxMBConvUTF7 // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxbase} @category{FIXME} - @seealso - wxMBConvUTF8, @ref overview_mbconvclasses "wxMBConv classes overview" + @see wxMBConvUTF8, @ref overview_mbconvclasses "wxMBConv classes overview" */ class wxMBConvUTF7 : public wxMBConv { @@ -38,6 +37,7 @@ public: }; + /** @class wxMBConvUTF8 @wxheader{strconv.h} @@ -48,8 +48,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxMBConvUTF7, @ref overview_mbconvclasses "wxMBConv classes overview" + @see wxMBConvUTF7, @ref overview_mbconvclasses "wxMBConv classes overview" */ class wxMBConvUTF8 : public wxMBConv { @@ -68,12 +67,13 @@ public: }; + /** @class wxMBConvUTF16 @wxheader{strconv.h} This class is used to convert between multibyte encodings and UTF-16 Unicode - encoding (also known as UCS-2). Unlike UTF-8 encoding, + encoding (also known as UCS-2). Unlike UTF-8() encoding, UTF-16 uses words and not bytes and hence depends on the byte ordering: big or little endian. Hence this class is provided in two versions: wxMBConvUTF16LE and wxMBConvUTF16BE and wxMBConvUTF16 itself is just a typedef @@ -83,8 +83,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxMBConvUTF8, wxMBConvUTF32, @ref overview_mbconvclasses "wxMBConv classes + @see wxMBConvUTF8, wxMBConvUTF32, @ref overview_mbconvclasses "wxMBConv classes overview" */ class wxMBConvUTF16 : public wxMBConv @@ -104,6 +103,7 @@ public: }; + /** @class wxCSConv @wxheader{strconv.h} @@ -115,9 +115,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxMBConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv classes - overview" + @see wxMBConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv + classes overview" */ class wxCSConv : public wxMBConv { @@ -142,7 +141,8 @@ public: available to use. Returns @false if ISO 8859-1 will be used instead. Note this does not mean that a given string will be correctly converted. A malformed string may still make conversion functions return @c wxCONV_FAILED. - This function is new since wxWidgets version 2.8.2 + + @wxsince{2.8.2} */ bool IsOk() const; @@ -160,6 +160,7 @@ public: }; + /** @class wxMBConvFile @wxheader{strconv.h} @@ -192,8 +193,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_mbconvclasses "wxMBConv classes overview" + @see @ref overview_mbconvclasses "wxMBConv classes overview" */ class wxMBConvFile : public wxMBConv { @@ -212,12 +212,13 @@ public: }; + /** @class wxMBConvUTF32 @wxheader{strconv.h} This class is used to convert between multibyte encodings and UTF-32 Unicode - encoding (also known as UCS-4). Unlike UTF-8 encoding, + encoding (also known as UCS-4). Unlike UTF-8() encoding, UTF-32 uses (double) words and not bytes and hence depends on the byte ordering: big or little endian. Hence this class is provided in two versions: wxMBConvUTF32LE and wxMBConvUTF32BE and wxMBConvUTF32 itself is just a typedef @@ -227,8 +228,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxMBConvUTF8, wxMBConvUTF16, @ref overview_mbconvclasses "wxMBConv classes + @see wxMBConvUTF8, wxMBConvUTF16, @ref overview_mbconvclasses "wxMBConv classes overview" */ class wxMBConvUTF32 : public wxMBConv @@ -248,6 +248,7 @@ public: }; + /** @class wxMBConv @wxheader{strconv.h} @@ -266,9 +267,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxCSConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv classes - overview" + @see wxCSConv, wxEncodingConverter, @ref overview_mbconvclasses "wxMBConv + classes overview" */ class wxMBConv { @@ -455,3 +455,4 @@ public: const const wxWCharBuffer cWX2WC(const wxChar* psz) const; //@} }; + diff --git a/interface/stream.h b/interface/stream.h index 6af9c7ff43..c55c7bc990 100644 --- a/interface/stream.h +++ b/interface/stream.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: stream.h -// Purpose: documentation for wxCountingOutputStream class +// Purpose: interface of wxCountingOutputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -49,6 +49,7 @@ public: }; + /** @class wxBufferedInputStream @wxheader{stream.h} @@ -62,8 +63,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxStreamBuffer, wxInputStream, wxBufferedOutputStream + @see wxStreamBuffer, wxInputStream, wxBufferedOutputStream */ class wxBufferedInputStream : public wxFilterInputStream { @@ -72,6 +72,7 @@ public: }; + /** @class wxStreamBuffer @wxheader{stream.h} @@ -80,8 +81,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxStreamBase + @see wxStreamBase */ class wxStreamBuffer { @@ -278,6 +278,7 @@ public: }; + /** @class wxOutputStream @wxheader{stream.h} @@ -352,6 +353,7 @@ public: }; + /** @class wxFilterClassFactory @wxheader{stream.h} @@ -376,8 +378,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxFilterInputStream, wxFilterOutputStream, wxArchiveClassFactory, @ref + @see wxFilterInputStream, wxFilterOutputStream, wxArchiveClassFactory, @ref overview_wxarc "Archive formats such as zip" */ class wxFilterClassFactory : public wxObject @@ -471,6 +472,7 @@ public: }; + /** @class wxFilterOutputStream @wxheader{stream.h} @@ -483,8 +485,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxFilterClassFactory, wxFilterInputStream + @see wxFilterClassFactory, wxFilterInputStream */ class wxFilterOutputStream : public wxOutputStream { @@ -501,6 +502,7 @@ public: }; + /** @class wxFilterInputStream @wxheader{stream.h} @@ -514,8 +516,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxFilterClassFactory, wxFilterOutputStream + @see wxFilterClassFactory, wxFilterOutputStream */ class wxFilterInputStream : public wxInputStream { @@ -532,6 +533,7 @@ public: }; + /** @class wxBufferedOutputStream @wxheader{stream.h} @@ -547,8 +549,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxStreamBuffer, wxOutputStream + @see wxStreamBuffer, wxOutputStream */ class wxBufferedOutputStream : public wxFilterOutputStream { @@ -577,6 +578,7 @@ public: }; + /** @class wxInputStream @wxheader{stream.h} @@ -670,6 +672,7 @@ public: }; + /** @class wxStreamBase @wxheader{stream.h} @@ -681,8 +684,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxStreamBuffer + @see wxStreamBuffer */ class wxStreamBase { @@ -722,7 +724,8 @@ public: Returns the length of the stream in bytes. If the length cannot be determined (this is always the case for socket streams for example), returns @c wxInvalidOffset. - This function is new since wxWidgets version 2.5.4 + + @wxsince{2.5.4} */ wxFileOffset GetLength() const; @@ -768,3 +771,4 @@ public: */ size_t OnSysWrite(const void* buffer, size_t bufsize); }; + diff --git a/interface/string.h b/interface/string.h index fc57852172..4c0096b7c1 100644 --- a/interface/string.h +++ b/interface/string.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: string.h -// Purpose: documentation for wxStringBuffer class +// Purpose: interface of wxStringBuffer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -67,6 +67,7 @@ public: }; + /** @class wxString @wxheader{string.h} @@ -94,11 +95,9 @@ public: @category{data} @stdobjects - Objects: - wxEmptyString + ::Objects:, ::wxEmptyString, - @seealso - @ref overview_wxstringoverview "wxString overview", @ref overview_unicode + @see @ref overview_wxstringoverview "wxString overview", @ref overview_unicode "Unicode overview" */ class wxString @@ -207,7 +206,7 @@ public: This section also contains both implicit and explicit conversions to C style strings. Although implicit conversion is quite convenient, it is advised to use explicit @ref cstr() c_str method for the sake of clarity. Also - see overview for the cases where it is necessary to + see overview() for the cases where it is necessary to use it. GetChar() @@ -434,7 +433,8 @@ public: build, the string is interpreted as being in ISO-8859-1 encoding. The version without @a len parameter takes NUL-terminated data. This is a convenience method useful when storing binary data in wxString. - This function is new since wxWidgets version 2.8.4 + + @wxsince{2.8.4} @see wxString::To8BitData */ @@ -791,7 +791,8 @@ public: Converts the string to an 8-bit string in ISO-8859-1 encoding in the form of a wxCharBuffer (Unicode builds only). This is a convenience method useful when storing binary data in wxString. - This function is new since wxWidgets version 2.8.4 + + @wxsince{2.8.4} @see wxString::From8BitData */ @@ -1160,6 +1161,20 @@ public: }; +/** + FIXME +*/ +wxString Objects: +; + +/** + FIXME +*/ +wxString wxEmptyString; + + + + /** @class wxStringBufferLength @wxheader{string.h} @@ -1234,6 +1249,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -1241,7 +1257,7 @@ public: //@{ /** Converts its argument to string. - See also: wxFromString. + See also: wxFromString(). */ wxString wxToString(const wxColour& col); wxString wxToString(const wxFont& col); @@ -1250,7 +1266,7 @@ wxString wxToString(const wxFont& col); //@{ /** Converts string to the type of the second argument. Returns @true on success. - See also: wxToString. + See also: wxToString(). */ bool wxFromString(const wxString& str, wxColour* col); bool wxFromString(const wxString& str, wxFont* col); diff --git a/interface/sysopt.h b/interface/sysopt.h index b0fee1b0d2..cce0f32f31 100644 --- a/interface/sysopt.h +++ b/interface/sysopt.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: sysopt.h -// Purpose: documentation for wxSystemOptions class +// Purpose: interface of wxSystemOptions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -20,8 +20,7 @@ @library{wxbase} @category{misc} - @seealso - wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt, + @see wxSystemOptions::SetOption, wxSystemOptions::GetOptionInt, wxSystemOptions::HasOption */ class wxSystemOptions : public wxObject @@ -76,3 +75,4 @@ public: void SetOption(const wxString& name, int value); //@} }; + diff --git a/interface/tarstrm.h b/interface/tarstrm.h index 29193c5943..831884ec02 100644 --- a/interface/tarstrm.h +++ b/interface/tarstrm.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: tarstrm.h -// Purpose: documentation for wxTarInputStream class +// Purpose: interface of wxTarInputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -26,8 +26,7 @@ @library{wxbase} @category{streams} - @seealso - @ref overview_wxarcbyname "Looking up an archive entry by name" + @see @ref overview_wxarcbyname "Looking up an archive entry by name" */ class wxTarInputStream : public wxArchiveInputStream { @@ -70,6 +69,7 @@ public: }; + /** @class wxTarClassFactory @wxheader{tarstrm.h} @@ -80,9 +80,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric - "Generic archive programming", wxTarEntry, wxTarInputStream, wxTarOutputStream + @see @ref overview_wxarc "Archive formats such as zip", @ref + overview_wxarcgeneric "Generic archive programming", wxTarEntry, wxTarInputStream, wxTarOutputStream */ class wxTarClassFactory : public wxArchiveClassFactory { @@ -91,6 +90,7 @@ public: }; + /** @class wxTarOutputStream @wxheader{tarstrm.h} @@ -105,8 +105,8 @@ public: @library{wxbase} @category{streams} - @seealso - @ref overview_wxarc "Archive formats such as zip", wxTarEntry, wxTarInputStream + @see @ref overview_wxarc "Archive formats such as zip", wxTarEntry, + wxTarInputStream */ class wxTarOutputStream : public wxArchiveOutputStream { @@ -209,6 +209,7 @@ public: }; + /** @class wxTarEntry @wxheader{tarstrm.h} @@ -218,8 +219,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarc "Archive formats such as zip", wxTarInputStream, + @see @ref overview_wxarc "Archive formats such as zip", wxTarInputStream, wxTarOutputStream */ class wxTarEntry : public wxArchiveEntry @@ -351,3 +351,4 @@ public: */ wxTarEntry& operator operator=(const wxTarEntry& entry); }; + diff --git a/interface/taskbar.h b/interface/taskbar.h index f842f22983..9eb2faaefb 100644 --- a/interface/taskbar.h +++ b/interface/taskbar.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: taskbar.h -// Purpose: documentation for wxTaskBarIcon class +// Purpose: interface of wxTaskBarIcon // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -74,3 +74,4 @@ public: */ bool SetIcon(const wxIcon& icon, const wxString& tooltip); }; + diff --git a/interface/textctrl.h b/interface/textctrl.h index 2ae1403b86..15b802843a 100644 --- a/interface/textctrl.h +++ b/interface/textctrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: textctrl.h -// Purpose: documentation for wxTextAttr class +// Purpose: interface of wxTextAttr // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -22,8 +22,7 @@ @library{wxcore} @category{richtext} - @seealso - wxTextCtrl, wxRichTextCtrl + @see wxTextCtrl, wxRichTextCtrl */ class wxTextAttr { @@ -622,6 +621,7 @@ public: }; + /** @class wxTextCtrl @wxheader{textctrl.h} @@ -697,8 +697,7 @@ public: @category{ctrl} @appearance{textctrl.png} - @seealso - wxTextCtrl::Create, wxValidator + @see wxTextCtrl::Create, wxValidator */ class wxTextCtrl : public wxControl { @@ -769,7 +768,8 @@ public: text control using the given @e choices. Notice that currently this function is only implemented in wxGTK2 and wxMSW ports and does nothing under the other platforms. - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} @returns @true if the auto-completion was enabled or @false if the operation failed, typically because auto-completion is @@ -784,7 +784,8 @@ public: text control using all valid file system paths. Notice that currently this function is only implemented in wxGTK2 port and does nothing under the other platforms. - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} @returns @true if the auto-completion was enabled or @false if the operation failed, typically because auto-completion is @@ -831,7 +832,8 @@ public: event. This is the only difference with SetValue(). See @ref overview_progevent "this topic" for more information. - This function is new since wxWidgets version 2.7.1 + + @wxsince{2.7.1} @param value The new value to set. It may contain newline characters if the text control @@ -1023,7 +1025,8 @@ public: Returns @true if the control is currently empty. This is the same as @c GetValue().empty() but can be much more efficient for the multiline controls containing big amounts of text. - This function is new since wxWidgets version 2.7.1 + + @wxsince{2.7.1} */ bool IsEmpty() const; @@ -1319,6 +1322,7 @@ public: }; + /** @class wxStreamToTextRedirector @wxheader{textctrl.h} @@ -1354,8 +1358,7 @@ public: @library{wxcore} @category{logging} - @seealso - wxTextCtrl + @see wxTextCtrl */ class wxStreamToTextRedirector { @@ -1378,3 +1381,4 @@ public: */ ~wxStreamToTextRedirector(); }; + diff --git a/interface/textdlg.h b/interface/textdlg.h index 20b28d5eeb..ca65daaa8d 100644 --- a/interface/textdlg.h +++ b/interface/textdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: textdlg.h -// Purpose: documentation for wxPasswordEntryDialog class +// Purpose: interface of wxPasswordEntryDialog // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,8 @@ @library{wxbase} @category{cmndlg} - @seealso - @ref overview_wxpasswordentrydialogoverview "wxPassowrdEntryDialog overview" + @see @ref overview_wxpasswordentrydialogoverview "wxPassowrdEntryDialog + overview" */ class wxPasswordEntryDialog : public wxTextEntryDialog { @@ -27,6 +27,7 @@ public: }; + /** @class wxTextEntryDialog @wxheader{textdlg.h} @@ -38,8 +39,7 @@ public: @library{wxbase} @category{cmndlg} - @seealso - @ref overview_wxtextentrydialogoverview "wxTextEntryDialog overview" + @see @ref overview_wxtextentrydialogoverview "wxTextEntryDialog overview" */ class wxTextEntryDialog : public wxDialog { @@ -91,6 +91,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -111,7 +112,7 @@ wxString wxGetTextFromUser(const wxString& message, bool centre = true); /** - Similar to wxGetTextFromUser but the text entered + Similar to wxGetTextFromUser() but the text entered in the dialog is not shown on screen but replaced with stars. This is intended to be used for entering passwords as the function name implies. */ diff --git a/interface/textfile.h b/interface/textfile.h index 6289a57fce..ca8b2d8da1 100644 --- a/interface/textfile.h +++ b/interface/textfile.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: textfile.h -// Purpose: documentation for wxTextFile class +// Purpose: interface of wxTextFile // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -56,8 +56,7 @@ @library{wxbase} @category{file} - @seealso - wxFile + @see wxFile */ class wxTextFile { @@ -239,3 +238,4 @@ public: */ wxString operator[](size_t n) const; }; + diff --git a/interface/tglbtn.h b/interface/tglbtn.h index a48dc9c580..16c15dff29 100644 --- a/interface/tglbtn.h +++ b/interface/tglbtn.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: tglbtn.h -// Purpose: documentation for wxBitmapToggleButton class +// Purpose: interface of wxBitmapToggleButton // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -71,6 +71,7 @@ public: }; + /** @class wxToggleButton @wxheader{tglbtn.h} @@ -82,7 +83,7 @@ public: Since wxWidgets version 2.9.0 this control emits an update UI event. You can see wxToggleButton in action in the sixth page of the - controls sample. + controls() sample. @beginEventTable @event{EVT_TOGGLEBUTTON(id, func)}: @@ -93,8 +94,7 @@ public: @category{ctrl} @appearance{togglebutton.png} - @seealso - wxCheckBox, wxButton, wxBitmapToggleButton + @see wxCheckBox, wxButton, wxBitmapToggleButton */ class wxToggleButton : public wxControl { @@ -167,3 +167,4 @@ public: */ void SetValue(bool state); }; + diff --git a/interface/thread.h b/interface/thread.h index 4a51723acb..0ab42e470c 100644 --- a/interface/thread.h +++ b/interface/thread.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: thread.h -// Purpose: documentation for wxCondition class +// Purpose: interface of wxCondition // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -33,8 +33,7 @@ @library{wxbase} @category{thread} - @seealso - wxThread, wxMutex + @see wxThread, wxMutex */ class wxCondition { @@ -112,6 +111,7 @@ public: }; + /** @class wxCriticalSectionLocker @wxheader{thread.h} @@ -152,8 +152,7 @@ public: @library{wxbase} @category{thread} - @seealso - wxCriticalSection, wxMutexLocker + @see wxCriticalSection, wxMutexLocker */ class wxCriticalSectionLocker { @@ -171,6 +170,7 @@ public: }; + /** @class wxThreadHelper @wxheader{thread.h} @@ -204,8 +204,7 @@ public: @library{wxbase} @category{thread} - @seealso - wxThread + @see wxThread */ class wxThreadHelper { @@ -255,12 +254,13 @@ public: }; + /** @class wxCriticalSection @wxheader{thread.h} A critical section object is used for exactly the same purpose as - mutexes. The only difference is that under Windows platform + mutexes(). The only difference is that under Windows platform critical sections are only visible inside one process, while mutexes may be shared between processes, so using critical sections is slightly more efficient. The terminology is also slightly different: mutex may be locked (or @@ -276,8 +276,7 @@ public: @library{wxbase} @category{thread} - @seealso - wxThread, wxCondition, wxCriticalSectionLocker + @see wxThread, wxCondition, wxCriticalSectionLocker */ class wxCriticalSection { @@ -307,6 +306,7 @@ public: }; + /** @class wxThread @wxheader{thread.h} @@ -320,16 +320,15 @@ public: also makes it much easier to shoot oneself in the foot, so careful use of synchronization - objects such as mutexes or @ref overview_wxcriticalsection "critical sections" - is recommended. In addition, don't create global thread + objects such as mutexes() or @ref overview_wxcriticalsection "critical + sections" is recommended. In addition, don't create global thread objects because they allocate memory in their constructor, which will cause problems for the memory checking system. @library{wxbase} @category{thread} - @seealso - wxMutex, wxCondition, wxCriticalSection + @see wxMutex, wxCondition, wxCriticalSection */ class wxThread { @@ -410,11 +409,11 @@ public: in fact calling a routine on any running wxThread should be avoided if possible. Instead, find a way to notify yourself when the thread has ended. Usually you only need to notify the main thread, in which case you can post - an event to it via wxPostEvent or + an event to it via wxPostEvent() or wxEvtHandler::AddPendingEvent. In the case of secondary threads you can call a routine of another class when the thread is about to complete processing and/or set the value - of a variable, possibly using mutexes and/or other + of a variable, possibly using mutexes() and/or other synchronization means if necessary. */ @@ -594,7 +593,7 @@ public: /** Pauses the thread execution for the given amount of time. - This function should be used instead of wxSleep by all worker + This function should be used instead of wxSleep() by all worker threads (i.e. all except the main one). */ static void Sleep(unsigned long milliseconds); @@ -730,10 +729,10 @@ public: and could end your application prematurely. This is due to several reasons, including the underlying native API and the fact that wxThread does not run a GUI event loop similar to other APIs as MFC. - A workaround that works on some wxWidgets ports is calling wxMutexGUIEnter - before any GUI calls and then calling wxMutexGUILeave afterwords. However, + A workaround that works on some wxWidgets ports is calling wxMutexGUIEnter() + before any GUI calls and then calling wxMutexGUILeave() afterwords. However, the recommended way is to simply process the GUI calls in the main thread - through an event that is posted by either wxPostEvent or + through an event that is posted by either wxPostEvent() or wxEvtHandler::AddPendingEvent. This does not imply that calls to these classes are thread-safe, however, as most wxWidgets classes are not thread-safe, including wxString. @@ -741,6 +740,7 @@ public: }; + /** @class wxSemaphore @wxheader{thread.h} @@ -809,6 +809,7 @@ public: }; + /** @class wxMutexLocker @wxheader{thread.h} @@ -823,8 +824,7 @@ public: @library{wxbase} @category{thread} - @seealso - wxMutex, wxCriticalSectionLocker + @see wxMutex, wxCriticalSectionLocker */ class wxMutexLocker { @@ -848,6 +848,7 @@ public: }; + /** @class wxMutex @wxheader{thread.h} @@ -874,8 +875,7 @@ public: @library{wxbase} @category{thread} - @seealso - wxThread, wxCondition, wxMutexLocker, wxCriticalSection + @see wxThread, wxCondition, wxMutexLocker, wxCriticalSection */ class wxMutex { @@ -921,6 +921,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -932,8 +933,8 @@ public: bool wxIsMainThread(); /** - This macro combines wxCRIT_SECT_DECLARE and - wxCRIT_SECT_LOCKER: it creates a static critical + This macro combines wxCRIT_SECT_DECLARE() and + wxCRIT_SECT_LOCKER(): it creates a static critical section object and also the lock object associated with it. Because of this, it can be only used inside a function, not at global scope. For example: @@ -959,7 +960,7 @@ bool wxIsMainThread(); This macro declares a critical section object named @a cs if @c wxUSE_THREADS is 1 and does nothing if it is 0. As it doesn't include the @c static keyword (unlike - wxCRIT_SECT_DECLARE), it can be used to declare + wxCRIT_SECT_DECLARE()), it can be used to declare a class or struct member which explains its name. */ #define wxCRIT_SECT_DECLARE(cs) /* implementation is private */ diff --git a/interface/timer.h b/interface/timer.h index 9fa88d5796..2ec9e9c6a5 100644 --- a/interface/timer.h +++ b/interface/timer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: timer.h -// Purpose: documentation for wxTimer class +// Purpose: interface of wxTimer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -37,8 +37,7 @@ @library{wxbase} @category{misc} - @seealso - wxStopWatch + @see wxStopWatch */ class wxTimer : public wxEvtHandler { @@ -128,6 +127,7 @@ public: }; + /** @class wxTimerEvent @wxheader{timer.h} @@ -166,8 +166,7 @@ public: @library{wxbase} @category{events} - @seealso - wxTimer + @see wxTimer */ class wxTimerEvent : public wxEvent { @@ -182,3 +181,4 @@ public: */ wxTimer GetTimer() const; }; + diff --git a/interface/tipdlg.h b/interface/tipdlg.h index e82a2fbd8b..6ac380066c 100644 --- a/interface/tipdlg.h +++ b/interface/tipdlg.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: tipdlg.h -// Purpose: documentation for wxTipProvider class +// Purpose: interface of wxTipProvider // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -10,20 +10,19 @@ @class wxTipProvider @wxheader{tipdlg.h} - This is the class used together with wxShowTip function. + This is the class used together with wxShowTip() function. It must implement wxTipProvider::GetTip function and return the current tip from it (different tip each time it is called). You will never use this class yourself, but you need it to show startup tips with wxShowTip. Also, if you want to get the tips text from elsewhere than a simple text file, you will want to derive a new class from wxTipProvider and - use it instead of the one returned by wxCreateFileTipProvider. + use it instead of the one returned by wxCreateFileTipProvider(). @library{wxadv} @category{FIXME} - @seealso - @ref overview_tipsoverview "Startup tips overview", ::wxShowTip + @see @ref overview_tipsoverview "Startup tips overview", ::wxShowTip */ class wxTipProvider { @@ -40,7 +39,7 @@ public: Returns the index of the current tip (i.e. the one which would be returned by GetTip). The program usually remembers the value returned by this function after calling - wxShowTip. Note that it is not the same as the value which + wxShowTip(). Note that it is not the same as the value which was passed to wxShowTip + 1 because the user might have pressed the "Next" button in the tip dialog. */ @@ -65,13 +64,14 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ /** This function creates a wxTipProvider which may be - used with wxShowTip. + used with wxShowTip(). @param filename The name of the file containing the tips, one per line diff --git a/interface/tipwin.h b/interface/tipwin.h index b6b6d29b61..306314d349 100644 --- a/interface/tipwin.h +++ b/interface/tipwin.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: tipwin.h -// Purpose: documentation for wxTipWindow class +// Purpose: interface of wxTipWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -69,3 +69,4 @@ public: */ void SetTipWindowPtr(wxTipWindow** windowPtr); }; + diff --git a/interface/tokenzr.h b/interface/tokenzr.h index 6d188c59b2..3879b1733b 100644 --- a/interface/tokenzr.h +++ b/interface/tokenzr.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: tokenzr.h -// Purpose: documentation for wxStringTokenizer class +// Purpose: interface of wxStringTokenizer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -99,8 +99,7 @@ @library{wxbase} @category{data} - @seealso - wxStringTokenize + @see wxStringTokenize() */ class wxStringTokenizer : public wxObject { @@ -130,7 +129,8 @@ public: GetNextToken() or @c NUL if there had been no calls to this function yet or if it returned the trailing empty token in @c wxTOKEN_RET_EMPTY_ALL mode. - This function is new since wxWidgets version 2.7.0 + + @wxsince{2.7.0} */ wxChar GetLastDelimiter(); @@ -165,3 +165,4 @@ public: const wxString& delims = " \t\r\n", wxStringTokenizerMode mode = wxTOKEN_DEFAULT); }; + diff --git a/interface/toolbar.h b/interface/toolbar.h index 260a01ccbb..ddb025620e 100644 --- a/interface/toolbar.h +++ b/interface/toolbar.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: toolbar.h -// Purpose: documentation for wxToolBar class +// Purpose: interface of wxToolBar // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -55,8 +55,7 @@ @library{wxbase} @category{miscwnd} - @seealso - @ref overview_wxtoolbaroverview "Toolbar overview", wxScrolledWindow + @see @ref overview_wxtoolbaroverview "Toolbar overview", wxScrolledWindow */ class wxToolBar : public wxControl { @@ -623,3 +622,4 @@ public: */ void ToggleTool(int toolId, bool toggle); }; + diff --git a/interface/toolbook.h b/interface/toolbook.h index 748465803f..8a0cb2a1c8 100644 --- a/interface/toolbook.h +++ b/interface/toolbook.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: toolbook.h -// Purpose: documentation for wxToolbook class +// Purpose: interface of wxToolbook // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -33,11 +33,11 @@ @library{wxcore} @category{FIXME} - @seealso - wxBookCtrl, wxNotebook, @ref overview_samplenotebook "notebook sample" + @see wxBookCtrl(), wxNotebook, @ref overview_samplenotebook "notebook sample" */ class wxToolbook : public wxBookCtrl overview { public: }; + diff --git a/interface/tooltip.h b/interface/tooltip.h index 66c090a879..8c39060810 100644 --- a/interface/tooltip.h +++ b/interface/tooltip.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: tooltip.h -// Purpose: documentation for wxToolTip class +// Purpose: interface of wxToolTip // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -70,3 +70,4 @@ public: */ void SetTip(const wxString& tip); }; + diff --git a/interface/toplevel.h b/interface/toplevel.h index d089b1e1ab..2f4221f64f 100644 --- a/interface/toplevel.h +++ b/interface/toplevel.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: toplevel.h -// Purpose: documentation for wxTopLevelWindow class +// Purpose: interface of wxTopLevelWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxcore} @category{managedwnd} - @seealso - wxTopLevelWindow::SetTransparent + @see wxTopLevelWindow::SetTransparent */ class wxTopLevelWindow : public wxWindow { @@ -366,3 +365,4 @@ public: */ void UseNativeDecorationsByDefault(bool native = true); }; + diff --git a/interface/tracker.h b/interface/tracker.h index 1ba2aa1a53..64484b10d1 100644 --- a/interface/tracker.h +++ b/interface/tracker.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: tracker.h -// Purpose: documentation for wxTrackable class +// Purpose: interface of wxTrackable // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -13,7 +13,7 @@ Add-on base class for a trackable object. This class maintains an internal linked list of classes of type wxTrackerNode and calls OnObjectDestroy() on them if this object is destroyed. - The most common usage is by using the wxWeakRefT + The most common usage is by using the wxWeakRefT() class template which automates this. This class has no public API. Its only use is by deriving another class from it to make it trackable. @@ -35,3 +35,4 @@ class wxTrackable public: }; + diff --git a/interface/treebase.h b/interface/treebase.h index f52b638313..9e83d58c79 100644 --- a/interface/treebase.h +++ b/interface/treebase.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: treebase.h -// Purpose: documentation for wxTreeItemId class +// Purpose: interface of wxTreeItemId // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -15,8 +15,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxTreeCtrl, wxTreeItemData, @ref overview_wxtreectrloverview "wxTreeCtrl + @see wxTreeCtrl, wxTreeItemData, @ref overview_wxtreectrloverview "wxTreeCtrl overview" */ class wxTreeItemId @@ -43,3 +42,4 @@ public: const bool operator !=(const wxTreeItemId& item) const; //@} }; + diff --git a/interface/treebook.h b/interface/treebook.h index e68b202f72..364a23d931 100644 --- a/interface/treebook.h +++ b/interface/treebook.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: treebook.h -// Purpose: documentation for wxTreebookEvent class +// Purpose: interface of wxTreebookEvent // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxcore} @category{events} - @seealso - wxNotebookEvent, wxTreebook + @see wxNotebookEvent, wxTreebook */ class wxTreebookEvent : public wxNotifyEvent { @@ -50,6 +49,7 @@ public: }; + /** @class wxTreebook @wxheader{treebook.h} @@ -73,8 +73,7 @@ public: @library{wxcore} @category{miscwnd} - @seealso - wxNotebook, wxTreebookEvent, wxImageList, @ref overview_samplenotebook + @see wxNotebook, wxTreebookEvent, wxImageList, @ref overview_samplenotebook "notebook sample" */ class wxTreebook : public wxBookCtrl overview @@ -255,3 +254,4 @@ public: */ int SetSelection(size_t n); }; + diff --git a/interface/treectrl.h b/interface/treectrl.h index 60cd852688..342c8d5d56 100644 --- a/interface/treectrl.h +++ b/interface/treectrl.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: treectrl.h -// Purpose: documentation for wxTreeItemData class +// Purpose: interface of wxTreeItemData // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -26,8 +26,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxTreeCtrl + @see wxTreeCtrl */ class wxTreeItemData : public wxClientData { @@ -66,6 +65,7 @@ public: }; + /** @class wxTreeCtrl @wxheader{treectrl.h} @@ -123,8 +123,7 @@ public: @category{ctrl} @appearance{treectrl.png} - @seealso - wxTreeItemData, @ref overview_wxtreectrloverview "wxTreeCtrl overview", + @see wxTreeItemData, @ref overview_wxtreectrloverview "wxTreeCtrl overview", wxListBox, wxListCtrl, wxImageList, wxTreeEvent */ class wxTreeCtrl : public wxControl @@ -667,8 +666,8 @@ wxPython provides the following shortcut method: positive value if the first item is less than, equal to or greater than the second one. Please note that you @b must use wxRTTI macros - DECLARE_DYNAMIC_CLASS and - IMPLEMENT_DYNAMIC_CLASS if you override this + DECLARE_DYNAMIC_CLASS() and + IMPLEMENT_DYNAMIC_CLASS() if you override this function because otherwise the base class considers that it is not overridden and uses the default comparison, i.e. sorts the items alphabetically, which allows it optimize away the calls to the virtual function completely. @@ -875,6 +874,7 @@ wxPython note: }; + /** @class wxTreeEvent @wxheader{treectrl.h} @@ -884,8 +884,7 @@ wxPython note: @library{wxbase} @category{events} - @seealso - wxTreeCtrl + @see wxTreeCtrl */ class wxTreeEvent : public wxNotifyEvent { @@ -944,3 +943,4 @@ public: */ void SetToolTip(const wxString& tooltip); }; + diff --git a/interface/txtstrm.h b/interface/txtstrm.h index 4c4bdb43e3..998dd280a9 100644 --- a/interface/txtstrm.h +++ b/interface/txtstrm.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: txtstrm.h -// Purpose: documentation for wxTextInputStream class +// Purpose: interface of wxTextInputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -50,8 +50,7 @@ @library{wxbase} @category{streams} - @seealso - wxTextInputStream::SetStringSeparators + @see wxTextInputStream::SetStringSeparators */ class wxTextInputStream { @@ -164,6 +163,7 @@ public: }; + /** @class wxTextOutputStream @wxheader{txtstrm.h} @@ -256,3 +256,4 @@ public: */ virtual void WriteString(const wxString& string); }; + diff --git a/interface/uri.h b/interface/uri.h index 5a18ea3101..d2bc5830eb 100644 --- a/interface/uri.h +++ b/interface/uri.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: uri.h -// Purpose: documentation for wxURI class +// Purpose: interface of wxURI // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -30,8 +30,7 @@ @library{wxbase} @category{data} - @seealso - wxURL + @see wxURL */ class wxURI : public wxObject { @@ -313,3 +312,4 @@ public: */ void operator ==(const wxURI& uricomp); }; + diff --git a/interface/url.h b/interface/url.h index 638a09155c..607a0db3de 100644 --- a/interface/url.h +++ b/interface/url.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: url.h -// Purpose: documentation for wxURL class +// Purpose: interface of wxURL // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,8 +21,7 @@ @library{wxnet} @category{net} - @seealso - wxSocketBase, wxProtocol + @see wxSocketBase, wxProtocol */ class wxURL : public wxURI { @@ -130,3 +129,4 @@ public: */ wxURLError SetURL(const wxString& url); }; + diff --git a/interface/utils.h b/interface/utils.h index e8d79439f9..bd3f03ccb5 100644 --- a/interface/utils.h +++ b/interface/utils.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: utils.h -// Purpose: documentation for wxWindowDisabler class +// Purpose: interface of wxWindowDisabler // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxBusyCursor + @see wxBusyCursor */ class wxWindowDisabler { @@ -37,6 +36,7 @@ public: }; + /** @class wxBusyCursor @wxheader{utils.h} @@ -54,30 +54,30 @@ public: DoACalculation(); @endcode - It works by calling wxBeginBusyCursor in the constructor, - and wxEndBusyCursor in the destructor. + It works by calling wxBeginBusyCursor() in the constructor, + and wxEndBusyCursor() in the destructor. @library{wxcore} @category{FIXME} - @seealso - wxBeginBusyCursor, wxEndBusyCursor, wxWindowDisabler + @see wxBeginBusyCursor(), wxEndBusyCursor(), wxWindowDisabler */ class wxBusyCursor { public: /** - Constructs a busy cursor object, calling wxBeginBusyCursor. + Constructs a busy cursor object, calling wxBeginBusyCursor(). */ wxBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR); /** - Destroys the busy cursor object, calling wxEndBusyCursor. + Destroys the busy cursor object, calling wxEndBusyCursor(). */ ~wxBusyCursor(); }; + // ============================================================================ // Global functions/macros // ============================================================================ @@ -102,7 +102,7 @@ wxPowerType wxGetPowerType(); empty string otherwise. The second (deprecated) function returns @true if successful, @false otherwise. - @see wxGetUserName + @see wxGetUserName() */ wxString wxGetUserId(); bool wxGetUserId(char* buf, int sz); @@ -110,10 +110,10 @@ bool wxGetUserId(char* buf, int sz); /** @b NB: This function is now obsolete, please use - wxLogFatalError instead. + wxLogFatalError() instead. Displays @a msg and exits. This writes to standard error under Unix, and pops up a message box under Windows. Used for fatal internal - wxWidgets errors. See also wxError. + wxWidgets errors. See also wxError(). */ void wxFatalError(const wxString& msg, const wxString& title = "wxWidgets Fatal Error"); @@ -144,8 +144,8 @@ wxWindow* wxFindWindowByName(const wxString& name, /** Changes the cursor back to the original cursor, for all windows in the application. - Use with wxBeginBusyCursor. - See also wxIsBusy, wxBusyCursor. + Use with wxBeginBusyCursor(). + See also wxIsBusy(), wxBusyCursor. */ void wxEndBusyCursor(); @@ -167,7 +167,7 @@ void wxRegisterId(long id); /** @b NB: This function is now obsolete, replaced by Log - functions and wxLogDebug in particular. + functions() and wxLogDebug() in particular. Display a debugging message; under Windows, this will appear on the debugger command window, and under Unix, it will be written to standard error. @@ -203,7 +203,7 @@ wxString wxGetOsDescription(); /** Return the (current) user's home directory. - @see wxGetUserHome, wxStandardPaths + @see wxGetUserHome(), wxStandardPaths */ wxString wxGetHomeDir(); @@ -218,7 +218,7 @@ void wxMilliSleep(unsigned long milliseconds); Sleeps for the specified number of microseconds. The microsecond resolution may not, in fact, be available on all platforms (currently only Unix platforms with nanosleep(2) may provide it) in which case this is the same as - wxMilliSleep(@e microseconds/1000). + wxMilliSleep()(@e microseconds/1000). */ void wxMicroSleep(unsigned long microseconds); @@ -228,7 +228,8 @@ void wxMicroSleep(unsigned long microseconds); underlying GUI toolkit. This is mainly used for diagnostic purposes and can be invoked by Ctrl-Alt-middle clicking on any wxWindow which doesn't otherwise handle this event. - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} */ void wxInfoMessageBox(wxWindow ( parent = NULL); @@ -260,11 +261,11 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); int flags = wxStrip_All); /** - @b NB: This function is now obsolete, please use wxLogError + @b NB: This function is now obsolete, please use wxLogError() instead. Displays @a msg and continues. This writes to standard error under Unix, and pops up a message box under Windows. Used for internal - wxWidgets errors. See also wxFatalError. + wxWidgets errors. See also wxFatalError(). */ void wxError(const wxString& msg, const wxString& title = "wxWidgets Internal Error"); @@ -287,7 +288,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); /** Executes a command in an interactive shell window. If no command is specified, then just the shell is spawned. - See also wxExecute, @ref overview_sampleexec "Exec sample". + See also wxExecute(), @ref overview_sampleexec "Exec sample". */ bool wxShell(const wxString& command = NULL); @@ -304,16 +305,16 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); Returns the FQDN (fully qualified domain host name) or an empty string on error. - @see wxGetHostName + @see wxGetHostName() */ wxString wxGetFullHostName(); /** Changes the cursor to the given cursor for all windows in the application. - Use wxEndBusyCursor to revert the cursor back + Use wxEndBusyCursor() to revert the cursor back to its previous state. These two calls can be nested, and a counter ensures that only the outer calls take effect. - See also wxIsBusy, wxBusyCursor. + See also wxIsBusy(), wxBusyCursor. */ void wxBeginBusyCursor(wxCursor* cursor = wxHOURGLASS_CURSOR); @@ -381,7 +382,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); This is a macro defined as @c getenv() or its wide char version in Unicode mode. Note that under Win32 it may not return correct value for the variables set - with wxSetEnv, use wxGetEnv function + with wxSetEnv(), use wxGetEnv() function instead. */ wxChar* wxGetEnv(const wxString& var); @@ -398,7 +399,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); empty string otherwise. The second (deprecated) function returns @true if successful, @false otherwise. - @see wxGetFullHostName + @see wxGetFullHostName() */ wxString wxGetHostName(); bool wxGetHostName(char* buf, int sz); @@ -413,7 +414,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); bool wxGetEnv(const wxString& var, wxString* value); /** - Under X only, returns the current display name. See also wxSetDisplayName. + Under X only, returns the current display name. See also wxSetDisplayName(). */ wxString wxGetDisplayName(); @@ -426,7 +427,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); /** Returns the home directory for the given user. If the @a user is empty (default value), this function behaves like - wxGetHomeDir i.e. returns the current user home + wxGetHomeDir() i.e. returns the current user home directory. If the home directory couldn't be determined, an empty string is returned. */ @@ -451,7 +452,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); the process (which terminates by the moment the function returns) and will be -1 if the process couldn't be started and typically 0 if the process terminated successfully. Also, while waiting for the process to - terminate, wxExecute will call wxYield. Because of this, by + terminate, wxExecute will call wxYield(). Because of this, by default this function disables all application windows to avoid unexpected reentrancies which could result from the users interaction with the program while the child process is running. If you are sure that it is safe to not @@ -475,7 +476,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); happening, i.e. with this flag the child process window will be shown normally. Under Unix the flag @c wxEXEC_MAKE_GROUP_LEADER may be used to ensure that the new process is a group leader (this will create a new session if - needed). Calling wxKill passing wxKILL_CHILDREN will + needed). Calling wxKill() passing wxKILL_CHILDREN will kill this process as well as all of its children (except those which have started their own session). The @c wxEXEC_NOEVENTS flag prevents processing of any events from taking @@ -506,7 +507,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); @param callback An optional pointer to wxProcess - @see wxShell, wxProcess, @ref overview_sampleexec "Exec sample". + @see wxShell(), wxProcess, @ref overview_sampleexec "Exec sample". */ long wxExecute(const wxString& command, int sync = wxEXEC_ASYNC, wxProcess* callback = NULL); @@ -610,8 +611,8 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); wxMouseState wxGetMouseState(); /** - Returns @true if between two wxBeginBusyCursor and - wxEndBusyCursor calls. + Returns @true if between two wxBeginBusyCursor() and + wxEndBusyCursor() calls. See also wxBusyCursor. */ bool wxIsBusy(); @@ -619,8 +620,8 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); //@{ /** Copies the user's email address into the supplied buffer, by - concatenating the values returned by wxGetFullHostName - and wxGetUserId. + concatenating the values returned by wxGetFullHostName() + and wxGetUserId(). Returns @true if successful, @false otherwise. */ wxString wxGetEmailAddress(); @@ -637,7 +638,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); to @e value. Returns @true on success. - @see wxUnsetEnv + @see wxUnsetEnv() */ bool wxSetEnv(const wxString& var, const wxString& value); @@ -658,7 +659,7 @@ void wxInfoMessageBox(wxWindow ( parent = NULL); windows from this point on. Setting the display within an application allows multiple displays to be used. - See also wxGetDisplayName. + See also wxGetDisplayName(). */ void wxSetDisplayName(const wxString& displayName); diff --git a/interface/valgen.h b/interface/valgen.h index 4813c517e7..3281bb3626 100644 --- a/interface/valgen.h +++ b/interface/valgen.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: valgen.h -// Purpose: documentation for wxGenericValidator class +// Purpose: interface of wxGenericValidator // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -29,8 +29,7 @@ @library{wxcore} @category{validator} - @seealso - @ref overview_validatoroverview "Validator overview", wxValidator, + @see @ref overview_validatoroverview "Validator overview", wxValidator, wxTextValidator */ class wxGenericValidator : public wxValidator @@ -77,3 +76,4 @@ public: */ virtual bool TransferToWindow(); }; + diff --git a/interface/validate.h b/interface/validate.h index 19c5921b36..ad1376d864 100644 --- a/interface/validate.h +++ b/interface/validate.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: validate.h -// Purpose: documentation for wxValidator class +// Purpose: interface of wxValidator // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -34,8 +34,7 @@ @library{wxcore} @category{validator} - @seealso - @ref overview_validatoroverview "Validator overview", wxTextValidator, + @see @ref overview_validatoroverview "Validator overview", wxTextValidator, wxGenericValidator, */ class wxValidator : public wxEvtHandler @@ -99,3 +98,4 @@ public: */ virtual bool Validate(wxWindow* parent); }; + diff --git a/interface/valtext.h b/interface/valtext.h index 77c0120e5b..27cdb087c8 100644 --- a/interface/valtext.h +++ b/interface/valtext.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: valtext.h -// Purpose: documentation for wxTextValidator class +// Purpose: interface of wxTextValidator // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -19,8 +19,7 @@ @library{wxcore} @category{validator} - @seealso - @ref overview_validatoroverview "Validator overview", wxValidator, + @see @ref overview_validatoroverview "Validator overview", wxValidator, wxGenericValidator */ class wxTextValidator : public wxValidator @@ -211,3 +210,4 @@ public: */ virtual bool Validate(wxWindow* parent); }; + diff --git a/interface/variant.h b/interface/variant.h index 31748972ac..0e475b6210 100644 --- a/interface/variant.h +++ b/interface/variant.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: variant.h -// Purpose: documentation for wxVariant class +// Purpose: interface of wxVariant // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -99,8 +99,7 @@ @library{wxbase} @category{data} - @seealso - wxVariantData + @see wxVariantData */ class wxVariant : public wxObject { @@ -405,6 +404,7 @@ public: }; + /** @class wxVariantData @wxheader{variant.h} @@ -430,8 +430,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxVariant + @see wxVariant */ class wxVariantData { @@ -503,3 +502,4 @@ public: */ classname* wxGetVariantCast(); }; + diff --git a/interface/vector.h b/interface/vector.h index 2476ab8c40..a32f018b73 100644 --- a/interface/vector.h +++ b/interface/vector.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: vector.h -// Purpose: documentation for wxVector class +// Purpose: interface of wxVector // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,8 +21,7 @@ @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxcontaineroverview, wxListT, wxArrayT + @see @ref overview_wxcontaineroverview, wxListT(), wxArrayT() */ class wxVector { @@ -143,3 +142,4 @@ public: */ void reserve(size_type n); }; + diff --git a/interface/vlbox.h b/interface/vlbox.h index 40f7561267..075b27c9e8 100644 --- a/interface/vlbox.h +++ b/interface/vlbox.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: vlbox.h -// Purpose: documentation for wxVListBox class +// Purpose: interface of wxVListBox // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -34,8 +34,7 @@ @category{ctrl} @appearance{vlistbox.png} - @seealso - wxSimpleHtmlListBox, wxHtmlListBox + @see wxSimpleHtmlListBox, wxHtmlListBox */ class wxVListBox : public wxVScrolledWindow { @@ -282,3 +281,4 @@ public: */ void Toggle(size_t item); }; + diff --git a/interface/vscroll.h b/interface/vscroll.h index 702d2cb485..a9f91fcc54 100644 --- a/interface/vscroll.h +++ b/interface/vscroll.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: vscroll.h -// Purpose: documentation for wxVarHScrollHelper class +// Purpose: interface of wxVarHScrollHelper // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -22,8 +22,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow + @see wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow */ class wxVarHScrollHelper : public wxVarScrollHelperBase { @@ -135,6 +134,7 @@ public: }; + /** @class wxVarVScrollHelper @wxheader{vscroll.h} @@ -151,8 +151,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow + @see wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow */ class wxVarVScrollHelper : public wxVarScrollHelperBase { @@ -260,6 +259,7 @@ public: }; + /** @class wxVarScrollHelperBase @wxheader{vscroll.h} @@ -279,8 +279,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow + @see wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow */ class wxVarScrollHelperBase { @@ -441,6 +440,7 @@ public: }; + /** @class wxVScrolledWindow @wxheader{vscroll.h} @@ -472,8 +472,7 @@ public: @library{wxcore} @category{miscwnd} - @seealso - wxHScrolledWindow, wxHVScrolledWindow + @see wxHScrolledWindow, wxHVScrolledWindow */ class wxVScrolledWindow : public wxPanel { @@ -555,6 +554,7 @@ public: }; + /** @class wxHVScrolledWindow @wxheader{vscroll.h} @@ -586,8 +586,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxHScrolledWindow, wxVScrolledWindow + @see wxHScrolledWindow, wxVScrolledWindow */ class wxHVScrolledWindow : public wxPanel { @@ -637,6 +636,7 @@ public: }; + /** @class wxVarHVScrollHelper @wxheader{vscroll.h} @@ -660,8 +660,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow + @see wxHScrolledWindow, wxHVScrolledWindow, wxVScrolledWindow */ class wxVarHVScrollHelper : public wxVarVScrollHelper { @@ -774,6 +773,7 @@ public: }; + /** @class wxHScrolledWindow @wxheader{vscroll.h} @@ -804,8 +804,7 @@ public: @library{wxcore} @category{FIXME} - @seealso - wxHVScrolledWindow, wxVScrolledWindow + @see wxHVScrolledWindow, wxVScrolledWindow */ class wxHScrolledWindow : public wxPanel { @@ -852,3 +851,4 @@ public: long style = 0, const wxString& name = wxPanelNameStr); }; + diff --git a/interface/weakref.h b/interface/weakref.h index d5ab880924..c72bd896e4 100644 --- a/interface/weakref.h +++ b/interface/weakref.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: weakref.h -// Purpose: documentation for wxWeakRefDynamic class +// Purpose: interface of wxWeakRefDynamic // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -38,6 +38,7 @@ public: }; + /** @class wxWeakRefT @wxheader{weakref.h} @@ -58,8 +59,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxSharedPtr, wxScopedPtr + @see wxSharedPtr, wxScopedPtr */ class wxWeakRef { @@ -121,3 +121,4 @@ public: */ T* operator=(T* pobj); }; + diff --git a/interface/wfstream.h b/interface/wfstream.h index 24ae931e43..62c1399238 100644 --- a/interface/wfstream.h +++ b/interface/wfstream.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wfstream.h -// Purpose: documentation for wxTempFileOutputStream class +// Purpose: interface of wxTempFileOutputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -17,8 +17,7 @@ @library{wxbase} @category{streams} - @seealso - wxTempFile + @see wxTempFile */ class wxTempFileOutputStream : public wxOutputStream { @@ -50,6 +49,7 @@ public: }; + /** @class wxFFileOutputStream @wxheader{wfstream.h} @@ -66,8 +66,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream + @see wxBufferedOutputStream, wxFFileInputStream, wxFileInputStream */ class wxFFileOutputStream : public wxOutputStream { @@ -94,6 +93,7 @@ public: }; + /** @class wxFileOutputStream @wxheader{wfstream.h} @@ -110,8 +110,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream + @see wxBufferedOutputStream, wxFileInputStream, wxFFileInputStream */ class wxFileOutputStream : public wxOutputStream { @@ -137,6 +136,7 @@ public: }; + /** @class wxFileInputStream @wxheader{wfstream.h} @@ -153,8 +153,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxBufferedInputStream, wxFileOutputStream, wxFFileOutputStream + @see wxBufferedInputStream, wxFileOutputStream, wxFFileOutputStream */ class wxFileInputStream : public wxInputStream { @@ -180,6 +179,7 @@ public: }; + /** @class wxFFileInputStream @wxheader{wfstream.h} @@ -196,8 +196,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxBufferedInputStream, wxFFileOutputStream, wxFileOutputStream + @see wxBufferedInputStream, wxFFileOutputStream, wxFileOutputStream */ class wxFFileInputStream : public wxInputStream { @@ -225,6 +224,7 @@ public: }; + /** @class wxFFileStream @wxheader{wfstream.h} @@ -233,8 +233,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxStreamBuffer + @see wxStreamBuffer */ class wxFFileStream : public wxFFileOutputStream { @@ -247,6 +246,7 @@ public: }; + /** @class wxFileStream @wxheader{wfstream.h} @@ -255,8 +255,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - wxStreamBuffer + @see wxStreamBuffer */ class wxFileStream : public wxFileOutputStream { @@ -267,3 +266,4 @@ public: */ wxFileStream(const wxString& iofileName); }; + diff --git a/interface/window.h b/interface/window.h index 9cb9d949d3..5a8b795514 100644 --- a/interface/window.h +++ b/interface/window.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: window.h -// Purpose: documentation for wxWindow class +// Purpose: interface of wxWindow // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -129,9 +129,8 @@ @library{wxcore} @category{FIXME} - @seealso - @ref overview_eventhandlingoverview, @ref overview_windowsizingoverview "Window - sizing overview" + @see @ref overview_eventhandlingoverview, @ref overview_windowsizingoverview + "Window sizing overview" */ class wxWindow : public wxEvtHandler { @@ -212,7 +211,8 @@ public: /** Call this function to force one or both scrollbars to be always shown, even if the window is big enough to show its entire contents without scrolling. - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} @param hflag Whether the horizontal scroll bar should always be visible. @@ -640,7 +640,7 @@ public: static wxWindow* GetCapture(); /** - Returns the caret associated with the window. + Returns the caret() associated with the window. */ wxCaret* GetCaret() const; @@ -905,7 +905,8 @@ public: /** Returns the next window after this one among the parent children or @NULL if this window is the last child. - This function is new since wxWidgets version 2.8.8 + + @wxsince{2.8.8} @see GetPrevSibling() */ @@ -961,7 +962,8 @@ public: Returns the previous window before this one among the parent children or @c @NULL if this window is the first child. - This function is new since wxWidgets version 2.8.8 + + @wxsince{2.8.8} @see GetNextSibling() */ @@ -1213,7 +1215,8 @@ public: The parameters of this function are the same as for ShowWithEffect(), please see their description there. - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} */ virtual bool HideWithEffect(wxShowEffect effect, unsigned timeout = 0, @@ -1455,7 +1458,7 @@ public: /** Create a new ID or range of IDs that are not currently in use. The - IDs will be reserved until assigned to a wxWindowIDRef + IDs will be reserved until assigned to a wxWindowIDRef() or unreserved with UnreserveControlId(). See @ref overview_windowidsoverview "Window IDs overview" for more information. @@ -1802,7 +1805,7 @@ public: virtual void SetCanFocus(bool canFocus); /** - Sets the caret associated with the window. + Sets the caret() associated with the window. */ void SetCaret(wxCaret* caret) const; @@ -2430,7 +2433,8 @@ public: for the current platform is used. Currently this function is only implemented in wxMSW and does the same thing as Show() in the other ports. - This function is new since wxWidgets version 2.9.0 + + @wxsince{2.9.0} @see HideWithEffect() */ @@ -2526,7 +2530,7 @@ public: virtual void Update(); /** - This function sends wxUpdateUIEvents to + This function sends wxUpdateUIEvents() to the window. The particular implementation depends on the window; for example a wxToolBar will send an update UI event for each toolbar button, and a wxFrame will send an update UI event for each menubar menu item. @@ -2577,6 +2581,7 @@ public: }; + // ============================================================================ // Global functions/macros // ============================================================================ diff --git a/interface/windowid.h b/interface/windowid.h index bd88ca5e90..b93aa87a29 100644 --- a/interface/windowid.h +++ b/interface/windowid.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: windowid.h -// Purpose: documentation for wxIdManager class +// Purpose: interface of wxIdManager // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -18,8 +18,7 @@ @library{wxcore} @category{FIXME} - @seealso - wxWindow::NewControlId, wxWindow::UnreserveControlId, @ref + @see wxWindow::NewControlId, wxWindow::UnreserveControlId, @ref overview_windowidsoverview "Window IDs overview" */ class wxIdManager @@ -28,9 +27,9 @@ public: /** Called directly by wxWindow::NewControlId, this function will create a new ID or range of IDs. The IDs will be - reserved until assigned to a wxWindowIDRef + reserved until assigned to a wxWindowIDRef() or unreserved with UnreserveControlId(). - Only ID values that are not assigned to a wxWindowIDRef + Only ID values that are not assigned to a wxWindowIDRef() need to be unreserved. @param count @@ -40,3 +39,4 @@ public: */ static wxWindowID ReserveControlId(int count = 1); }; + diff --git a/interface/wizard.h b/interface/wizard.h index ab869ad39d..7a40bd15fe 100644 --- a/interface/wizard.h +++ b/interface/wizard.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wizard.h -// Purpose: documentation for wxWizardPage class +// Purpose: interface of wxWizardPage // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxadv} @category{miscwnd} - @seealso - wxWizard, @ref overview_samplewizard "wxWizard sample" + @see wxWizard, @ref overview_samplewizard "wxWizard sample" */ class wxWizardPage : public wxPanel { @@ -77,19 +76,19 @@ public: }; + /** @class wxWizardEvent @wxheader{wizard.h} wxWizardEvent class represents an event generated by the - wizard: this event is first sent to the page itself and, + wizard(): this event is first sent to the page itself and, if not processed there, goes up the window hierarchy as usual. @library{wxadv} @category{events} - @seealso - wxWizard, @ref overview_samplewizard "wxWizard sample" + @see wxWizard, @ref overview_samplewizard "wxWizard sample" */ class wxWizardEvent : public wxNotifyEvent { @@ -118,6 +117,7 @@ public: }; + /** @class wxWizardPageSimple @wxheader{wizard.h} @@ -134,8 +134,7 @@ public: @library{wxadv} @category{miscwnd} - @seealso - wxWizard, @ref overview_samplewizard "wxWizard sample" + @see wxWizard, @ref overview_samplewizard "wxWizard sample" */ class wxWizardPageSimple : public wxWizardPage { @@ -169,6 +168,7 @@ public: }; + /** @class wxWizard @wxheader{wizard.h} @@ -207,8 +207,7 @@ public: @library{wxadv} @category{cmndlg} - @seealso - wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample" + @see wxWizardEvent, wxWizardPage, @ref overview_samplewizard "wxWizard sample" */ class wxWizard : public wxDialog { @@ -471,3 +470,4 @@ public: */ void SetPageSize(const wxSize& sizePage); }; + diff --git a/interface/wrapsizer.h b/interface/wrapsizer.h index 53ed82cfa7..3109e8cd6e 100644 --- a/interface/wrapsizer.h +++ b/interface/wrapsizer.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wrapsizer.h -// Purpose: documentation for wxWrapSizer class +// Purpose: interface of wxWrapSizer // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,8 +21,7 @@ @library{wxcore} @category{winlayout} - @seealso - wxBoxSizer, wxSizer, @ref overview_sizeroverview "Sizer overview" + @see wxBoxSizer, wxSizer, @ref overview_sizeroverview "Sizer overview" */ class wxWrapSizer : public wxBoxSizer { @@ -45,3 +44,4 @@ public: bool InformFirstDirection(int direction, int size, int availableOtherDir); }; + diff --git a/interface/wupdlock.h b/interface/wupdlock.h index ffd5b419fe..525a9a09f6 100644 --- a/interface/wupdlock.h +++ b/interface/wupdlock.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wupdlock.h -// Purpose: documentation for wxWindowUpdateLocker class +// Purpose: interface of wxWindowUpdateLocker // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -50,3 +50,4 @@ public: */ ~wxWindowUpdateLocker(); }; + diff --git a/interface/wxcrt.h b/interface/wxcrt.h index 6d3a32a691..f51ad2243b 100644 --- a/interface/wxcrt.h +++ b/interface/wxcrt.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: wxcrt.h -// Purpose: documentation for global functions +// Purpose: interface of global functions // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -43,7 +43,7 @@ bool wxStringMatch(const wxString& s1, const wxString& s2, Returns the number of characters copied to the buffer or -1 if there is not enough space. - @see wxVsnprintf, wxString::Printf + @see wxVsnprintf(), wxString::Printf */ int wxSnprintf(wxChar* buf, size_t len, const wxChar* format, ...); @@ -68,7 +68,7 @@ wxArrayString wxStringTokenize(const wxString& str, size_t wxStrlen(const char* p); /** - The same as wxSnprintf but takes a @c va_list + The same as wxSnprintf() but takes a @c va_list argument instead of arbitrary number of parameters. Note that if @c wxUSE_PRINTF_POS_PARAMS is set to 1, then this function supports positional arguments (see wxString::Printf for more information). @@ -78,7 +78,7 @@ size_t wxStrlen(const char* p); parameters even when @c wxUSE_PRINTF_POS_PARAMS is 1. - @see wxSnprintf, wxString::PrintfV + @see wxSnprintf(), wxString::PrintfV */ int wxVsnprintf(wxChar* buf, size_t len, const wxChar* format, va_list argPtr); diff --git a/interface/xml/xml.h b/interface/xml/xml.h index a507cb6456..56305fd749 100644 --- a/interface/xml/xml.h +++ b/interface/xml/xml.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: xml/xml.h -// Purpose: documentation for wxXmlNode class +// Purpose: interface of wxXmlNode // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -24,8 +24,7 @@ @library{wxxml} @category{xml} - @seealso - wxXmlDocument, wxXmlAttribute + @see wxXmlDocument, wxXmlAttribute */ class wxXmlNode { @@ -236,6 +235,7 @@ public: }; + /** @class wxXmlAttribute @headerfile xml.h wx/xml/xml.h @@ -248,8 +248,7 @@ public: @library{wxxml} @category{xml} - @seealso - wxXmlDocument, wxXmlNode + @see wxXmlDocument, wxXmlNode */ class wxXmlAttribute { @@ -301,6 +300,7 @@ public: }; + /** @class wxXmlDocument @headerfile xml.h wx/xml/xml.h @@ -376,8 +376,7 @@ public: @library{wxxml} @category{xml} - @seealso - wxXmlNode, wxXmlAttribute + @see wxXmlNode, wxXmlAttribute */ class wxXmlDocument : public wxObject { @@ -484,3 +483,4 @@ public: */ wxXmlDocument& operator operator=(const wxXmlDocument& doc); }; + diff --git a/interface/xrc/xmlres.h b/interface/xrc/xmlres.h index ed3460945e..d1d2765684 100644 --- a/interface/xrc/xmlres.h +++ b/interface/xrc/xmlres.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: xrc/xmlres.h -// Purpose: documentation for wxXmlResource class +// Purpose: interface of wxXmlResource // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -112,7 +112,7 @@ public: resource. If an unknown @a str_id is requested (i.e. other than wxID_XXX or integer), a new record is created which associates the given string with a number. If @a value_if_not_found is @c wxID_NONE, the number is obtained via - wxNewId. Otherwise @a value_if_not_found is used. + wxNewId(). Otherwise @a value_if_not_found is used. Macro @c XRCID(name) is provided for convenient use in event tables. */ #define int GetXRCID(const wxString& str_id, int value_if_not_found = -2) /* implementation is private */ @@ -231,6 +231,7 @@ public: }; + /** @class wxXmlResourceHandler @headerfile xmlres.h wx/xrc/xmlres.h @@ -309,7 +310,7 @@ public: /** ) - Creates a animation from the filename specified in @e param. + Creates a animation() from the filename specified in @e param. */ wxAnimation GetAnimation(); @@ -432,3 +433,4 @@ public: */ void SetupWindow(wxWindow* wnd); }; + diff --git a/interface/zipstrm.h b/interface/zipstrm.h index 77de1f552f..db06ccb07c 100644 --- a/interface/zipstrm.h +++ b/interface/zipstrm.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: zipstrm.h -// Purpose: documentation for wxZipNotifier class +// Purpose: interface of wxZipNotifier // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -25,8 +25,7 @@ @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarcnoseek "Archives on non-seekable streams", wxZipEntry, + @see @ref overview_wxarcnoseek "Archives on non-seekable streams", wxZipEntry, wxZipInputStream, wxZipOutputStream */ class wxZipNotifier @@ -40,6 +39,7 @@ public: }; + /** @class wxZipEntry @wxheader{zipstrm.h} @@ -49,8 +49,7 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarc "Archive formats such as zip", wxZipInputStream, + @see @ref overview_wxarc "Archive formats such as zip", wxZipInputStream, wxZipOutputStream, wxZipNotifier */ class wxZipEntry : public wxArchiveEntry @@ -204,7 +203,7 @@ public: //@{ /** - Sets the notifier for this entry. + Sets the notifier() for this entry. Whenever the wxZipInputStream updates this entry, it will then invoke the associated notifier's wxZipNotifier::OnEntryUpdated @@ -226,6 +225,7 @@ public: }; + /** @class wxZipInputStream @wxheader{zipstrm.h} @@ -245,8 +245,8 @@ public: @library{wxbase} @category{streams} - @seealso - @ref overview_wxarc "Archive formats such as zip", wxZipEntry, wxZipOutputStream + @see @ref overview_wxarc "Archive formats such as zip", wxZipEntry, + wxZipOutputStream */ class wxZipInputStream : public wxArchiveInputStream { @@ -305,6 +305,7 @@ public: }; + /** @class wxZipClassFactory @wxheader{zipstrm.h} @@ -315,9 +316,8 @@ public: @library{wxbase} @category{FIXME} - @seealso - @ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric - "Generic archive programming", wxZipEntry, wxZipInputStream, wxZipOutputStream + @see @ref overview_wxarc "Archive formats such as zip", @ref + overview_wxarcgeneric "Generic archive programming", wxZipEntry, wxZipInputStream, wxZipOutputStream */ class wxZipClassFactory : public wxArchiveClassFactory { @@ -326,6 +326,7 @@ public: }; + /** @class wxZipOutputStream @wxheader{zipstrm.h} @@ -340,8 +341,8 @@ public: @library{wxbase} @category{streams} - @seealso - @ref overview_wxarc "Archive formats such as zip", wxZipEntry, wxZipInputStream + @see @ref overview_wxarc "Archive formats such as zip", wxZipEntry, + wxZipInputStream */ class wxZipOutputStream : public wxArchiveOutputStream { @@ -438,3 +439,4 @@ public: */ void SetComment(const wxString& comment); }; + diff --git a/interface/zstream.h b/interface/zstream.h index 6b7937c375..205c6bcc14 100644 --- a/interface/zstream.h +++ b/interface/zstream.h @@ -1,6 +1,6 @@ ///////////////////////////////////////////////////////////////////////////// // Name: zstream.h -// Purpose: documentation for wxZlibOutputStream class +// Purpose: interface of wxZlibOutputStream // Author: wxWidgets team // RCS-ID: $Id$ // Licence: wxWindows license @@ -21,8 +21,7 @@ @library{wxbase} @category{streams} - @seealso - wxOutputStream, wxZlibInputStream + @see wxOutputStream, wxZlibInputStream */ class wxZlibOutputStream : public wxFilterOutputStream { @@ -56,6 +55,7 @@ public: }; + /** @class wxZlibInputStream @wxheader{zstream.h} @@ -71,8 +71,7 @@ public: @library{wxbase} @category{streams} - @seealso - wxInputStream, wxZlibOutputStream. + @see wxInputStream, wxZlibOutputStream. */ class wxZlibInputStream : public wxFilterInputStream { @@ -105,3 +104,4 @@ public: */ static bool CanHandleGZip(); }; + -- 2.45.2