author | clem <clem> | 2004-10-07 19:36:30 (UTC) |
---|---|---|
committer | clem <clem> | 2004-10-07 19:36:30 (UTC) |
commit | b2e0fd018e1122f65dbbf8ab564e992988f35385 (patch) (unidiff) | |
tree | d47db77ff4ba1e9d397bc682f5d65b05b049dd02 /libopie2/opiecore | |
parent | 33c90b7be9d675e8e5b39cfd569997bfcbb5decf (diff) | |
download | opie-b2e0fd018e1122f65dbbf8ab564e992988f35385.zip opie-b2e0fd018e1122f65dbbf8ab564e992988f35385.tar.gz opie-b2e0fd018e1122f65dbbf8ab564e992988f35385.tar.bz2 |
small documentation format fixes
-rw-r--r-- | libopie2/opiecore/device/odevice.cpp | 6 | ||||
-rw-r--r-- | libopie2/opiecore/oconfig.h | 2 | ||||
-rw-r--r-- | libopie2/opiecore/odebug.h | 6 | ||||
-rw-r--r-- | libopie2/opiecore/okeyconfigmanager.cpp | 2 | ||||
-rw-r--r-- | libopie2/opiecore/okeyfilter.h | 8 | ||||
-rw-r--r-- | libopie2/opiecore/opluginloader.cpp | 5 | ||||
-rw-r--r-- | libopie2/opiecore/oprocess.h | 8 |
7 files changed, 19 insertions, 18 deletions
diff --git a/libopie2/opiecore/device/odevice.cpp b/libopie2/opiecore/device/odevice.cpp index b5ae4e5..8b64c41 100644 --- a/libopie2/opiecore/device/odevice.cpp +++ b/libopie2/opiecore/device/odevice.cpp | |||
@@ -334,12 +334,12 @@ bool ODevice::setDisplayStatus ( bool on ) | |||
334 | /** | 334 | /** |
335 | * This sets the display brightness | 335 | * This sets the display brightness |
336 | * | 336 | * |
337 | * @param p The brightness to be set on a scale from 0 to 255 | 337 | * @param b The brightness to be set on a scale from 0 to 255 |
338 | * @return success or failure | 338 | * @return success or failure |
339 | */ | 339 | */ |
340 | bool ODevice::setDisplayBrightness ( int p) | 340 | bool ODevice::setDisplayBrightness ( int b) |
341 | { | 341 | { |
342 | Q_UNUSED( p ) | 342 | Q_UNUSED( b ) |
343 | return false; | 343 | return false; |
344 | } | 344 | } |
345 | 345 | ||
diff --git a/libopie2/opiecore/oconfig.h b/libopie2/opiecore/oconfig.h index ab95dc3..05a1a25 100644 --- a/libopie2/opiecore/oconfig.h +++ b/libopie2/opiecore/oconfig.h | |||
@@ -127,7 +127,7 @@ class OConfigGroupSaver | |||
127 | public: | 127 | public: |
128 | /** | 128 | /** |
129 | * Constructor. | 129 | * Constructor. |
130 | * Create the object giving a @config object and a @a group to become | 130 | * Create the object giving a OConfig object and a @a group to become |
131 | * the current group. | 131 | * the current group. |
132 | */ | 132 | */ |
133 | OConfigGroupSaver( OConfig* config, QString group ) :_config(config), _oldgroup(config->group() ) | 133 | OConfigGroupSaver( OConfig* config, QString group ) :_config(config), _oldgroup(config->group() ) |
diff --git a/libopie2/opiecore/odebug.h b/libopie2/opiecore/odebug.h index 21a6c26..18dc09e 100644 --- a/libopie2/opiecore/odebug.h +++ b/libopie2/opiecore/odebug.h | |||
@@ -416,13 +416,13 @@ private: | |||
416 | 416 | ||
417 | /** | 417 | /** |
418 | * Does nothing. | 418 | * Does nothing. |
419 | * @param a stream | 419 | * @param s stream |
420 | * @return the given @p s | 420 | * @return the given @p s |
421 | */ | 421 | */ |
422 | inline ondbgstream& endl( ondbgstream & s) { return s; } | 422 | inline ondbgstream& endl( ondbgstream & s) { return s; } |
423 | /** | 423 | /** |
424 | * Does nothing. | 424 | * Does nothing. |
425 | * @param a stream | 425 | * @param s stream |
426 | * @return the given @p s | 426 | * @return the given @p s |
427 | */ | 427 | */ |
428 | inline ondbgstream& flush( ondbgstream & s) { return s; } | 428 | inline ondbgstream& flush( ondbgstream & s) { return s; } |
@@ -446,7 +446,7 @@ QString odBacktrace(int levels = -1); | |||
446 | * @param area an id to identify the output, 0 for default | 446 | * @param area an id to identify the output, 0 for default |
447 | * @see odDebug() | 447 | * @see odDebug() |
448 | */ | 448 | */ |
449 | inline ondbgstream ondDebug(int = 0) { return ondbgstream(); } | 449 | inline ondbgstream ondDebug(int area = 0) { return ondbgstream(); } |
450 | inline ondbgstream ondDebug(bool , int = 0) { return ondbgstream(); } | 450 | inline ondbgstream ondDebug(bool , int = 0) { return ondbgstream(); } |
451 | inline QString ondBacktrace() { return QString::null; } | 451 | inline QString ondBacktrace() { return QString::null; } |
452 | inline QString ondBacktrace(int) { return QString::null; } | 452 | inline QString ondBacktrace(int) { return QString::null; } |
diff --git a/libopie2/opiecore/okeyconfigmanager.cpp b/libopie2/opiecore/okeyconfigmanager.cpp index 891cda7..48546bd 100644 --- a/libopie2/opiecore/okeyconfigmanager.cpp +++ b/libopie2/opiecore/okeyconfigmanager.cpp | |||
@@ -97,7 +97,7 @@ void OKeyPair::setKeycode( int key ) { | |||
97 | /** | 97 | /** |
98 | * Set the modifier key | 98 | * Set the modifier key |
99 | * | 99 | * |
100 | * @param the Modifier key | 100 | * @param mod the Modifier key |
101 | * @see Qt::ButtonState | 101 | * @see Qt::ButtonState |
102 | * @see modifier() | 102 | * @see modifier() |
103 | */ | 103 | */ |
diff --git a/libopie2/opiecore/okeyfilter.h b/libopie2/opiecore/okeyfilter.h index d183641..1871247 100644 --- a/libopie2/opiecore/okeyfilter.h +++ b/libopie2/opiecore/okeyfilter.h | |||
@@ -65,14 +65,14 @@ protected: | |||
65 | * @param aFilter a filter to append | 65 | * @param aFilter a filter to append |
66 | * @see addHandler | 66 | * @see addHandler |
67 | */ | 67 | */ |
68 | virtual void addPreHandler(QWSServer::KeyboardFilter*aFilter)=0; | 68 | virtual void addPreHandler(QWSServer::KeyboardFilter *aFilter)=0; |
69 | /** | 69 | /** |
70 | * Remove the specified filter from list and give back ownership. | 70 | * Remove the specified filter from list and give back ownership. |
71 | * This is only allowed for friend classes from odevice | 71 | * This is only allowed for friend classes from odevice |
72 | * @param aFilter a filter to remove | 72 | * @param aFilter a filter to remove |
73 | * @see remHandler | 73 | * @see remHandler |
74 | */ | 74 | */ |
75 | virtual void remPreHandler(QWSServer::KeyboardFilter*aFilter)=0; | 75 | virtual void remPreHandler(QWSServer::KeyboardFilter *aFilter)=0; |
76 | 76 | ||
77 | public: | 77 | public: |
78 | virtual ~OKeyFilter(); | 78 | virtual ~OKeyFilter(); |
@@ -81,13 +81,13 @@ public: | |||
81 | * @param aFilter a filter to append | 81 | * @param aFilter a filter to append |
82 | * @see addPreHandler | 82 | * @see addPreHandler |
83 | */ | 83 | */ |
84 | virtual void addHandler(QWSServer::KeyboardFilter*)=0; | 84 | virtual void addHandler(QWSServer::KeyboardFilter *aFilter)=0; |
85 | /** | 85 | /** |
86 | * Remove the specified filter from list and give back ownership. | 86 | * Remove the specified filter from list and give back ownership. |
87 | * @param aFilter a filter to remove | 87 | * @param aFilter a filter to remove |
88 | * @see remPreHandler | 88 | * @see remPreHandler |
89 | */ | 89 | */ |
90 | virtual void remHandler(QWSServer::KeyboardFilter*)=0; | 90 | virtual void remHandler(QWSServer::KeyboardFilter *aFilter)=0; |
91 | 91 | ||
92 | /** | 92 | /** |
93 | * Returns a handler to an instance of OKeyFilter | 93 | * Returns a handler to an instance of OKeyFilter |
diff --git a/libopie2/opiecore/opluginloader.cpp b/libopie2/opiecore/opluginloader.cpp index ec19fa0..2a6e369 100644 --- a/libopie2/opiecore/opluginloader.cpp +++ b/libopie2/opiecore/opluginloader.cpp | |||
@@ -523,7 +523,7 @@ QString OGenericPluginLoader::unlibify( const QString& str ) { | |||
523 | *Return a List of Plugins for a dir and add positions and remove disabled. | 523 | *Return a List of Plugins for a dir and add positions and remove disabled. |
524 | * If a plugin is on the excluded list assign position -2 | 524 | * If a plugin is on the excluded list assign position -2 |
525 | * | 525 | * |
526 | * @param dir The dir to look in | 526 | * @param _dir The dir to look in |
527 | * @param sorted Should positions be read? | 527 | * @param sorted Should positions be read? |
528 | * @param disabled Remove excluded from the list | 528 | * @param disabled Remove excluded from the list |
529 | */ | 529 | */ |
@@ -681,7 +681,6 @@ OPluginLoader::~OPluginLoader() { | |||
681 | * | 681 | * |
682 | * | 682 | * |
683 | * @param loader A Pointer to your OGenericPluginLoader | 683 | * @param loader A Pointer to your OGenericPluginLoader |
684 | * @param name The name | ||
685 | */ | 684 | */ |
686 | OPluginManager::OPluginManager( OGenericPluginLoader* loader) | 685 | OPluginManager::OPluginManager( OGenericPluginLoader* loader) |
687 | : m_loader( loader ), m_isSorted( false ) | 686 | : m_loader( loader ), m_isSorted( false ) |
@@ -757,7 +756,7 @@ void OPluginManager::setPosition( const OPluginItem& item) { | |||
757 | * the item with one that matches name and path internally. | 756 | * the item with one that matches name and path internally. |
758 | * @see setPosition | 757 | * @see setPosition |
759 | * | 758 | * |
760 | * @param the Item to enable | 759 | * @param item the Item to enable |
761 | */ | 760 | */ |
762 | void OPluginManager::enable( const OPluginItem& item ) { | 761 | void OPluginManager::enable( const OPluginItem& item ) { |
763 | setEnabled( item, true ); | 762 | setEnabled( item, true ); |
diff --git a/libopie2/opiecore/oprocess.h b/libopie2/opiecore/oprocess.h index be1436c..ac6be98 100644 --- a/libopie2/opiecore/oprocess.h +++ b/libopie2/opiecore/oprocess.h | |||
@@ -54,7 +54,7 @@ class OProcessPrivate; | |||
54 | /** | 54 | /** |
55 | * Child process invocation, monitoring and control. | 55 | * Child process invocation, monitoring and control. |
56 | * | 56 | * |
57 | * @sect General usage and features | 57 | * @par General usage and features |
58 | * | 58 | * |
59 | *This class allows a KDE and OPIE application to start child processes without having | 59 | *This class allows a KDE and OPIE application to start child processes without having |
60 | *to worry about UN*X signal handling issues and zombie process reaping. | 60 | *to worry about UN*X signal handling issues and zombie process reaping. |
@@ -110,7 +110,7 @@ class OProcessPrivate; | |||
110 | * | 110 | * |
111 | *When the child process exits, the respective Qt signal will be emitted. | 111 | *When the child process exits, the respective Qt signal will be emitted. |
112 | * | 112 | * |
113 | *@sect Communication with the child process | 113 | *@par Communication with the child process |
114 | * | 114 | * |
115 | *OProcess supports communication with the child process through | 115 | *OProcess supports communication with the child process through |
116 | *stdin/stdout/stderr. | 116 | *stdin/stdout/stderr. |
@@ -138,7 +138,7 @@ class OProcessPrivate; | |||
138 | *without a communication channel to stderr. | 138 | *without a communication channel to stderr. |
139 | * | 139 | * |
140 | * | 140 | * |
141 | *@sect QT signals: | 141 | *@par QT signals: |
142 | * | 142 | * |
143 | *@li void @ref receivedStdout(OProcess *proc, char *buffer, int buflen); | 143 | *@li void @ref receivedStdout(OProcess *proc, char *buffer, int buflen); |
144 | *@li void @ref receivedStderr(OProcess *proc, char *buffer, int buflen); | 144 | *@li void @ref receivedStderr(OProcess *proc, char *buffer, int buflen); |
@@ -491,6 +491,7 @@ signals: | |||
491 | * these signals, the respective communication link (stdout/stderr) | 491 | * these signals, the respective communication link (stdout/stderr) |
492 | * has to be turned on in @ref start(). | 492 | * has to be turned on in @ref start(). |
493 | * | 493 | * |
494 | * @param proc The process | ||
494 | * @param buffer The data received. | 495 | * @param buffer The data received. |
495 | * @param buflen The number of bytes that are available. | 496 | * @param buflen The number of bytes that are available. |
496 | * | 497 | * |
@@ -524,6 +525,7 @@ signals: | |||
524 | * these signals, the respective communication link (stdout/stderr) | 525 | * these signals, the respective communication link (stdout/stderr) |
525 | * has to be turned on in @ref start(). | 526 | * has to be turned on in @ref start(). |
526 | * | 527 | * |
528 | * @param proc The process | ||
527 | * @param buffer The data received. | 529 | * @param buffer The data received. |
528 | * @param buflen The number of bytes that are available. | 530 | * @param buflen The number of bytes that are available. |
529 | * | 531 | * |