From 3f856a4f76f3a527ad715e52a8cf90f31597b1e6 Mon Sep 17 00:00:00 2001 From: rods Date: Tue, 14 Apr 1998 20:48:14 +0000 Subject: [PATCH] fixed comment --- widget/public/nsIButton.h | 3 +-- widget/public/nsICheckButton.h | 2 +- widget/public/nsIRadioButton.h | 4 ++-- widget/public/nsIRadioGroup.h | 7 +++---- widget/public/nsIScrollbar.h | 8 ++++---- widget/public/nsIWidget.h | 20 ++++++++++++-------- 6 files changed, 23 insertions(+), 21 deletions(-) diff --git a/widget/public/nsIButton.h b/widget/public/nsIButton.h index c5e08eb5435a..f7ec5cb650ee 100644 --- a/widget/public/nsIButton.h +++ b/widget/public/nsIButton.h @@ -27,11 +27,10 @@ { 0x18032ad0, 0xb265, 0x11d1, \ { 0xaa, 0x2a, 0x0, 0x0, 0x0, 0x0, 0x0, 0x0 } } -/* +/** * Push button widget. * Automatically shows itself as depressed when clicked on. */ - class nsIButton : public nsIWidget { public: diff --git a/widget/public/nsICheckButton.h b/widget/public/nsICheckButton.h index acfef0202576..60f749f81b65 100644 --- a/widget/public/nsICheckButton.h +++ b/widget/public/nsICheckButton.h @@ -43,7 +43,7 @@ public: /** * Get the check state. - * @returns PRBool PR_TRUE if checked. PR_FALSE if unchecked. + * @return PRBool PR_TRUE if checked. PR_FALSE if unchecked. */ virtual PRBool GetState() = 0; diff --git a/widget/public/nsIRadioButton.h b/widget/public/nsIRadioButton.h index d0381855174e..32dee097c73b 100644 --- a/widget/public/nsIRadioButton.h +++ b/widget/public/nsIRadioButton.h @@ -55,7 +55,7 @@ class nsIRadioButton : public nsIButton { /** * Gets the state the RadioButton * - * @return BRBool PR_TRUE if set, PR_FALSE if unset + * @return PR_TRUE if set, PR_FALSE if unset * */ virtual PRBool GetState() = 0; @@ -63,7 +63,7 @@ class nsIRadioButton : public nsIButton { /** * Gets the RadioGroup associated with this button * - * @return nsIRadioGroup* its RadioGroup + * @return The Radio Group * */ virtual nsIRadioGroup* GetRadioGroup() = 0; diff --git a/widget/public/nsIRadioGroup.h b/widget/public/nsIRadioGroup.h index 56fa16941e00..b7b41dfcccbe 100644 --- a/widget/public/nsIRadioGroup.h +++ b/widget/public/nsIRadioGroup.h @@ -30,10 +30,9 @@ class nsIRadioButton; class nsIEnumerator; /** - * Help class for implementing a "group" of radio buttons + * Helper class for implementing a "group" of radio buttons * */ - class nsIRadioGroup : public nsISupports { @@ -54,7 +53,7 @@ public: virtual void Remove(nsIRadioButton * aRadioBtn) = 0; /** - * Setd the name of the RadioGroup + * Sets the name of the RadioGroup * @param aName The new name of the radio group * */ @@ -70,7 +69,7 @@ public: /** * Gets the enumeration of children - * @param nsIEnumerator* The enumeration of children (radio buttons) in the RadioGroup + * @return The enumeration of children (radio buttons) in the RadioGroup * */ virtual nsIEnumerator* GetChildren() = 0; diff --git a/widget/public/nsIScrollbar.h b/widget/public/nsIScrollbar.h index 41e75d009ba1..92c4f3e81918 100644 --- a/widget/public/nsIScrollbar.h +++ b/widget/public/nsIScrollbar.h @@ -49,7 +49,7 @@ public: /** * Get the scrollbar range - * @returns the upper end of the scrollbar range + * @return the upper end of the scrollbar range */ virtual PRUint32 GetMaxRange() = 0; @@ -62,7 +62,7 @@ public: /** * Get the thumb position. - * @returns a value between (startRange) and (endRange - thumbSize) + * @return a value between (startRange) and (endRange - thumbSize) * */ virtual PRUint32 GetPosition() = 0; @@ -76,7 +76,7 @@ public: /** * Get the thumb size. - * @returns size of the thumb. The value is between + * @return size of the thumb. The value is between * startRange and endRange */ virtual PRUint32 GetThumbSize() = 0; @@ -90,7 +90,7 @@ public: /** * Get the line increment. - * @returns size of the line increment. The value is + * @return size of the line increment. The value is * between startRange and endRange */ virtual PRUint32 GetLineIncrement() = 0; diff --git a/widget/public/nsIWidget.h b/widget/public/nsIWidget.h index 34f331498939..005e181e3934 100644 --- a/widget/public/nsIWidget.h +++ b/widget/public/nsIWidget.h @@ -81,6 +81,10 @@ enum nsCursor { eCursor_standard, eCursor_select, eCursor_hyperlink }; +/** + * The base class for all the widgets. It provides the interface for all basic and + * necessary functionality. + */ class nsIWidget : public nsISupports { public: @@ -107,11 +111,11 @@ class nsIWidget : public nsISupports { * toolkit is used. * */ - virtual void Create(nsIWidget *aParent, - const nsRect &aRect, - EVENT_CALLBACK aHandleEventFunction, + virtual void Create(nsIWidget *aParent, + const nsRect &aRect, + EVENT_CALLBACK aHandleEventFunction, nsIDeviceContext *aContext, - nsIToolkit *aToolkit = nsnull) = 0; + nsIToolkit *aToolkit = nsnull) = 0; /** * Create and initialize a widget with a native window parent @@ -231,7 +235,7 @@ class nsIWidget : public nsISupports { /** * Get the foreground color for this widget * - * @returns this widget's foreground color + * @return this widget's foreground color * */ virtual nscolor GetForegroundColor(void) = 0; @@ -248,7 +252,7 @@ class nsIWidget : public nsISupports { /** * Get the background color for this widget * - * @returns this widget's background color + * @return this widget's background color * */ @@ -266,7 +270,7 @@ class nsIWidget : public nsISupports { /** * Get the font for this widget * - * @returns the font metrics + * @return the font metrics */ virtual nsIFontMetrics* GetFont(void) = 0; @@ -282,7 +286,7 @@ class nsIWidget : public nsISupports { /** * Get the cursor for this widget. * - * @returns this widget's cursor. + * @return this widget's cursor. */ virtual nsCursor GetCursor(void) = 0;