removed @NULL,@true,@false tags from the function prototypes; fixed * and & displacing in the prototypes; changed @param as discussed on wx-dev; use @see instead of @sa; better indentation for @returns,@remarks,@see paragraphs; other misc fixes

git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52407 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-09 12:33:59 +00:00
parent 0aaf0255e4
commit 4cc4bfafe5
256 changed files with 8880 additions and 10701 deletions

View File

@@ -21,10 +21,10 @@ class wxMemoryOutputStream : public wxOutputStream
{
public:
/**
If @e data is @NULL, then it will initialize a new empty buffer which will
If @a data is @NULL, then it will initialize a new empty buffer which will
grow if required.
*/
wxMemoryOutputStream(char * data = @NULL, size_t length = 0);
wxMemoryOutputStream(char* data = NULL, size_t length = 0);
/**
Destructor.
@@ -33,16 +33,16 @@ public:
/**
CopyTo allowed you to transfer data from the internal buffer of
wxMemoryOutputStream to an external buffer. @e len specifies the size of
wxMemoryOutputStream to an external buffer. @a len specifies the size of
the buffer.
*/
size_t CopyTo(char * buffer, size_t len);
size_t CopyTo(char* buffer, size_t len);
/**
Returns the pointer to the stream object used as an internal buffer
for that stream.
*/
wxStreamBuffer * GetOutputStreamBuffer();
wxStreamBuffer* GetOutputStreamBuffer();
};
@@ -64,12 +64,11 @@ public:
/**
Creates a new read-only memory stream, initializing it with the
data from the given input stream @e stream.
The @e len argument specifies the amount of data to read from
The @a len argument specifies the amount of data to read from
the @e stream. Setting it to @e wxInvalidOffset means that
the @e stream is to be read entirely (i.e. till the EOF is reached).
the @a stream is to be read entirely (i.e. till the EOF is reached).
*/
wxMemoryInputStream(const char * data, size_t len);
wxMemoryInputStream(const char* data, size_t len);
wxMemoryInputStream(const wxMemoryOutputStream& stream);
wxMemoryInputStream(wxInputStream& stream,
wxFileOffset len = wxInvalidOffset);
@@ -84,5 +83,5 @@ public:
Returns the pointer to the stream object used as an internal buffer
for that stream.
*/
wxStreamBuffer * GetInputStreamBuffer();
wxStreamBuffer* GetInputStreamBuffer();
};