comments should go into the header file

2 files changed, 19 insertions, 13 deletions

diff --git a/libopie2/opiecore/ostorageinfo.cpp b/libopie2/opiecore/ostorageinfo.cpp
index a45fcb6..aa8d2fc 100644
--- a/libopie2/opiecore/ostorageinfo.cpp
+++ b/libopie2/opiecore/ostorageinfo.cpp
@@ -1,92 +1,85 @@
 /*
                              This file is part of the Opie Project
                              Copyright (C) 2004 Andreas 'ar' Richter <ar@oszine.de>
-              =.
+             =.
             .=l.
            .>+-=
  _;:,     .>    :=|.         This program is free software; you can
 .> <`_,   >  .   <=          redistribute it and/or  modify it under
 :`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
 .="- .-=="i,     .._         License as published by the Free Software
  - .   .-<_>     .<>         Foundation; either version 2 of the License,
      ._= =}       :          or (at your option) any later version.
     .%`+i>       _;_.
     .i_,=:_.      -<s.       This program is distributed in the hope that
      +  .  -:.       =       it will be useful,  but WITHOUT ANY WARRANTY;
     : ..    .:,     . . .    without even the implied warranty of
     =_        +     =;=|`    MERCHANTABILITY or FITNESS FOR A
   _.=:.       :    :=>`:     PARTICULAR PURPOSE. See the GNU
 ..}^=.=       =       ;      Library General Public License for more
 ++=   -.     .`     .:       details.
  :     =  ...= . :.=-
  -.   .:....=;==+<;          You should have received a copy of the GNU
   -_. . .   )=.  =           Library General Public License along with
     --        :-=`           this library; see the file COPYING.LIB.
                              If not, write to the Free Software Foundation,
                              Inc., 59 Temple Place - Suite 330,
                              Boston, MA 02111-1307, USA.
 */
 
 #include <opie2/ostorageinfo.h>
 
 OStorageInfo::OStorageInfo( QObject *parent )
         : StorageInfo( parent )
 {
 }
 
 OStorageInfo::~OStorageInfo()
 {
 }
 
 QString OStorageInfo::cfPath()const
 {
     QString r = "";
 
     for (QListIterator<FileSystem> i( fileSystems() ); i.current(); ++i)
     {
         if ( (*i)->disk().left( 8 ) == "/dev/hda"  )
         {
             r = (*i)->path();
             break;
         }
     }
     return r;
 }
 
-/*!
-* @brief returns the Mount-Path of Sd Card
-*
-*/
 QString OStorageInfo::sdPath()const
 {
     QString r = "";
 
     for (QListIterator<FileSystem> i( fileSystems() ); i.current(); ++i)
     {
         if ( (*i)->disk().left( 9 ) == "/dev/mmcd" )
         {
             r = (*i)->path();
             break;
         }
     }
     return r;
 }
 
-/*!
-* @brief returns the Mount-Path of Mmc Card
-*
-*/
 QString OStorageInfo::mmcPath()const
 {
     QString r = "";
 
     for (QListIterator<FileSystem> i( fileSystems() ); i.current(); ++i)
     {
         if ( (*i)->disk().left( 14 ) == "/dev/mmc/part1" )
         {
             r = (*i)->path();
             break;
         }
     }
     return r;
 }
+
diff --git a/libopie2/opiecore/ostorageinfo.h b/libopie2/opiecore/ostorageinfo.h
index 9b61a2e..740fa85 100644
--- a/libopie2/opiecore/ostorageinfo.h
+++ b/libopie2/opiecore/ostorageinfo.h
@@ -1,49 +1,62 @@
 /*
                              This file is part of the Opie Project
                              Copyright (C) 2004 Andreas 'ar' Richter <ar@oszine.de>
               =.
             .=l.
            .>+-=
  _;:,     .>    :=|.         This program is free software; you can
 .> <`_,   >  .   <=          redistribute it and/or  modify it under
 :`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
 .="- .-=="i,     .._         License as published by the Free Software
  - .   .-<_>     .<>         Foundation; either version 2 of the License,
      ._= =}       :          or (at your option) any later version.
     .%`+i>       _;_.
     .i_,=:_.      -<s.       This program is distributed in the hope that
      +  .  -:.       =       it will be useful,  but WITHOUT ANY WARRANTY;
     : ..    .:,     . . .    without even the implied warranty of
     =_        +     =;=|`    MERCHANTABILITY or FITNESS FOR A
   _.=:.       :    :=>`:     PARTICULAR PURPOSE. See the GNU
 ..}^=.=       =       ;      Library General Public License for more
 ++=   -.     .`     .:       details.
  :     =  ...= . :.=-
  -.   .:....=;==+<;          You should have received a copy of the GNU
   -_. . .   )=.  =           Library General Public License along with
     --        :-=`           this library; see the file COPYING.LIB.
                              If not, write to the Free Software Foundation,
                              Inc., 59 Temple Place - Suite 330,
                              Boston, MA 02111-1307, USA.
 */
 
 #ifndef OSTORAGE_H
 #define OSTORAGE_H
 
 #include <qpe/storage.h>
 
 class OStorageInfo : public StorageInfo
 {
   Q_OBJECT
 
   public:
-public:
+
     OStorageInfo( QObject *parent=0 );
     ~OStorageInfo();
 
-    QString cfPath()const;
-    QString sdPath()const;
-    QString mmcPath()const;
+   /**
+    * @returns the mount path of the CF (Compact Flash) card
+    *
+    **/
+    QString cfPath() const;
+   /**
+    * @returns the mount path of the SD (Secure Digital) card
+    *
+    **/
+    QString sdPath() const;
+   /**
+    * @returns the mount path of the MMC (MultiMedia) card
+    *
+    **/
+    QString mmcPath() const;
 };
 
 #endif // OSTORAGE_H
+