updated documentation

1 files changed, 26 insertions, 6 deletions

diff --git a/noncore/apps/opie-console/widget_layer.h b/noncore/apps/opie-console/widget_layer.h
index adf2038..d821f1d 100644
--- a/noncore/apps/opie-console/widget_layer.h
+++ b/noncore/apps/opie-console/widget_layer.h
@@ -44,4 +44,7 @@ public:
          * constructor
+         * @param const Profile &config, the configuration for this widget
+         * @param QWidget *parent, the parent widget
+         * @param const char *name, the name of the widget, defaults to ""
          */
-        WidgetLayer( QWidget *parent=0, const char *name=0 );
+        WidgetLayer( const Profile &config, QWidget *parent=0, const char *name=0 );
 
@@ -55,2 +58,5 @@ public:
          * sets the image
+         * @param QArray<Character> const newimg, the new image
+         * @param int lines, lines count of newimg
+         * @param int columns, columns count of newimg
          */
@@ -64,3 +70,3 @@ public:
         /**
-         * return the lines count
+         * @return int m_lines, the lines count
          */
@@ -69,3 +75,3 @@ public:
         /**
-         * return the columns count
+         * @return int m_columns, the columns count
          */
@@ -80,6 +86,9 @@ public:
          * insert text
+         * @param QString text, the text to be inserted
          */
         void insertText( QString text );
+        
         /**
          * set selection (clipboard) to text
+         * @param const QString &text, the text to be selected
          */
@@ -102,4 +111,8 @@ signals:
          * whenever Mouse selects something
-                 * 0left Button
-                 * 3Button released
+         * @param int button, the button that us pressed :
+                 *              0left Button
+                 *              3Button released
+         * @param int x, x position
+         * @param int y, y position
+         *
          * // numbering due to layout in old TEWidget
@@ -110,2 +123,4 @@ signals:
          * size of image changed
+         * @param int lines, line count of new size
+         * @param int columns, column count of new size
          */
@@ -115,2 +130,3 @@ signals:
          * cursor in history changed
+         * @param int value, value of history cursor
          */
@@ -125,2 +141,4 @@ signals:
          * selection begin
+         * @param const int x, x position
+         * @param const int y, y position
          */
@@ -131,2 +149,4 @@ signals:
          *  (from begin (s.a.) to x, y)
+         *  @param const int x, x position
+         *  @param const int y, y position
          */
@@ -136,3 +156,3 @@ signals:
          * selection end
-         *  bool: preserve line breaks in selection
+         * @param const bool lineBreakPreserve, preserve line breaks in selection
          */