small doxygen doc fixes

3 files changed, 5 insertions, 10 deletions

diff --git a/libopie2/opiecore/okeyfilter.cpp b/libopie2/opiecore/okeyfilter.cpp
index a517333..61b7909 100644
--- a/libopie2/opiecore/okeyfilter.cpp
+++ b/libopie2/opiecore/okeyfilter.cpp
@@ -1,148 +1,148 @@
 /*
                             This file is part of the Opie Project
              =.             Copyright (C) 2004 Rajko 'Alwin' Albrecht <alwin@handhelds.org>
            .=l.             Copyright (C) The Opie Team <opie-devel@handhelds.org>
           .>+-=
 _;:,     .>    :=|.         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 "okeyfilter.h"
 #include "device/odevice.h"
 #include "odebug.h"
 
 namespace Opie {
 namespace Core {
 
 class OKeyFilterPrivate:public OKeyFilter, QWSServer::KeyboardFilter
 {
     static QValueList<QWSServer::KeyboardFilter*> filterList;
     static QValueList<QWSServer::KeyboardFilter*> preFilterList;
 protected:
     OKeyFilterPrivate(const OKeyFilterPrivate&):OKeyFilter(),QWSServer::KeyboardFilter(){};
-    virtual void addPreHandler(QWSServer::KeyboardFilter*);
-    virtual void remPreHandler(QWSServer::KeyboardFilter*);
+    virtual void addPreHandler(QWSServer::KeyboardFilter* aFilter);
+    virtual void remPreHandler(QWSServer::KeyboardFilter* aFilter);
 
 public:
     OKeyFilterPrivate();
     virtual ~OKeyFilterPrivate();
     virtual bool filter( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat );
-    virtual void addHandler(QWSServer::KeyboardFilter*);
-    virtual void remHandler(QWSServer::KeyboardFilter*);
+    virtual void addHandler(QWSServer::KeyboardFilter* aFilter);
+    virtual void remHandler(QWSServer::KeyboardFilter* aFilter);
 };
 
 QValueList<QWSServer::KeyboardFilter*> OKeyFilterPrivate::filterList;
 QValueList<QWSServer::KeyboardFilter*> OKeyFilterPrivate::preFilterList;
 
 OKeyFilter::OKeyFilter()
 {
 }
 
 OKeyFilter::~OKeyFilter()
 {
 }
 
 OKeyFilter* OKeyFilter::inst()
 {
     static OKeyFilter*ofilter = 0;
     if (!ofilter) {
         ofilter = new OKeyFilterPrivate;
     }
     return ofilter;
 }
 
 bool OKeyFilterPrivate::filter( int unicode, int keycode, int modifiers, bool isPress, bool autoRepeat )
 {
     QValueList<QWSServer::KeyboardFilter*>::Iterator iter;
     for (iter=preFilterList.begin();iter!=preFilterList.end();++iter) {
         if ((*iter)->filter(unicode,keycode,modifiers,isPress,autoRepeat)) {
             return true;
         }
     }
     for (iter=filterList.begin();iter!=filterList.end();++iter) {
         if ((*iter)->filter(unicode,keycode,modifiers,isPress,autoRepeat)) {
             return true;
         }
     }
     return false;
 }
 
 void OKeyFilterPrivate::addHandler(QWSServer::KeyboardFilter*aF)
 {
     if (!aF) return;
     if (filterList.find(aF)!=filterList.end()) {
         return;
     }
     odebug << "adding a keyboard filter handler"<<oendl;
     filterList.append(aF);
 }
 
 void OKeyFilterPrivate::remHandler(QWSServer::KeyboardFilter*aF)
 {
     if (!aF) return;
     QValueList<QWSServer::KeyboardFilter*>::Iterator iter;
     if ( (iter=filterList.find(aF))==filterList.end() ) {
         return;
     }
     odebug << "removing a keyboard filter handler"<<oendl;
     filterList.remove(iter);
 }
 
 void OKeyFilterPrivate::addPreHandler(QWSServer::KeyboardFilter*aF)
 {
     if (!aF) return;
     if (preFilterList.find(aF)!=preFilterList.end()) {
         return;
     }
     odebug << "adding a preferred keyboard filter handler"<<oendl;
     preFilterList.append(aF);
 }
 
 void OKeyFilterPrivate::remPreHandler(QWSServer::KeyboardFilter*aF)
 {
     if (!aF) return;
     QValueList<QWSServer::KeyboardFilter*>::Iterator iter;
     if ( (iter=preFilterList.find(aF))==preFilterList.end() ) {
         return;
     }
     odebug << "removing a preferred keyboard filter handler"<<oendl;
     preFilterList.remove(iter);
 }
 
 OKeyFilterPrivate::OKeyFilterPrivate()
     :OKeyFilter(),QWSServer::KeyboardFilter()
 {
     filterList.clear();
     preFilterList.clear();
     if ( isQWS( ) ) {
         QWSServer::setKeyboardFilter ( this );
     }
 }
 
 OKeyFilterPrivate::~OKeyFilterPrivate()
 {
 }
 
 /* namespace Core */
 }
 /* namespace Opie */
 }
