1 files changed, 45 insertions, 1 deletions

diff --git a/libopie/orecurrancewidget.cpp b/libopie/orecurrancewidget.cpp
index db86184..471249d 100644
--- a/libopie/orecurrancewidget.cpp
+++ b/libopie/orecurrancewidget.cpp
@@ -17,64 +17,98 @@ const QString dayLabel[] = { QObject::tr("Monday"),
                              QObject::tr("Tuesday"),
                              QObject::tr("Wednesday"),
                              QObject::tr("Thursday"),
                              QObject::tr("Friday"),
                              QObject::tr("Saturday"),
                              QObject::tr("Sunday") };
 
 
         static QString numberPlacing( int x );// return the proper word format for
                                         // x (1st, 2nd, etc)
 static int week( const QDate &dt );    // what week in the month is dt?
 
-
+/**
+ * Constructs the Widget
+ * @param startOnMonday Does the week start on monday
+ * @param newStart The start date of the recurrence
+ * @param parent The parent widget
+ * @param name the name of object
+ * @param modal if the dialog should be modal
+ * @param fl Additional window flags
+ */
 ORecurranceWidget::ORecurranceWidget( bool startOnMonday,
                                       const QDate& newStart,
                                       QWidget* parent,
                                       const char* name,
                                       bool modal,
                                       WFlags fl )
     : ORecurranceBase( parent, name, modal, fl ),
       start( newStart ),
       currInterval( None ),
       startWeekOnMonday( startOnMonday )
 {
     init();
     fraType->setButton( currInterval );
     chkNoEnd->setChecked( TRUE );
     setupNone();
 }
+
+/**
+ * Different constructor
+ * @param startOnMonday Does the week start on monday?
+ * @param rp Already set ORecur object
+ * @param startDate The start date
+ * @param parent The parent widget
+ * @param name The name of the object
+ * @param modal
+ * @param fl The flags for window
+ */
 ORecurranceWidget::ORecurranceWidget( bool startOnMonday,
                                       const ORecur& rp, const QDate& startDate,
                                       QWidget* parent, const char* name,
                                       bool modal, WFlags fl)
     : ORecurranceBase( parent, name, modal, fl ),
       start( startDate ),
       end( rp.endDate() ),
       startWeekOnMonday( startOnMonday )
 {
     // do some stuff with the repeat pattern
     init();
     setRecurrence( rp );
 }
 
 ORecurranceWidget::~ORecurranceWidget() {
 }
+
+/**
+ * set the start date
+ * @param date the new start date
+ */
 void ORecurranceWidget::setStartDate( const QDate& date ) {
     qWarning("ORecurranceWidget::setStartDate");
     setRecurrence( recurrence(), date );
 }
+/**
+ * set the recurrence
+ * @param rp  The ORecur object with the new recurrence rules
+ */
 void ORecurranceWidget::setRecurrence( const ORecur& rp ) {
     setRecurrence( rp, start );
 }
+
+/**
+ * overloaded method taking ORecur and a new start date
+ * @param rp Recurrence rule
+ * @param date The new start date
+ */
 void ORecurranceWidget::setRecurrence( const ORecur& rp, const QDate& date ) {
     start = date;
     end = rp.endDate();
     switch ( rp.type() ) {
     default:
     case ORecur::NoRepeat:
         currInterval = None;
         setupNone();
         break;
     case ORecur::Daily:
         currInterval = Day;
         setupDaily();
@@ -114,24 +148,29 @@ void ORecurranceWidget::setRecurrence( const ORecur& rp, const QDate& date ) {
         currInterval = Year;
         setupYearly();
         break;
     }
     fraType->setButton( currInterval );
     spinFreq->setValue( rp.frequency() );
     if ( !rp.hasEndDate() ) {
         cmdEnd->setText( tr("No End Date") );
         chkNoEnd->setChecked( TRUE );
     } else
         cmdEnd->setText( TimeString::shortDate( end ) );
 }
+
+/**
+ * the user selected recurrence rule.
+ * @return The recurrence rule.
+ */
 ORecur ORecurranceWidget::recurrence()const {
     QListIterator<QToolButton> it( listRTypeButtons );
     QListIterator<QToolButton> itExtra( listExtra );
     ORecur rpTmp;
     int i;
     for ( i = 0; *it; ++it, i++ ) {
         if ( (*it)->isOn() ) {
             switch ( i ) {
             case None:
                 rpTmp.setType( ORecur::NoRepeat );
                 break;
             case Day:
@@ -171,24 +210,29 @@ ORecur ORecurranceWidget::recurrence()const {
             break;  // no need to keep looking!
         }
     }
     rpTmp.setFrequency(spinFreq->value() );
     rpTmp.setHasEndDate( !chkNoEnd->isChecked() );
     if ( rpTmp.hasEndDate() ) {
         rpTmp.setEndDate( end );
     }
     // timestamp it...
 //    rpTmp.setCreateTime(  ); current DateTime is already set -zecke
     return rpTmp;
 }
+
+/**
+ * Return the end date of the recurrence. This is only
+ * valid if the recurrence rule does contain an enddate
+ */
 QDate ORecurranceWidget::endDate()const {
     return end;
 }
 void ORecurranceWidget::slotSetRType(int rtype) {
    // now call the right function based on the type...
     currInterval = static_cast<repeatButtons>(rtype);
     switch ( currInterval ) {
     case None:
         setupNone();
         break;
     case Day:
         setupDaily();