summaryrefslogtreecommitdiff
authorzecke <zecke>2003-04-16 10:57:59 (UTC)
committer zecke <zecke>2003-04-16 10:57:59 (UTC)
commiteeb29547890a2d162de66d7d5b98d3840a7e2d79 (patch) (side-by-side diff)
tree973c6de7aae2fd5ba368efb87fa24234f0e12aa3
parentdfa2d294b3af09bf3757a3c2294a925093e72fc6 (diff)
downloadopie-eeb29547890a2d162de66d7d5b98d3840a7e2d79.zip
opie-eeb29547890a2d162de66d7d5b98d3840a7e2d79.tar.gz
opie-eeb29547890a2d162de66d7d5b98d3840a7e2d79.tar.bz2
Fix API docu
Diffstat (more/less context) (ignore whitespace changes)
-rw-r--r--library/applnk.cpp16
-rw-r--r--library/backend/categories.cpp9
-rw-r--r--library/backend/categories.h2
-rw-r--r--library/backend/event.cpp4
-rw-r--r--library/backend/palmtoprecord.h12
-rw-r--r--library/datebookdb.cpp12
-rw-r--r--library/finddialog.cpp7
-rw-r--r--library/global.cpp28
-rw-r--r--library/qpeapplication.cpp3
-rw-r--r--library/storage.cpp6
10 files changed, 65 insertions, 34 deletions
diff --git a/library/applnk.cpp b/library/applnk.cpp
index 35822dd..00030e8 100644
--- a/library/applnk.cpp
+++ b/library/applnk.cpp
@@ -333,5 +333,21 @@ const QArray<int>& AppLnk::categories() const
Returns TRUE if this AppLnk is valid; otherwise returns FALSE.
*/
+/*!
+ \fn bool AppLnk::fileKnown() const
+
+ If the with the AppLnk associated file is not equal to QString::null
+*/
+/*!
+ \fn bool AppLnk::linkFileKnown()const
+
+ The filename of the AppLnk
+*/
+/*!
+ \fn void AppLnk::setRotation( const QString& )
+
+ The default rotation of the associated application. This
+ function is included inline for binary compatible issues
+*/
/*!
Creates an invalid AppLnk.
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
@@ -488,5 +488,5 @@ QString Categories::displaySingle( const QString &app,
}
}
- else r = strs.first();
+ else r = strs.first();
return r;
}
@@ -849,9 +849,4 @@ void CheckedListView::setChecked( const QStringList &checked )
-/*! \fn QStringList Categories::labels( const QString & app, const QArray<int> &catids ) const
-
- Returns list of labels associated with the application and catids
-*/
-
/*! \fn QStringList Categories::globalCategories() const
@@ -878,5 +873,5 @@ void CheckedListView::setChecked( const QStringList &checked )
\a appname is the CategoryGroup application name that the category was added to or QString::null if it was global
\a uid is the unique identifier associated with the added category
-*/
+*/
/*! \fn void Categories::categoryRemoved( const Categories &cats, const QString &appname,
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
@@ -86,5 +86,5 @@ private:
};
-/** Map from application name to categories */
+/* Map from application name to categories */
class QPC_EXPORT Categories : public QObject
{
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
@@ -168,5 +168,5 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia );
/*!
- \fn QDateTime Event::start() const
+ \fn QDateTime Event::start(bool) const
Returns the start date and time of the first occurance of the event.
@@ -174,5 +174,5 @@ Qtopia::UidGen Event::sUidGen( Qtopia::UidGen::Qtopia );
/*!
- \fn QDateTime Event::end() const
+ \fn QDateTime Event::end(bool) const
Returns the end date and time of the first occurance of the event.
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
@@ -33,7 +33,19 @@ QPC_TEMPLATEEXTERN template class QPC_EXPORT QMap<QString, QString>;
class QRegExp;
+/**
+ * @short Qtopia namespace
+ * The namespace of Qtopia
+ */
namespace Qtopia {
class RecordPrivate;
+/**
+ * @short The base class of all Records
+ *
+ * The base class for Records in Qtopia
+ * @see Task
+ * @see Event
+ * @see Contact
+ */
class QPC_EXPORT Record
{
diff --git a/library/datebookdb.cpp b/library/datebookdb.cpp
index 0fedfa8..2f33255 100644
--- a/library/datebookdb.cpp
+++ b/library/datebookdb.cpp
@@ -72,5 +72,5 @@ bool nextOccurance(const Event &e, const QDate &from, QDateTime &next)
int firstOfWeek = 0;
int weekOfMonth;
-
+
if (e.repeatPattern().hasEndDate && e.repeatPattern().endDate() < from)
@@ -462,5 +462,5 @@ QValueList<EffectiveEvent> DateBookDB::getEffectiveEvents( const QDate &from,
for (it = eventList.begin(); it != eventList.end(); ++it ) {
- if (!(*it).isValidUid())
+ if (!(*it).isValidUid())
(*it).assignUid(); // FIXME: Hack to restore cleared uids
@@ -507,5 +507,5 @@ QValueList<EffectiveEvent> DateBookDB::getEffectiveEvents( const QDate &from,
QDateTime repeat;
for ( it = repeatEvents.begin(); it != repeatEvents.end(); ++it ) {
- if (!(*it).isValidUid())
+ if (!(*it).isValidUid())
(*it).assignUid(); // FIXME: Hack to restore cleared uids
@@ -624,5 +624,5 @@ void DateBookDB::editEvent( const Event &old, Event &editedEv )
delEventAlarm( old );
if ( oldHadRepeat ) {
- if ( editedEv.hasRepeat() ) { // This mean that origRepeat was run above and
+ if ( editedEv.hasRepeat() ) { // This mean that origRepeat was run above and
// orig is initialized
// assumption, when someone edits a repeating event, they
@@ -673,5 +673,5 @@ void DateBookDB::removeJFEvent( const Event&ev )
void DateBookDB::loadFile( const QString &strFile )
{
-
+
QFile f( strFile );
if ( !f.open( IO_ReadOnly ) )
@@ -724,5 +724,5 @@ void DateBookDB::loadFile( const QString &strFile )
dict.insert( "actionorig", new int (FJournalOrigHadRepeat) );
-
+
QByteArray ba = f.readAll();
char* dt = ba.data();
diff --git a/library/finddialog.cpp b/library/finddialog.cpp
index d9f430a..ddf41a7 100644
--- a/library/finddialog.cpp
+++ b/library/finddialog.cpp
@@ -29,4 +29,11 @@
#include <qpushbutton.h>
+/*!
+ \class FindDialog finddialog.h
+ \brief A simple FindDialog
+
+ A find dialog. FIXME!!!!
+
+*/
FindDialog::FindDialog( const QString &appName, QWidget *parent,
const char *name, bool modal )
diff --git a/library/global.cpp b/library/global.cpp
index 68a3a75..ce39751 100644
--- a/library/global.cpp
+++ b/library/global.cpp
@@ -111,5 +111,5 @@ StartingAppList::StartingAppList( QObject *parent, const char* name )
connect( qwsServer, SIGNAL( newChannel(const QString&)),
this, SLOT( handleNewChannel(const QString&)) );
-#endif
+#endif
dict.setAutoDelete( TRUE );
}
@@ -389,5 +389,5 @@ void Global::createDocDir()
void Global::statusMessage(const QString& message)
{
-#if!defined(QT_NO_COP)
+#if !defined(QT_NO_COP)
QCopEnvelope e( "QPE/TaskBar", "message(QString)" );
e << message;
@@ -562,5 +562,5 @@ void Global::invoke(const QString &c)
// If the channel is already register, the app is already running, so show it.
{ QCopEnvelope env( ("QPE/Application/" + ap).latin1(), "raise()" ); }
-
+
QCopEnvelope e("QPE/System", "notBusy(QString)" );
e << ap;
@@ -605,12 +605,12 @@ void Global::invoke(const QString &c)
} else
#endif
- {
- bool success = false;
+ {
+ bool success = false;
int pfd [2];
if ( ::pipe ( pfd ) < 0 )
pfd [0] = pfd [1] = -1;
-
+
pid_t pid = ::fork ( );
-
+
if ( pid == 0 ) { // child
for ( int fd = 3; fd < 100; fd++ ) {
@@ -623,18 +623,18 @@ void Global::invoke(const QString &c)
if ( pfd [1] >= 0 )
::fcntl ( pfd [1], F_SETFD, FD_CLOEXEC );
-
+
// Try bindir first, so that foo/bar works too
::execv ( qpeDir ( ) + "/bin/" + args [0], (char * const *) args );
::execvp ( args [0], (char * const *) args );
-
+
char resultByte = 1;
if ( pfd [1] >= 0 )
::write ( pfd [1], &resultByte, 1 );
- ::_exit ( -1 );
+ ::_exit ( -1 );
}
else if ( pid > 0 ) {
success = true;
-
- if ( pfd [1] >= 0 )
+
+ if ( pfd [1] >= 0 )
::close ( pfd [1] );
if ( pfd [0] >= 0 ) {
@@ -648,5 +648,5 @@ void Global::invoke(const QString &c)
if (( n == -1 ) && (( errno == ECHILD ) || ( errno == EINTR )))
continue;
-
+
break; // success
}
@@ -654,5 +654,5 @@ void Global::invoke(const QString &c)
}
}
- if ( success )
+ if ( success )
StartingAppList::add( list[0] );
else
diff --git a/library/qpeapplication.cpp b/library/qpeapplication.cpp
index c562f6c..2ef60d5 100644
--- a/library/qpeapplication.cpp
+++ b/library/qpeapplication.cpp
@@ -451,5 +451,5 @@ static void setTreble( int t = 0, int percent = -1 )
/*!
- \fn void QPEApplication::dateFormatChanged()
+ \fn void QPEApplication::dateFormatChanged(DateFormat)
This signal is emitted whenever the date format is changed.
@@ -1769,4 +1769,5 @@ void operator delete[]( void* p, size_t /*size*/ )
}
+
void operator delete( void* p )
{
diff --git a/library/storage.cpp b/library/storage.cpp
index f4c1c02..12f9df9 100644
--- a/library/storage.cpp
+++ b/library/storage.cpp
@@ -201,5 +201,5 @@ bool deviceTab( const char *device) {
/*!
- * @fn hasCf()
+ * @fn static bool StorageInfo::hasCf()
* @brief returns whether device has Cf mounted
*
@@ -211,5 +211,5 @@ bool StorageInfo::hasCf()
/*!
- * @fn hasSd()
+ * @fn static bool StorageInfo::hasSd()
* @brief returns whether device has SD mounted
*
@@ -221,5 +221,5 @@ bool StorageInfo::hasSd()
/*!
- * @fn hasMmc()
+ * @fn static bool StorageInfo::hasMmc()
* @brief reutrns whether device has mmc mounted
*