small documentation format fixes

11 files changed, 30 insertions, 34 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
@@ -336,8 +336,8 @@ bool ODevice::setDisplayStatus ( bool on )
 *
-* @param p The brightness to be set on a scale from 0 to 255
+* @param b The brightness to be set on a scale from 0 to 255
 * @return success or failure
 */
-bool ODevice::setDisplayBrightness ( int p)
+bool ODevice::setDisplayBrightness ( int b)
 {
-        Q_UNUSED( p )
+        Q_UNUSED( b )
     return false;
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
@@ -129,3 +129,3 @@ class OConfigGroupSaver
      * Constructor.
-     * Create the object giving a @config object and a @a group to become
+     * Create the object giving a OConfig object and a @a group to become
      * the current 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
@@ -418,3 +418,3 @@ private:
  * Does nothing.
- * @param a stream
+ * @param s stream
  * @return the given @p s
@@ -424,3 +424,3 @@ inline ondbgstream& endl( ondbgstream & s) { return s; }
  * Does nothing.
- * @param a stream
+ * @param s stream
  * @return the given @p s
@@ -448,3 +448,3 @@ QString odBacktrace(int levels = -1);
  */
-inline ondbgstream ondDebug(int = 0) { return ondbgstream(); }
+inline ondbgstream ondDebug(int area = 0) { return ondbgstream(); }
 inline ondbgstream ondDebug(bool , int  = 0) { return ondbgstream(); }
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
@@ -99,3 +99,3 @@ void OKeyPair::setKeycode( int key ) {
  *
- * @param the Modifier key
+ * @param mod the Modifier key
  * @see Qt::ButtonState
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
@@ -67,3 +67,3 @@ protected:
      */
-    virtual void addPreHandler(QWSServer::KeyboardFilter*aFilter)=0;
+    virtual void addPreHandler(QWSServer::KeyboardFilter *aFilter)=0;
     /**
@@ -74,3 +74,3 @@ protected:
      */
-    virtual void remPreHandler(QWSServer::KeyboardFilter*aFilter)=0;
+    virtual void remPreHandler(QWSServer::KeyboardFilter *aFilter)=0;
 
@@ -83,3 +83,3 @@ public:
      */
-    virtual void addHandler(QWSServer::KeyboardFilter*)=0;
+    virtual void addHandler(QWSServer::KeyboardFilter *aFilter)=0;
     /**
@@ -89,3 +89,3 @@ public:
      */
-    virtual void remHandler(QWSServer::KeyboardFilter*)=0;
+    virtual void remHandler(QWSServer::KeyboardFilter *aFilter)=0;
 
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
@@ -525,3 +525,3 @@ QString OGenericPluginLoader::unlibify( const QString& str ) {
  *
- * @param dir The dir to look in
+ * @param _dir The dir to look in
  * @param sorted Should positions be read?
@@ -683,3 +683,2 @@ OPluginLoader::~OPluginLoader() {
  * @param loader A Pointer to your OGenericPluginLoader
- * @param name The name
  */
@@ -759,3 +758,3 @@ void OPluginManager::setPosition( const OPluginItem& item) {
  *
- * @param the Item to enable
+ * @param item the Item to enable
  */
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
@@ -56,3 +56,3 @@ class OProcessPrivate;
  *
- * @sect General usage and features
+ * @par General usage and features
  *
@@ -112,3 +112,3 @@ class OProcessPrivate;
  *
- *@sect Communication with the child process
+ *@par Communication with the child process
  *
@@ -140,3 +140,3 @@ class OProcessPrivate;
  *
- *@sect QT signals:
+ *@par QT signals:
  *
@@ -493,2 +493,3 @@ signals:
      *
+     * @param proc The process
      * @param buffer The data received.
@@ -526,2 +527,3 @@ signals:
      *
+     * @param proc The process
      * @param buffer The data received.
diff --git a/libopie2/opieui/oimageeffect.h b/libopie2/opieui/oimageeffect.h
index 4f86d5b..4422741 100644
--- a/libopie2/opieui/oimageeffect.h
+++ b/libopie2/opieui/oimageeffect.h
@@ -221,3 +221,3 @@ public:
      *
-     * @param image The QImage to process.
+     * @param img The QImage to process.
      * @param val The strength of the effect. 0 <= val <= 1.
@@ -310,3 +310,3 @@ public:
      *
-     * @param image The QImage to process.
+     * @param img The QImage to process.
      * @param palette The color palette to use
@@ -532,3 +532,3 @@ public:
       * @param amplitude The amplitude of the sine wave.
-      * @param wavelength The frequency of the sine wave.
+      * @param frequency The frequency of the sine wave.
       * @return The new image. The original is not changed.
diff --git a/libopie2/opieui/opixmapeffect.h b/libopie2/opieui/opixmapeffect.h
index b780f9f..85a1e25 100644
--- a/libopie2/opieui/opixmapeffect.h
+++ b/libopie2/opieui/opixmapeffect.h
@@ -154,12 +154,7 @@ public:
     /**
-     * Recolors a pixmap.
-     *
-     * The most dark color will become color a,
-     * the most bright one color b, and in between.
+     * Fades a pixmap to a certain color.
      *
      * @param pixmap The pixmap to process.
-     * @param ca Color a.
-     * @param cb Color b.
-     * @param ncols The number of colors to use. Pass zero to prevent
-     * dithering.
+     * @param val The strength of the effect. 0 <= val <= 1.
+     * @param color The color to blend to.
      * @return Returns the @ref pixmap(), provided for convenience.
diff --git a/libopie2/qt3/opieui/ocombobox.h b/libopie2/qt3/opieui/ocombobox.h
index 4e35b61..3f60f54 100644
--- a/libopie2/qt3/opieui/ocombobox.h
+++ b/libopie2/qt3/opieui/ocombobox.h
@@ -55,3 +55,3 @@ typedef QString OURL;
  *
- * @sect Detail
+ * @par Detail
  *
@@ -99,3 +99,3 @@ typedef QString OURL;
  *
- * @sect Useage
+ * @par Usage
  *
diff --git a/libopie2/qt3/opieui/olineedit.h b/libopie2/qt3/opieui/olineedit.h
index ecfca27..db3d7ef 100644
--- a/libopie2/qt3/opieui/olineedit.h
+++ b/libopie2/qt3/opieui/olineedit.h
@@ -52,3 +52,3 @@ typedef QString KURL; //class KURL;
  *
- * @sect Detail
+ * @par Detail
  *
@@ -97,3 +97,3 @@ typedef QString KURL; //class KURL;
  *
- * @sect Useage
+ * @par Usage
  *
@@ -127,3 +127,3 @@ typedef QString KURL; //class KURL;
  *
- * @sect Miscellaneous function calls :
+ * @par Miscellaneous function calls :
  *