Jumbo API documentation update

and some API fixed
ColorDialog is now OColorDialog!!! keep the namespace tidy!
ColorPopupMenu is now OColorPopupMenu!!! keep the namespace tidy
ColorDialog TT couldn't break bc we can so make it const QColor&
OTimePicker add some convience methods

more I might have forgot

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
@@ -5,88 +5,122 @@
 
 #include <qpe/timestring.h>
 
 #include "orecurrancewidget.h"
 
 // Global Templates for use in setting up the repeat label...
 const QString strDayTemplate = QObject::tr("Every");
 const QString strYearTemplate = QObject::tr("%1 %2 every ");
 const QString strMonthDateTemplate = QObject::tr("The %1 every ");
 const QString strMonthDayTemplate = QObject::tr("The %1 %1 of every");
 const QString strWeekTemplate = QObject::tr("Every ");
 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();
         break;
     case ORecur::Weekly:
         currInterval = Week;
         setupWeekly();
         int day, buttons;
         for ( day = 0x01, buttons = 0; buttons < 7;
               day = day << 1, buttons++ ) {
             if ( rp.days() & day ) {
                 if ( startWeekOnMonday )
                     fraExtra->setButton( buttons );
                 else {
                     if ( buttons == 7 )
@@ -102,48 +136,53 @@ void ORecurranceWidget::setRecurrence( const ORecur& rp, const QDate& date ) {
         currInterval = Month;
         setupMonthly();
         fraExtra->setButton( 0 );
         slotMonthLabel( 0 );
         break;
     case ORecur::MonthlyDate:
         currInterval = Month;
         setupMonthly();
         fraExtra->setButton( 1 );
         slotMonthLabel( 1 );
         break;
     case ORecur::Yearly:
         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:
                 rpTmp.setType( ORecur::Daily );
                 break;
             case Week:{
                 rpTmp.setType( ORecur::Weekly );
                 int day;
                 int day2 = 0;
                 for ( day = 1; *itExtra; ++itExtra, day = day << 1 ) {
                     if ( (*itExtra)->isOn() ) {
                         if ( startWeekOnMonday )
                             day2 |= day;
                         else {
                             if ( day == 1 )
@@ -159,48 +198,53 @@ ORecur ORecurranceWidget::recurrence()const {
             case Month:
                 if ( cmdExtra1->isOn() )
                     rpTmp.setType( ORecur::MonthlyDay );
                 else if ( cmdExtra2->isOn() )
                     rpTmp.setType( ORecur::MonthlyDate );
                 // figure out the montly day...
                 rpTmp.setPosition(  week( start ) );
                 break;
             case Year:
                 rpTmp.setType( ORecur::Yearly );
                 break;
 	    }
 	    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();
         break;
     case Week:
         setupWeekly();
         slotWeekLabel();
         break;
     case Month:
         setupMonthly();
         cmdExtra2->setOn( TRUE );
         slotMonthLabel( 1 );
         break;
     case Year:
         setupYearly();