regenerated headers to remove @seealso in favour of @see; fixed links to global funct...

[wxWidgets.git] / interface / tarstrm.h

diff --git a/interface/tarstrm.h b/interface/tarstrm.h
index 8ee3d5d9f3ac93e06fe5efddef0bc8d5aacb700b..831884ec0216b8dd86cce0e874ef2b87f2be7332 100644 (file)
--- a/interface/tarstrm.h
+++ b/interface/tarstrm.h
@@ -1,6 +1,6 @@
 /////////////////////////////////////////////////////////////////////////////
 // Name:        tarstrm.h
-// Purpose:     documentation for wxTarInputStream class
+// Purpose:     interface of wxTarInputStream
 // Author:      wxWidgets team
 // RCS-ID:      $Id$
 // Licence:     wxWindows license
@@ -26,8 +26,7 @@
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    @ref overview_wxarcbyname "Looking up an archive entry by name"
+    @see @ref overview_wxarcbyname "Looking up an archive entry by name"
 */
 class wxTarInputStream : public wxArchiveInputStream
 {
@@ -70,6 +69,7 @@ public:
 };
 
 
+
 /**
     @class wxTarClassFactory
     @wxheader{tarstrm.h}
@@ -80,9 +80,8 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    @ref overview_wxarc "Archive formats such as zip", @ref overview_wxarcgeneric
-    "Generic archive programming", wxTarEntry, wxTarInputStream, wxTarOutputStream
+    @see @ref overview_wxarc "Archive formats such as zip", @ref
+    overview_wxarcgeneric "Generic archive programming", wxTarEntry, wxTarInputStream, wxTarOutputStream
 */
 class wxTarClassFactory : public wxArchiveClassFactory
 {
@@ -91,6 +90,7 @@ public:
 };
 
 
+
 /**
     @class wxTarOutputStream
     @wxheader{tarstrm.h}
@@ -105,8 +105,8 @@ public:
     @library{wxbase}
     @category{streams}
 
-    @seealso
-    @ref overview_wxarc "Archive formats such as zip", wxTarEntry, wxTarInputStream
+    @see @ref overview_wxarc "Archive formats such as zip", wxTarEntry,
+    wxTarInputStream
 */
 class wxTarOutputStream : public wxArchiveOutputStream
 {
@@ -184,7 +184,7 @@ public:
         specified in the POSIX standards.
     */
     int GetBlockingFactor();
-    void SetBlockingFactor(int factor);
+    const void SetBlockingFactor(int factor);
     //@}
 
     /**
@@ -209,6 +209,7 @@ public:
 };
 
 
+
 /**
     @class wxTarEntry
     @wxheader{tarstrm.h}
@@ -218,8 +219,7 @@ public:
     @library{wxbase}
     @category{FIXME}
 
-    @seealso
-    @ref overview_wxarc "Archive formats such as zip", wxTarInputStream,
+    @see @ref overview_wxarc "Archive formats such as zip", wxTarInputStream,
     wxTarOutputStream
 */
 class wxTarEntry : public wxArchiveEntry
@@ -239,7 +239,7 @@ public:
          wxArchiveEntry::Get/SetDateTime.
     */
     wxDateTime GetAccessTime();
-    void SetAccessTime(const wxDateTime& dt);
+    const void SetAccessTime(const wxDateTime& dt);
     //@}
 
     //@{
@@ -248,7 +248,7 @@ public:
          wxArchiveEntry::Get/SetDateTime.
     */
     wxDateTime GetCreateTime();
-    void SetCreateTime(const wxDateTime& dt);
+    const void SetCreateTime(const wxDateTime& dt);
     //@}
 
     //@{
@@ -258,8 +258,8 @@ public:
          or @e wxTAR_BLKTYPE.
     */
     int GetDevMajor();
-    int GetDevMinor();
-    void SetDevMajor(int dev);
+    const int GetDevMinor();
+    const void SetDevMajor(int dev);
     void SetDevMinor(int dev);
     //@}
 
@@ -272,8 +272,8 @@ public:
         Get/SetUserName" can be used instead.
     */
     int GetGroupId();
-    int GetUserId();
-    void SetGroupId(int id);
+    const int GetUserId();
+    const void SetGroupId(int id);
     void SetUserId(int id);
     //@}
 
@@ -283,8 +283,8 @@ public:
         over this entry. These are not present in very old tars.
     */
     wxString GetGroupName();
-    wxString GetUserName();
-    void SetGroupName(const wxString& group);
+    const wxString  GetUserName();
+    const void SetGroupName(const wxString& group);
     void SetUserName(const wxString& user);
     //@}
 
@@ -295,7 +295,7 @@ public:
         to @e wxTAR_LNKTYPE or @e wxTAR_SYMTYPE.
     */
     wxString GetLinkName();
-    void SetLinkName(const wxString& link);
+    const void SetLinkName(const wxString& link);
     //@}
 
     //@{
@@ -305,7 +305,7 @@ public:
         Symbols are defined for them in wx/file.h.
     */
     int GetMode();
-    void SetMode(int mode);
+    const void SetMode(int mode);
     //@}
 
     //@{
@@ -318,8 +318,8 @@ public:
         to seek back and fix the entry's header when the entry is closed, though it is
         still more efficient if the size is given beforehand.
     */
-    void SetSize(wxFileOffset size);
-    wxFileOffset GetSize();
+    void SetSize(wxFileOffset size) const;
+    wxFileOffset GetSize() const;
     //@}
 
     //@{
@@ -330,7 +330,7 @@ public:
         any other values should be treated as @e wxTAR_REGTYPE.
     */
     int GetTypeFlag();
-    void SetTypeFlag(int type);
+    const void SetTypeFlag(int type);
     //@}
 
     //@{
@@ -341,9 +341,9 @@ public:
         (i.e. has a trailing path separator).
     */
     wxString GetInternalName();
-    wxString GetInternalName(const wxString& name,
-                             wxPathFormat format = wxPATH_NATIVE,
-                             bool* pIsDir = NULL);
+    const wxString  GetInternalName(const wxString& name,
+                                    wxPathFormat format = wxPATH_NATIVE,
+                                    bool* pIsDir = NULL);
     //@}
 
     /**
@@ -351,3 +351,4 @@ public:
     */
     wxTarEntry& operator operator=(const wxTarEntry& entry);
 };
+