diff --git a/libopie2/opieui/big-screen/omodalhelper.h b/libopie2/opieui/big-screen/omodalhelper.h
index 096cec4..ed6fee3 100644
--- a/libopie2/opieui/big-screen/omodalhelper.h
+++ b/libopie2/opieui/big-screen/omodalhelper.h
@@ -111,257 +111,257 @@ private:
     virtual void done( int, TransactionID );
     virtual void next( TransactionID );
     virtual void prev( TransactionID );
 
     Record nextRecord( TransactionID &, int & )const;
     Record prevRecord( TransactionID &, int & )const;
     int pos( TransactionID )const;
     Dialog* newDialogRecord( const Record& );
 
 private:
     OModalHelperDialog     *queuedDialog()const; // generate or recycle
     OModalHelperDialog     *m_dialog;
     OModalHelperSignal     *m_signal; // our signal
     OModalHelperControler  *m_controler;
     IdMap                  m_ids; // maps ids (uids) to a record
     IdMap                  m_doneIds;
     TransactionMap         m_transactions; // activate transactions
     TransactionMap         m_done; // done and waiting for getting picked
     DialogMap              m_editing; // only used for New Mode
     enum Mode              m_mode; // the mode we're in
 bool                   m_disabled :1;
 };
 
 
 
 /* ### FIXME use namespace with Qt3 */
 
 /*
  * A note on flow. The Signal is used for QT Signals when
  * a record is done.
  * There is either one controler and this controler slot will
  * be connected to a dialog signal.
  * In Queue we get the next and prev signals and call the Helper.
  * this then changes the Record of the dialog and sets the transactionId
  * of the controler.
  * For the new mode
  *
  */
 
 class OModalHelperSignal : public QObject
 {
     Q_OBJECT
 public:
     OModalHelperSignal(OModalHelperBase* base,  QObject* parent);
     ~OModalHelperSignal();
 
 signals:
     done( int status,  TransactionID transaction );
     accepted( TransactionID transaction );
     rejected( TransactionID transaction );
 
 private:
     OModalHelperBase* m_base;
 };
 
 
 class OModalHelperControler : public QObject
 {
     Q_OBJECT
 public:
     OModalHelperControler( OModalHelperBase* , QObject* parent);
     virtual TransactionID transactionID()const;
     void setTransactionID( TransactionID id );
     QDialog* dialog()const;
 
 public slots:
     virtual void done(int result );
     virtual void next();
     virtual void prev();
 private:
     QDialog *m_dia;
     TransactionID m_id;
     OModalHelperBase *m_base;
 }
 
 struct OModalQueueBar;
 class OModalQueuedDialog : public QDialog
 {
     Q_OBJECT
 public:
     OModalQueuedDialog(QDialog *mainWidget);
     ~OModalQueuedDialog();
 
     QDialog* centerDialog()const;
 
     void setQueueBarEnabled( bool = true );
     void setRecord( int record, int count );
 
 signals:
     void next();
     void prev();
 
 private:
     OModalQueueBar *m_bar;
     QDialog *m_center;
 };
 
 
 /*
  * Tcpp Template Implementation
  */
 
 /**
  * This is the simple Template c'tor. It takes the mode
  * this helper should operate in and the parent object.
  * This helper will be deleted when the parent gets deleted
  * or you delete it yourself.
  *
  * @param mode The mode this dialog should be in
  * @param parent The parent QObject of this helper.
  */
 template<class Dialog, class Record, typename Id>
 OModalHelper<Dialog, Record, Id>::OModalHelper( enum Mode mode, QObject* parent )
 {
     m_disabled = false;
     m_mode = mode;
     m_signal = new OModalHelperSignal( this, parent );
     m_controler = new OModalHelperControler( this, m_signal );
 }
 
 
 /**
  * This functions looks for your record and sees if it is
  * handled with this helper. Note that done records
  * will not be returned.
  *
  * @return true if the record is currenlty edited otherwise false
  *
- * @param Id The id which might be handled
+ * @param id The id which might be handled
  */
 template<class Dialog, class Record, typename Id>
 bool OModalHelper<Dialog, Record, Id>::handles( Id id )const
 {
     if ( m_transactions.isEmpty() )
         return false;
 
     TransactionMap::ConstIterator it = m_transactions.begin();
     for ( ; it != m_transactions.end(); ++it )
         if ( it.data() == id )
             return true;
 
     return false;
 }
 
 
 /**
  * just like handles( Id ) but returns the TransactionId
  */
 template<class Dialog, class Record, typename Id>
 TransactionID OModalHelper<Dialog, Record, Id>::transactionID( Id id)const
 {
     if ( m_transactions.isEmpty() || !m_ids.contains( id ) )
         return 0;
 
     TransactionMap::ConstIterator it = m_transactions.begin();
     for ( ; it != m_transactions.end(); ++it )
         if ( it.data() == id )
             return it.key();
 
     return 0;
 }
 
 /**
  * If you're requested to flush your data and you do not want
  * to call cancel with this method you can disable and enabled
  * all dialogs.
  * The state gets saved so if you want to handle a new record the dialog
  * will be disabled as well.
  *
  * @param sus If true setDisabled(TRUE) will be called otherwise FALSE
  */
 template<class Dialog, class Record, typename Id>
 void OModalHelper<Dialog, Record, Id>::suspend(bool sus)
 {
     m_disabled = sus;
     if (m_mode == New )
         for (DialogMap::Iterator it = m_editing.begin(); it != m_editing.end(); ++it )
             it.key()->setDisabled( sus );
     else if (m_dialog )
         queuedDialog()->setDisabled( sus );
 }
 
 /**
  * Cancel will cancel all current operations and clear the list
  * of done operations as well.
  * This also clears all done operations you did not popped
  */
 template<class Dialog, class Record, typename Id>
 void OModalHelper<Dialog, Record, Id>::cancel()
 {
     m_ids.clear();
     m_doneIds.clear();
     m_done.clear();
     m_transactions.clear();
 
     /* we also need to remove the QDialogs */
     /* and hide the queue dialog if present */
     if (m_mode == New && !m_editing.isEmpty() )
     {
         for (DialogMap::Iterator it = m_editing.begin(); it != m_editing.end(); ++it )
             delete it.key();
 
         m_editing.clear();
     }
     else if (m_dialog )
         queuedDialog()->setRecord( 0, 0 );
 
     m_controler->setTransactionID( 0 );
 }
 
 
 /**
  * This cancels editing of the record behind the Transaction Number
  * Note that if editing is already done it will also be removed from this list
  */
 template<class Dialog, class Record, typename Id>
 void OModalHelper::cancel( TransactionID tid )
 {
     /* wrong tid */
     if (!m_transactions.contains( tid ) && !m_done.contains( tid) )
         return;
 
     if (m_mode == New )
         /* reverse map eek */
         for (DialogMap::Iterator it = m_editing.begin(); it != m_editing.end(); ++it )
             if ( it.data() == tid )
             {
                 it.key()->hide();
                 delete it.key();
                 it = m_editing.remove( it );
                 break;
             }
 
     /* now remove from the various maps  done and currently editing map*/
     if (m_transactions.contains( tid ) )
         m_ids.remove( m_transactions[tid]  );
     if (m_done.contains( tid ) )
         m_doneIds.remove( m_done[tid ]  );
     m_done.remove( tid );
     m_transactions.remove( tid );
 
     next( 0 );
 }
 
 /**
  * Connect to the done Signal. SIGNAL( done(int, TransactionID ) )
  * This signal gets emitted whenever a Record was accepted or rejected
  *
  * @param rec  The object where the slot belongs to
  * @param slot The slot which should be called. See the needed parameter above
  */
 template<class Dialog, class Record, typename Id>
 void OModalHelper<Dialog, Record, Id>::connectDone( QObject* rec, const char* slot )
 {
     QObject::connect(m_signal, SIGNAL(done(int, TransactionID) ),
                      rec, slot );
 }
