Bug 1016184 part 1 - Correct documentation in nsCaret.h. r=ehsan
authorTing-Yu Lin <tlin@mozilla.com>
Mon, 14 Jul 2014 23:18:00 +0200
changeset 216071 2019701bcc487c2c546ef96f18a940848484de67
parent 216070 877406ac6f1d3934d356d859a7f181886185bdf1
child 216072 05547f6e8c03328c2027f34fedc3c8f2db463191
push id515
push userraliiev@mozilla.com
push dateMon, 06 Oct 2014 12:51:51 +0000
treeherdermozilla-release@267c7a481bef [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewersehsan
bugs1016184
milestone33.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1016184 part 1 - Correct documentation in nsCaret.h. r=ehsan
layout/base/nsCaret.h
--- a/layout/base/nsCaret.h
+++ b/layout/base/nsCaret.h
@@ -41,35 +41,35 @@ class nsCaret : public nsISelectionListe
     void    Terminate();
 
     nsISelection*    GetCaretDOMSelection();
     nsresult    SetCaretDOMSelection(nsISelection *inDOMSel);
 
     /** GetCaretVisible will get the visibility of the caret
      *  This function is virtual so that it can be used by nsCaretAccessible
      *  without linking
-     *  @param inMakeVisible true it is shown, false it is hidden
-     *  @return false if and only if inMakeVisible is null, otherwise true 
+     *  @param outMakeVisible true if it is shown, false if it is hidden
+     *  @return NS_OK
      */
     virtual nsresult    GetCaretVisible(bool *outMakeVisible);
 
     /** SetCaretVisible will set the visibility of the caret
      *  @param inMakeVisible true to show the caret, false to hide it
      */
     void    SetCaretVisible(bool intMakeVisible);
 
     /** SetCaretReadOnly set the appearance of the caret
      *  @param inMakeReadonly true to show the caret in a 'read only' state,
-     *	    false to show the caret in normal, editing state
+     *         false to show the caret in normal, editing state
      */
     void    SetCaretReadOnly(bool inMakeReadonly);
 
     /** GetCaretReadOnly get the appearance of the caret
-     *	@return true if the caret is in 'read only' state, otherwise,
-     *	    returns false
+     *  @return true if the caret is in 'read only' state, otherwise,
+     *          returns false
      */
     bool GetCaretReadOnly()
     {
       return mReadOnly;
     }
 
     /**
      * Gets the position and size of the caret that would be drawn for
@@ -227,23 +227,23 @@ protected:
 
     nsCOMPtr<nsITimer>    mBlinkTimer;
 
     // XXX these fields should go away and the values be acquired as needed,
     // probably by ComputeMetrics.
     uint32_t              mBlinkRate;         // time for one cyle (on then off), in milliseconds
     nscoord               mCaretWidthCSSPx;   // caret width in CSS pixels
     float                 mCaretAspectRatio;  // caret width/height aspect ratio
-    
+
     bool                  mVisible;           // is the caret blinking
 
     bool                  mDrawn;             // Denotes when the caret is physically drawn on the screen.
     bool                  mPendingDraw;       // True when the last on-state draw was suppressed.
 
-    bool                  mReadOnly;          // it the caret in readonly state (draws differently)      
+    bool                  mReadOnly;          // it the caret in readonly state (draws differently)
     bool                  mShowDuringSelection; // show when text is selected
 
     bool                  mIgnoreUserModify;
 
     bool                  mKeyboardRTL;       // is the keyboard language right-to-left
     bool                  mBidiUI;            // is bidi UI turned on
     nsRect                mHookRect;          // directional hook on the caret
     uint8_t               mLastBidiLevel;     // saved bidi level of the last draw request, to use when we erase