]> git.saurik.com Git - wxWidgets.git/blobdiff - interface/fs_mem.h
Initial review of various [q-r] by Utensil Candel.
[wxWidgets.git] / interface / fs_mem.h
index ab950988b9c19e83e69d3683140618839c41b489..43c75996d1336bd781e4c1e608214d3020fa2b16 100644 (file)
@@ -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
 {
@@ -78,13 +77,12 @@ public:
         data (bitmap, text or raw data)
         will be copied into private memory stream and available under
         name "memory:" + @e filename.
-        
-        The @e type argument is one of @c wxBITMAP_TYPE_XXX constants.
-        Note that you must use a @e type value (aka image format)
+        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)!
-        
-        @sa AddFileWithMimeType()
+        documentation())!
+
+        @see AddFileWithMimeType()
     */
     static void AddFile(const wxString& filename, wxImage& image,
                         long type);
@@ -98,10 +96,10 @@ 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
-        
-        @sa AddFile()
+
+        @since 2.8.5
+
+        @see AddFile()
     */
     static void AddFileWithMimeType(const wxString& filename,
                                     const wxString& textdata,
@@ -117,3 +115,4 @@ public:
     */
     static void RemoveFile(const wxString& filename);
 };
+