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
This commit is contained in:
Francesco Montorsi
2008-03-10 15:24:38 +00:00
parent 3a65144e7c
commit e54c96f187
269 changed files with 2027 additions and 1553 deletions

View File

@@ -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 = '\');