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

interface/txtstrm.h

@@ -58,21 +58,19 @@ class wxTextInputStream
 public:
     /**
         )
-        
         Constructs a text stream associated to the given input stream.
         
         @param stream
-        The underlying input stream.
-        
+            The underlying input stream.
         @param sep
-        The initial string separator characters.
-        
+            The initial string separator characters.
         @param conv
-        In Unicode build only: The encoding converter used to convert the bytes in the
-          underlying input stream to characters.
+            In Unicode build only: The encoding converter used to convert the bytes in
+        the
+              underlying input stream to characters.
     */
     wxTextInputStream(wxInputStream& stream,
-                      const wxString& sep=" \t");
+                      const wxString& sep = " \t");
 
     /**
         Destroys the wxTextInputStream object.
@@ -86,40 +84,35 @@ public:
 
     /**
         Reads a unsigned 16 bit integer from the stream.
-        
         See wxTextInputStream::Read8 for the
-        description of the @e base parameter.
+        description of the @a base parameter.
     */
     wxUint16 Read16(int base = 10);
 
     /**
         Reads a signed 16 bit integer from the stream.
-        
         See wxTextInputStream::Read8 for the
-        description of the @e base parameter.
+        description of the @a base parameter.
     */
     wxInt16 Read16S(int base = 10);
 
     /**
         Reads a 32 bit unsigned integer from the stream.
-        
         See wxTextInputStream::Read8 for the
-        description of the @e base parameter.
+        description of the @a base parameter.
     */
     wxUint32 Read32(int base = 10);
 
     /**
         Reads a 32 bit signed integer from the stream.
-        
         See wxTextInputStream::Read8 for the
-        description of the @e base parameter.
+        description of the @a base parameter.
     */
     wxInt32 Read32S(int base = 10);
 
     /**
         Reads a single unsigned byte from the stream, given in base @e base.
-        
-        The value of @e base must be comprised between 2 and 36, inclusive, or
+        The value of @a base must be comprised between 2 and 36, inclusive, or
         be a special value 0 which means that the usual rules of @c C numbers are
         applied: if the number starts with @c 0x it is considered to be in base
         16, if it starts with @c 0 - in base 8 and in base 10 otherwise. Note
@@ -131,9 +124,8 @@ public:
 
     /**
         Reads a single signed byte from the stream.
-        
         See wxTextInputStream::Read8 for the
-        description of the @e base parameter.
+        description of the @a base parameter.
     */
     wxInt8 Read8S(int base = 10);
 
@@ -151,7 +143,6 @@ public:
     /**
         @b NB: This method is deprecated, use ReadLine()
         or ReadWord() instead.
-        
         Same as ReadLine().
     */
     wxString ReadString();
@@ -160,14 +151,13 @@ public:
         Reads a word (a sequence of characters until the next separator) from the
         input stream.
         
-        @sa SetStringSeparators()
+        @see SetStringSeparators()
     */
     wxString ReadWord();
 
     /**
         Sets the characters which are used to define the word boundaries in
         ReadWord().
-        
         The default separators are the space and @c TAB characters.
     */
     void SetStringSeparators(const wxString& sep);
@@ -203,18 +193,16 @@ class wxTextOutputStream
 public:
     /**
         )
-        
         Constructs a text stream object associated to the given output stream.
         
         @param stream
-        The output stream.
-        
+            The output stream.
         @param mode
-        The end-of-line mode. One of wxEOL_NATIVE, wxEOL_DOS, wxEOL_MAC and wxEOL_UNIX.
-        
+            The end-of-line mode. One of wxEOL_NATIVE, wxEOL_DOS, wxEOL_MAC and
+        wxEOL_UNIX.
         @param conv
-        In Unicode build only: The object used to convert
-        Unicode text into ASCII characters written to the output stream.
+            In Unicode build only: The object used to convert
+            Unicode text into ASCII characters written to the output stream.
     */
     wxTextOutputStream(wxOutputStream& stream,
                        wxEOL mode = wxEOL_NATIVE);
@@ -242,27 +230,27 @@ public:
     void SetMode(wxEOL mode = wxEOL_NATIVE);
 
     /**
-        Writes the 16 bit integer @e i16 to the stream.
+        Writes the 16 bit integer @a i16 to the stream.
     */
     void Write16(wxUint16 i16);
 
     /**
-        Writes the 32 bit integer @e i32 to the stream.
+        Writes the 32 bit integer @a i32 to the stream.
     */
     void Write32(wxUint32 i32);
 
     /**
-        Writes the single byte @e i8 to the stream.
+        Writes the single byte @a i8 to the stream.
     */
     void Write8(wxUint8 i8);
 
     /**
-        Writes the double @e f to the stream using the IEEE format.
+        Writes the double @a f to the stream using the IEEE format.
     */
     virtual void WriteDouble(double f);
 
     /**
-        Writes @e string as a line. Depending on the end-of-line mode the end of
+        Writes @a string as a line. Depending on the end-of-line mode the end of
         line ('\n') characters in the string are converted to the correct
         line ending terminator.
     */