diff --git a/libopie2/opieui/otabinfo.h b/libopie2/opieui/otabinfo.h
index 426c45a..d6d5abf 100644
--- a/libopie2/opieui/otabinfo.h
+++ b/libopie2/opieui/otabinfo.h
@@ -1,141 +1,136 @@
 /*
                             This file is part of the Opie Project
 
                              Copyright (c)  2002 Dan Williams <williamsdr@acm.org>
               =.
             .=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 OTABINFO_H
 #define OTABINFO_H
 
 /* QT */
 #include <qlist.h>
 #include <qstring.h>
 
 class QWidget;
 
 namespace Opie{
 namespace Ui  {
 
 /**
  * @class OTabInfo
  * @brief The OTabInfo class is used internally by OTabWidget to keep track
  *        of widgets added to the control.
  *
  * OTabInfo provides the following information about a widget added to an
  * OTabWidget control:
  *
  *  ID - integer tab bar ID
  *  Control - QWidget pointer to child widget
  *  Label - QString text label for OTabWidget selection control
  *  Icon - QString name of icon file
  */
 class OTabInfo
 {
 public:
     /**
      * @fn OTabInfo()
      * @brief Object constructor.
-     *
-     * @param parent Pointer to parent of this control.
-     * @param name Name of control.
-     * @param s Style of widget selection control.
-     * @param p Position of the widget selection control.
      */
     OTabInfo() : i( -1 ), c( 0 ), p( 0 ), l( QString::null ) {}
 
     /**
      * @fn OTabInfo( int id, QWidget *control, const QString &icon, const QString &label )
      * @brief Object constructor.
      *
      * @param id TabBar identifier for widget.
      * @param control QWidget pointer to widget.
      * @param icon QString name of icon file.
      * @param label QString text label for OTabWidget selection control.
      */
     OTabInfo( int id, QWidget *control, const QString &icon, const QString &label )
             : i( id ), c( control ), p( icon ), l( label ) {}
 
     /**
      * @fn id()const
      * @brief Returns TabBar ID.
      */
     int            id()      const { return i; }
 
     /**
      * @fn label()const
      * @brief Returns text label for widget.
      */
     const QString &label()   const { return l; }
 
     /**
      * @fn setLabel( const QString &label )
      * @brief Set label for tab.
      *
      * @param label QString text label for OTabWidget selection control.
      */
     void setLabel( const QString &label ) { l = label; }
 
     /**
      * @fn control()const
      * @brief Returns pointer to widget.
      */
     QWidget       *control() const { return c; }
 
     /**
      * @fn icon()const
      * @brief Returns name of icon file.
      */
     const QString &icon()    const { return p; }
 
     /**
      * @fn setIcon( const QString &icon )
      * @brief Set icon for tab.
      *
      * @param icon QString name of icon file.
      */
     void setIcon( const QString &icon ) { p = icon; }
 
 private:
     int      i;
     QWidget *c;
     QString  p;
     QString  l;
     class Private;
     Private *d;
 };
 
 /**
  * @class OTabInfoList
  * @brief A list of OTabInfo objects used by OTabWidget.
  */
 typedef QList<OTabInfo> OTabInfoList;
 
 }
 }
 
 #endif