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 | |||
@@ -331,9 +331,25 @@ const QArray<int>& AppLnk::categories() const | |||
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() |
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 | |||
@@ -847,13 +847,8 @@ void CheckedListView::setChecked( const QStringList &checked ) | |||
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 | */ |
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 | |||
@@ -84,9 +84,9 @@ private: | |||
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: |
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 | |||
@@ -166,15 +166,15 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia ); | |||
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 | ||
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 | |||
@@ -31,11 +31,23 @@ 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() { } |
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 | |||
@@ -27,8 +27,15 @@ | |||
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 | { |
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 | |||
@@ -449,9 +449,9 @@ static void setTreble( int t = 0, int percent = -1 ) | |||
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 | ||
@@ -1767,8 +1767,9 @@ 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 | } |
diff --git a/library/storage.cpp b/library/storage.cpp index f4c1c02..12f9df9 100644 --- a/library/storage.cpp +++ b/library/storage.cpp | |||
@@ -199,9 +199,9 @@ bool deviceTab( const char *device) { | |||
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() |
@@ -209,9 +209,9 @@ bool StorageInfo::hasCf() | |||
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() |
@@ -219,9 +219,9 @@ bool StorageInfo::hasSd() | |||
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() |