author | zecke <zecke> | 2003-04-16 10:57:59 (UTC) |
---|---|---|
committer | zecke <zecke> | 2003-04-16 10:57:59 (UTC) |
commit | eeb29547890a2d162de66d7d5b98d3840a7e2d79 (patch) (unidiff) | |
tree | 973c6de7aae2fd5ba368efb87fa24234f0e12aa3 | |
parent | dfa2d294b3af09bf3757a3c2294a925093e72fc6 (diff) | |
download | opie-eeb29547890a2d162de66d7d5b98d3840a7e2d79.zip opie-eeb29547890a2d162de66d7d5b98d3840a7e2d79.tar.gz opie-eeb29547890a2d162de66d7d5b98d3840a7e2d79.tar.bz2 |
Fix API docu
-rw-r--r-- | library/applnk.cpp | 16 | ||||
-rw-r--r-- | library/backend/categories.cpp | 5 | ||||
-rw-r--r-- | library/backend/categories.h | 2 | ||||
-rw-r--r-- | library/backend/event.cpp | 4 | ||||
-rw-r--r-- | library/backend/palmtoprecord.h | 12 | ||||
-rw-r--r-- | library/datebookdb.cpp | 0 | ||||
-rw-r--r-- | library/finddialog.cpp | 7 | ||||
-rw-r--r-- | library/global.cpp | 0 | ||||
-rw-r--r-- | library/qpeapplication.cpp | 3 | ||||
-rw-r--r-- | library/storage.cpp | 6 |
10 files changed, 43 insertions, 12 deletions
diff --git a/library/applnk.cpp b/library/applnk.cpp index 35822dd..00030e8 100644 --- a/library/applnk.cpp +++ b/library/applnk.cpp | |||
@@ -323,25 +323,41 @@ const QArray<int>& AppLnk::categories() const | |||
323 | Returns the id of the AppLnk. If the AppLnk is not in an AppLnkSet, | 323 | Returns the id of the AppLnk. If the AppLnk is not in an AppLnkSet, |
324 | this value is 0, otherwise it is a value that is unique for the | 324 | this value is 0, otherwise it is a value that is unique for the |
325 | duration of the current process. | 325 | duration of the current process. |
326 | 326 | ||
327 | \sa AppLnkSet::find() | 327 | \sa AppLnkSet::find() |
328 | */ | 328 | */ |
329 | 329 | ||
330 | /*! | 330 | /*! |
331 | \fn bool AppLnk::isValid() const | 331 | \fn bool AppLnk::isValid() const |
332 | 332 | ||
333 | Returns TRUE if this AppLnk is valid; otherwise returns FALSE. | 333 | Returns TRUE if this AppLnk is valid; otherwise returns FALSE. |
334 | */ | 334 | */ |
335 | /*! | ||
336 | \fn bool AppLnk::fileKnown() const | ||
337 | |||
338 | If the with the AppLnk associated file is not equal to QString::null | ||
339 | */ | ||
340 | /*! | ||
341 | \fn bool AppLnk::linkFileKnown()const | ||
342 | |||
343 | The filename of the AppLnk | ||
335 | 344 | ||
345 | */ | ||
346 | /*! | ||
347 | \fn void AppLnk::setRotation( const QString& ) | ||
348 | |||
349 | The default rotation of the associated application. This | ||
350 | function is included inline for binary compatible issues | ||
351 | */ | ||
336 | /*! | 352 | /*! |
337 | Creates an invalid AppLnk. | 353 | Creates an invalid AppLnk. |
338 | 354 | ||
339 | \sa isValid() | 355 | \sa isValid() |
340 | */ | 356 | */ |
341 | AppLnk::AppLnk() | 357 | AppLnk::AppLnk() |
342 | { | 358 | { |
343 | mId = 0; | 359 | mId = 0; |
344 | d = new AppLnkPrivate(); | 360 | d = new AppLnkPrivate(); |
345 | } | 361 | } |
346 | 362 | ||
347 | /*! | 363 | /*! |
diff --git a/library/backend/categories.cpp b/library/backend/categories.cpp index 2e84089..cce9f38 100644 --- a/library/backend/categories.cpp +++ b/library/backend/categories.cpp | |||
@@ -839,29 +839,24 @@ void CheckedListView::setChecked( const QStringList &checked ) | |||
839 | } | 839 | } |
840 | } | 840 | } |
841 | else | 841 | else |
842 | i->setOn( FALSE ); | 842 | i->setOn( FALSE ); |
843 | } | 843 | } |
844 | 844 | ||
845 | /*! \fn Categories &Categories::operator= ( const Categories &c ) | 845 | /*! \fn Categories &Categories::operator= ( const Categories &c ) |
846 | 846 | ||
847 | Performs deep copy. | 847 | Performs deep copy. |
848 | */ | 848 | */ |
849 | 849 | ||
850 | 850 | ||
851 | /*! \fn QStringList Categories::labels( const QString & app, const QArray<int> &catids ) const | ||
852 | |||
853 | Returns list of labels associated with the application and catids | ||
854 | */ | ||
855 | |||
856 | /*! \fn QStringList Categories::globalCategories() const | 851 | /*! \fn QStringList Categories::globalCategories() const |
857 | 852 | ||
858 | Returns list of all global category labels | 853 | Returns list of all global category labels |
859 | */ | 854 | */ |
860 | 855 | ||
861 | /*! \fn const QMap<QString, CategoryGroup> &Categories::appGroupMap() const | 856 | /*! \fn const QMap<QString, CategoryGroup> &Categories::appGroupMap() const |
862 | 857 | ||
863 | Returns a map of application names to CategoryGroup. The CategoryGroup | 858 | Returns a map of application names to CategoryGroup. The CategoryGroup |
864 | class defines a map of ids to category labels and category labels to ids. | 859 | class defines a map of ids to category labels and category labels to ids. |
865 | */ | 860 | */ |
866 | 861 | ||
867 | /*! \fn const CategoryGroup &Categories::globalGroup() const | 862 | /*! \fn const CategoryGroup &Categories::globalGroup() const |
diff --git a/library/backend/categories.h b/library/backend/categories.h index ba65ee3..d5b3669 100644 --- a/library/backend/categories.h +++ b/library/backend/categories.h | |||
@@ -76,25 +76,25 @@ public: | |||
76 | 76 | ||
77 | const QMap<int, QString> &idMap() const { return mIdLabelMap; } | 77 | const QMap<int, QString> &idMap() const { return mIdLabelMap; } |
78 | 78 | ||
79 | private: | 79 | private: |
80 | void insert( int uid, const QString &label ); | 80 | void insert( int uid, const QString &label ); |
81 | QMap<int, QString> mIdLabelMap; | 81 | QMap<int, QString> mIdLabelMap; |
82 | QMap<QString, int> mLabelIdMap; | 82 | QMap<QString, int> mLabelIdMap; |
83 | 83 | ||
84 | static Qtopia::UidGen &uidGen() { return sUidGen; } | 84 | static Qtopia::UidGen &uidGen() { return sUidGen; } |
85 | static Qtopia::UidGen sUidGen; | 85 | static Qtopia::UidGen sUidGen; |
86 | }; | 86 | }; |
87 | 87 | ||
88 | /** Map from application name to categories */ | 88 | /* Map from application name to categories */ |
89 | class QPC_EXPORT Categories : public QObject | 89 | class QPC_EXPORT Categories : public QObject |
90 | { | 90 | { |
91 | Q_OBJECT | 91 | Q_OBJECT |
92 | public: | 92 | public: |
93 | Categories( QObject *parent=0, const char *name = 0 ) | 93 | Categories( QObject *parent=0, const char *name = 0 ) |
94 | : QObject( parent, name ), mGlobalCats(), mAppCats() { } | 94 | : QObject( parent, name ), mGlobalCats(), mAppCats() { } |
95 | Categories( const Categories ©From ) : QObject( copyFrom.parent() ), | 95 | Categories( const Categories ©From ) : QObject( copyFrom.parent() ), |
96 | mGlobalCats( copyFrom.mGlobalCats ), | 96 | mGlobalCats( copyFrom.mGlobalCats ), |
97 | mAppCats( copyFrom.mAppCats ) { } | 97 | mAppCats( copyFrom.mAppCats ) { } |
98 | virtual ~Categories() { } | 98 | virtual ~Categories() { } |
99 | 99 | ||
100 | Categories &operator= ( const Categories &c ) | 100 | Categories &operator= ( const Categories &c ) |
diff --git a/library/backend/event.cpp b/library/backend/event.cpp index d906f19..4c24ab3 100644 --- a/library/backend/event.cpp +++ b/library/backend/event.cpp | |||
@@ -158,31 +158,31 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia ); | |||
158 | */ | 158 | */ |
159 | 159 | ||
160 | /*! | 160 | /*! |
161 | \fn void Event::setAllDay(bool allday) | 161 | \fn void Event::setAllDay(bool allday) |
162 | 162 | ||
163 | If \a allday is TRUE, will set the event to be an all day event. | 163 | If \a allday is TRUE, will set the event to be an all day event. |
164 | Otherwise sets the event to not be an all day event. | 164 | Otherwise sets the event to not be an all day event. |
165 | 165 | ||
166 | \warning This function may affect the start and end times of the event. | 166 | \warning This function may affect the start and end times of the event. |
167 | */ | 167 | */ |
168 | 168 | ||
169 | /*! | 169 | /*! |
170 | \fn QDateTime Event::start() const | 170 | \fn QDateTime Event::start(bool) const |
171 | 171 | ||
172 | Returns the start date and time of the first occurance of the event. | 172 | Returns the start date and time of the first occurance of the event. |
173 | */ | 173 | */ |
174 | 174 | ||
175 | /*! | 175 | /*! |
176 | \fn QDateTime Event::end() const | 176 | \fn QDateTime Event::end(bool) const |
177 | 177 | ||
178 | Returns the end date and time of the first occurance of the event. | 178 | Returns the end date and time of the first occurance of the event. |
179 | */ | 179 | */ |
180 | 180 | ||
181 | /*! | 181 | /*! |
182 | \fn time_t Event::startTime() const | 182 | \fn time_t Event::startTime() const |
183 | \internal | 183 | \internal |
184 | */ | 184 | */ |
185 | 185 | ||
186 | /*! | 186 | /*! |
187 | \fn time_t Event::endTime() const | 187 | \fn time_t Event::endTime() const |
188 | \internal | 188 | \internal |
diff --git a/library/backend/palmtoprecord.h b/library/backend/palmtoprecord.h index 72f7d1c..15cdd6a 100644 --- a/library/backend/palmtoprecord.h +++ b/library/backend/palmtoprecord.h | |||
@@ -23,27 +23,39 @@ | |||
23 | #include "qpcglobal.h" | 23 | #include "qpcglobal.h" |
24 | #include "palmtopuidgen.h" | 24 | #include "palmtopuidgen.h" |
25 | #include <qarray.h> | 25 | #include <qarray.h> |
26 | #include <qmap.h> | 26 | #include <qmap.h> |
27 | 27 | ||
28 | #if defined(QPC_TEMPLATEDLL) | 28 | #if defined(QPC_TEMPLATEDLL) |
29 | // MOC_SKIP_BEGIN | 29 | // MOC_SKIP_BEGIN |
30 | QPC_TEMPLATEEXTERN template class QPC_EXPORT QMap<QString, QString>; | 30 | QPC_TEMPLATEEXTERN template class QPC_EXPORT QMap<QString, QString>; |
31 | // MOC_SKIP_END | 31 | // MOC_SKIP_END |
32 | #endif | 32 | #endif |
33 | 33 | ||
34 | class QRegExp; | 34 | class QRegExp; |
35 | /** | ||
36 | * @short Qtopia namespace | ||
37 | * The namespace of Qtopia | ||
38 | */ | ||
35 | namespace Qtopia { | 39 | namespace Qtopia { |
36 | 40 | ||
37 | class RecordPrivate; | 41 | class RecordPrivate; |
42 | /** | ||
43 | * @short The base class of all Records | ||
44 | * | ||
45 | * The base class for Records in Qtopia | ||
46 | * @see Task | ||
47 | * @see Event | ||
48 | * @see Contact | ||
49 | */ | ||
38 | class QPC_EXPORT Record | 50 | class QPC_EXPORT Record |
39 | { | 51 | { |
40 | public: | 52 | public: |
41 | Record() : mUid(0), mCats() { } | 53 | Record() : mUid(0), mCats() { } |
42 | Record( const Record &c ) :mUid( c.mUid ), mCats ( c.mCats ), customMap(c.customMap) { } | 54 | Record( const Record &c ) :mUid( c.mUid ), mCats ( c.mCats ), customMap(c.customMap) { } |
43 | virtual ~Record() { } | 55 | virtual ~Record() { } |
44 | 56 | ||
45 | Record &operator=( const Record &c ); | 57 | Record &operator=( const Record &c ); |
46 | 58 | ||
47 | virtual bool match( const QRegExp & ) const { return FALSE; } | 59 | virtual bool match( const QRegExp & ) const { return FALSE; } |
48 | 60 | ||
49 | void setCategories( const QArray<int> &v ) { mCats = v; mCats.sort(); } | 61 | void setCategories( const QArray<int> &v ) { mCats = v; mCats.sort(); } |
diff --git a/library/datebookdb.cpp b/library/datebookdb.cpp index 0fedfa8..2f33255 100644 --- a/library/datebookdb.cpp +++ b/library/datebookdb.cpp | |||
diff --git a/library/finddialog.cpp b/library/finddialog.cpp index d9f430a..ddf41a7 100644 --- a/library/finddialog.cpp +++ b/library/finddialog.cpp | |||
@@ -19,24 +19,31 @@ | |||
19 | **********************************************************************/ | 19 | **********************************************************************/ |
20 | 20 | ||
21 | // WARNING: Do *NOT* define this yourself. The SL5xxx from SHARP does NOT | 21 | // WARNING: Do *NOT* define this yourself. The SL5xxx from SHARP does NOT |
22 | // have this class. | 22 | // have this class. |
23 | #define QTOPIA_INTERNAL_FD | 23 | #define QTOPIA_INTERNAL_FD |
24 | 24 | ||
25 | #include "finddialog.h" | 25 | #include "finddialog.h" |
26 | #include "findwidget_p.h" | 26 | #include "findwidget_p.h" |
27 | 27 | ||
28 | #include <qlayout.h> | 28 | #include <qlayout.h> |
29 | #include <qpushbutton.h> | 29 | #include <qpushbutton.h> |
30 | 30 | ||
31 | /*! | ||
32 | \class FindDialog finddialog.h | ||
33 | \brief A simple FindDialog | ||
34 | |||
35 | A find dialog. FIXME!!!! | ||
36 | |||
37 | */ | ||
31 | FindDialog::FindDialog( const QString &appName, QWidget *parent, | 38 | FindDialog::FindDialog( const QString &appName, QWidget *parent, |
32 | const char *name, bool modal ) | 39 | const char *name, bool modal ) |
33 | : QDialog( parent, name, modal ) | 40 | : QDialog( parent, name, modal ) |
34 | { | 41 | { |
35 | setCaption( tr("Find") ); | 42 | setCaption( tr("Find") ); |
36 | QVBoxLayout *vb; | 43 | QVBoxLayout *vb; |
37 | vb = new QVBoxLayout( this ); | 44 | vb = new QVBoxLayout( this ); |
38 | fw = new FindWidget( appName, this, "Find Widget" ); | 45 | fw = new FindWidget( appName, this, "Find Widget" ); |
39 | vb->addWidget( fw ); | 46 | vb->addWidget( fw ); |
40 | QObject::connect( fw, SIGNAL(signalFindClicked(const QString&, | 47 | QObject::connect( fw, SIGNAL(signalFindClicked(const QString&, |
41 | bool,bool,int)), | 48 | bool,bool,int)), |
42 | this, SIGNAL(signalFindClicked(const QString&, | 49 | this, SIGNAL(signalFindClicked(const QString&, |
diff --git a/library/global.cpp b/library/global.cpp index 68a3a75..ce39751 100644 --- a/library/global.cpp +++ b/library/global.cpp | |||
diff --git a/library/qpeapplication.cpp b/library/qpeapplication.cpp index c562f6c..2ef60d5 100644 --- a/library/qpeapplication.cpp +++ b/library/qpeapplication.cpp | |||
@@ -441,25 +441,25 @@ static void setTreble( int t = 0, int percent = -1 ) | |||
441 | */ | 441 | */ |
442 | 442 | ||
443 | /*! | 443 | /*! |
444 | \fn void QPEApplication::weekChanged( bool startOnMonday ) | 444 | \fn void QPEApplication::weekChanged( bool startOnMonday ) |
445 | 445 | ||
446 | This signal is emitted if the week start day is changed. If \a | 446 | This signal is emitted if the week start day is changed. If \a |
447 | startOnMonday is TRUE then the first day of the week is Monday; if | 447 | startOnMonday is TRUE then the first day of the week is Monday; if |
448 | \a startOnMonday is FALSE then the first day of the week is | 448 | \a startOnMonday is FALSE then the first day of the week is |
449 | Sunday. | 449 | Sunday. |
450 | */ | 450 | */ |
451 | 451 | ||
452 | /*! | 452 | /*! |
453 | \fn void QPEApplication::dateFormatChanged() | 453 | \fn void QPEApplication::dateFormatChanged(DateFormat) |
454 | 454 | ||
455 | This signal is emitted whenever the date format is changed. | 455 | This signal is emitted whenever the date format is changed. |
456 | */ | 456 | */ |
457 | 457 | ||
458 | /*! | 458 | /*! |
459 | \fn void QPEApplication::flush() | 459 | \fn void QPEApplication::flush() |
460 | 460 | ||
461 | ### | 461 | ### |
462 | */ | 462 | */ |
463 | 463 | ||
464 | /*! | 464 | /*! |
465 | \fn void QPEApplication::reload() | 465 | \fn void QPEApplication::reload() |
@@ -1759,24 +1759,25 @@ void* operator new( size_t size ) | |||
1759 | } | 1759 | } |
1760 | 1760 | ||
1761 | void operator delete[]( void* p ) | 1761 | void operator delete[]( void* p ) |
1762 | { | 1762 | { |
1763 | free( p ); | 1763 | free( p ); |
1764 | } | 1764 | } |
1765 | 1765 | ||
1766 | void operator delete[]( void* p, size_t /*size*/ ) | 1766 | void operator delete[]( void* p, size_t /*size*/ ) |
1767 | { | 1767 | { |
1768 | free( p ); | 1768 | free( p ); |
1769 | } | 1769 | } |
1770 | 1770 | ||
1771 | |||
1771 | void operator delete( void* p ) | 1772 | void operator delete( void* p ) |
1772 | { | 1773 | { |
1773 | free( p ); | 1774 | free( p ); |
1774 | } | 1775 | } |
1775 | 1776 | ||
1776 | void operator delete( void* p, size_t /*size*/ ) | 1777 | void operator delete( void* p, size_t /*size*/ ) |
1777 | { | 1778 | { |
1778 | free( p ); | 1779 | free( p ); |
1779 | } | 1780 | } |
1780 | 1781 | ||
1781 | #endif | 1782 | #endif |
1782 | 1783 | ||
diff --git a/library/storage.cpp b/library/storage.cpp index f4c1c02..12f9df9 100644 --- a/library/storage.cpp +++ b/library/storage.cpp | |||
@@ -191,45 +191,45 @@ bool deviceTab( const char *device) { | |||
191 | QString deviceName = me->mnt_fsname; | 191 | QString deviceName = me->mnt_fsname; |
192 | // qDebug(deviceName); | 192 | // qDebug(deviceName); |
193 | if( deviceName.left(name.length()) == name) { | 193 | if( deviceName.left(name.length()) == name) { |
194 | hasDevice = true; | 194 | hasDevice = true; |
195 | } | 195 | } |
196 | } | 196 | } |
197 | } | 197 | } |
198 | endmntent( mntfp ); | 198 | endmntent( mntfp ); |
199 | return hasDevice; | 199 | return hasDevice; |
200 | } | 200 | } |
201 | 201 | ||
202 | /*! | 202 | /*! |
203 | * @fn hasCf() | 203 | * @fn static bool StorageInfo::hasCf() |
204 | * @brief returns whether device has Cf mounted | 204 | * @brief returns whether device has Cf mounted |
205 | * | 205 | * |
206 | */ | 206 | */ |
207 | bool StorageInfo::hasCf() | 207 | bool StorageInfo::hasCf() |
208 | { | 208 | { |
209 | return deviceTab("/dev/hd"); | 209 | return deviceTab("/dev/hd"); |
210 | } | 210 | } |
211 | 211 | ||
212 | /*! | 212 | /*! |
213 | * @fn hasSd() | 213 | * @fn static bool StorageInfo::hasSd() |
214 | * @brief returns whether device has SD mounted | 214 | * @brief returns whether device has SD mounted |
215 | * | 215 | * |
216 | */ | 216 | */ |
217 | bool StorageInfo::hasSd() | 217 | bool StorageInfo::hasSd() |
218 | { | 218 | { |
219 | return deviceTab("/dev/mmcd"); | 219 | return deviceTab("/dev/mmcd"); |
220 | } | 220 | } |
221 | 221 | ||
222 | /*! | 222 | /*! |
223 | * @fn hasMmc() | 223 | * @fn static bool StorageInfo::hasMmc() |
224 | * @brief reutrns whether device has mmc mounted | 224 | * @brief reutrns whether device has mmc mounted |
225 | * | 225 | * |
226 | */ | 226 | */ |
227 | bool StorageInfo::hasMmc() | 227 | bool StorageInfo::hasMmc() |
228 | { | 228 | { |
229 | bool hasMmc=false; | 229 | bool hasMmc=false; |
230 | if( deviceTab("/dev/mmc/part")) | 230 | if( deviceTab("/dev/mmc/part")) |
231 | hasMmc=true; | 231 | hasMmc=true; |
232 | if( deviceTab("/dev/mmcd")) | 232 | if( deviceTab("/dev/mmcd")) |
233 | hasMmc=true; | 233 | hasMmc=true; |
234 | return hasMmc; | 234 | return hasMmc; |
235 | } | 235 | } |