Amebis/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Replaced /*! with /** in remaining Doxygen headers, and removed intentation of overviews [a-c].

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52448 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Bryan Petty
2008-03-12 08:50:42 +00:00
parent b890136bc6
commit 880efa2a13
76 changed files with 761 additions and 755 deletions
Download Patch File Download Diff File Expand all files Collapse all files

48
docs/doxygen/overviews/bufferclasses.h
View File

@@ -6,44 +6,44 @@
// Licence: wxWindows license
/////////////////////////////////////////////////////////////////////////////
/*!
/**
@page overview_bufferclasses Buffer classes overview
@page overview_bufferclasses Buffer Classes
wxWidgets uses two classes of classes for dealing with buffers in memory.
wxWidgets uses two classes of classes for dealing with buffers in memory.
The first is one for dealing with character buffers, namely wxCharBuffer
for char pointer or multi-byte c strings and wxWCharBuffer for wchar_t pointer
or wide character c strings.
The first is one for dealing with character buffers, namely wxCharBuffer for
char pointer or multi-byte c strings and wxWCharBuffer for wchar_t pointer or
wide character c strings.
Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer
for dealing with raw buffers in memory.
Secondly, wxWidgets uses, although only rarely currently, wxMemoryBuffer for
dealing with raw buffers in memory.
@li @ref overview_bufferclasses_xcb
@li @ref overview_bufferclasses_xcb
<hr>
<hr>
@section overview_bufferclasses_xcb wxXCharBuffer Overview
@section overview_bufferclasses_xcb wxXCharBuffer
@subsection overview_bufferclasses_xcb_general General Usage
@subsection overview_bufferclasses_xcb_general General Usage
As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal
with c strings in memory. They have two constructors, one in which you pass
the c string you want them to have a copy of, and another where you specify
the size of the buffer in memory in characters you want.
As mentioned, wxCharBuffer and its wide character variant wxWCharBuffer deal
with c strings in memory. They have two constructors, one in which you pass
the c string you want them to have a copy of, and another where you specify the
size of the buffer in memory in characters you want.
wxCharBuffer and its variant only contain the c string as a member, so they
can be used safely to c functions with variable arguments such as printf.
They also contain standard assignment, character access operators and a copy constructor.
wxCharBuffer and its variant only contain the c string as a member, so they can
be used safely to c functions with variable arguments such as printf. They also
contain standard assignment, character access operators and a copy constructor.
@subsection overview_bufferclasses_xcb_destruct Destruction
@subsection overview_bufferclasses_xcb_destruct Destruction
It should be noted that on destruction wxCharBuffer and its wide character
variant delete the c string that hold onto. If you want to get the pointer
to the buffer and don't want wxCharBuffer to delete it on destruction,
use the member function release to do so.
It should be noted that on destruction wxCharBuffer and its wide character
variant delete the c string that hold onto. If you want to get the pointer to
the buffer and don't want wxCharBuffer to delete it on destruction, use the
member function release to do so.
*/