reflow comments in platform/{mediastream,scroll}

third_party/WebKit/Source/platform/scroll/ScrollableArea.h

 /*
  * Copyright (C) 2008, 2011 Apple Inc. All Rights Reserved.
  *
  * Redistribution and use in source and binary forms, with or without
  * modification, are permitted provided that the following conditions
  * are met:
  * 1. Redistributions of source code must retain the above copyright
  *    notice, this list of conditions and the following disclaimer.
  * 2. Redistributions in binary form must reproduce the above copyright
  *    notice, this list of conditions and the following disclaimer in the
@@ skipping 54 matching lines @@
   static int pixelsPerLineStep(HostWindow*);
   static float minFractionToStepWhenPaging();
   static int maxOverlapBetweenPages();
 
   // Convert a non-finite scroll value (Infinity, -Infinity, NaN) to 0 as
   // per http://dev.w3.org/csswg/cssom-view/#normalize-non_finite-values.
   static double normalizeNonFiniteScroll(double value) {
     return std::isfinite(value) ? value : 0.0;
   }
 
-  // The window that hosts the ScrollableArea. The ScrollableArea will communicate scrolls and repaints to the
-  // host window in the window's coordinate space.
+  // The window that hosts the ScrollableArea. The ScrollableArea will
+  // communicate scrolls and repaints to the host window in the window's
+  // coordinate space.
   virtual HostWindow* getHostWindow() const { return 0; }
 
   virtual ScrollResult userScroll(ScrollGranularity, const FloatSize&);
 
   virtual void setScrollPosition(const DoublePoint&,
                                  ScrollType,
                                  ScrollBehavior = ScrollBehaviorInstant);
   virtual void scrollBy(const DoubleSize&,
                         ScrollType,
                         ScrollBehavior = ScrollBehaviorInstant);
   void setScrollPositionSingleAxis(ScrollbarOrientation,
                                    double,
                                    ScrollType,
                                    ScrollBehavior = ScrollBehaviorInstant);
 
-  // Scrolls the area so that the given rect, given in the document's content coordinates, such that it's
-  // visible in the area. Returns the new location of the input rect relative once again to the document.
-  // Note, in the case of a Document container, such as FrameView, the output will always be the input rect
-  // since scrolling it can't change the location of content relative to the document, unlike an overflowing
-  // element.
+  // Scrolls the area so that the given rect, given in the document's content
+  // coordinates, such that it's visible in the area. Returns the new location
+  // of the input rect relative once again to the document.
+  // Note, in the case of a Document container, such as FrameView, the output
+  // will always be the input rect since scrolling it can't change the location
+  // of content relative to the document, unlike an overflowing element.
   virtual LayoutRect scrollIntoView(const LayoutRect& rectInContent,
                                     const ScrollAlignment& alignX,
                                     const ScrollAlignment& alignY,
                                     ScrollType = ProgrammaticScroll);
 
-  // Returns a rect, in the space of the area's backing graphics layer, that contains the visual
-  // region of all scrollbar parts.
+  // Returns a rect, in the space of the area's backing graphics layer, that
+  // contains the visual region of all scrollbar parts.
   virtual LayoutRect visualRectForScrollbarParts() const = 0;
 
   static bool scrollBehaviorFromString(const String&, ScrollBehavior&);
 
   void contentAreaWillPaint() const;
   void mouseEnteredContentArea() const;
   void mouseExitedContentArea() const;
   void mouseMovedInContentArea() const;
   void mouseEnteredScrollbar(Scrollbar&) const;
   void mouseExitedScrollbar(Scrollbar&) const;
@@ skipping 10 matching lines @@
   bool hasOverlayScrollbars() const;
   void setScrollbarOverlayStyle(ScrollbarOverlayStyle);
   void recalculateScrollbarOverlayStyle(Color);
   ScrollbarOverlayStyle getScrollbarOverlayStyle() const {
     return static_cast<ScrollbarOverlayStyle>(m_scrollbarOverlayStyle);
   }
 
   // This getter will create a ScrollAnimatorBase if it doesn't already exist.
   ScrollAnimatorBase& scrollAnimator() const;
 
-  // This getter will return null if the ScrollAnimatorBase hasn't been created yet.
+  // This getter will return null if the ScrollAnimatorBase hasn't been created
+  // yet.
   ScrollAnimatorBase* existingScrollAnimator() const {
     return m_scrollAnimator;
   }
 
   ProgrammaticScrollAnimator& programmaticScrollAnimator() const;
   ProgrammaticScrollAnimator* existingProgrammaticScrollAnimator() const {
     return m_programmaticScrollAnimator;
   }
 
   virtual CompositorAnimationTimeline* compositorAnimationTimeline() const {
     return nullptr;
   }
 
   // See Source/core/layout/README.md for an explanation of scroll origin.
   const IntPoint& scrollOrigin() const { return m_scrollOrigin; }
   bool scrollOriginChanged() const { return m_scrollOriginChanged; }
 
-  // This is used to determine whether the incoming fractional scroll offset should
-  // be truncated to integer. Current rule is that if preferCompositingToLCDTextEnabled()
-  // is disabled (which is true on low-dpi device by default) we should do the truncation.
-  // The justification is that non-composited elements using fractional scroll offsets
-  // is causing too much nasty bugs but does not add too benefit on low-dpi devices.
+  // This is used to determine whether the incoming fractional scroll offset
+  // should be truncated to integer. Current rule is that if
+  // preferCompositingToLCDTextEnabled() is disabled (which is true on low-dpi
+  // device by default) we should do the truncation.  The justification is that
+  // non-composited elements using fractional scroll offsets is causing too much
+  // nasty bugs but does not add too benefit on low-dpi devices.
   virtual bool shouldUseIntegerScrollOffset() const {
     return !RuntimeEnabledFeatures::fractionalScrollOffsetsEnabled();
   }
 
   virtual bool isActive() const = 0;
   virtual int scrollSize(ScrollbarOrientation) const = 0;
   void setScrollbarNeedsPaintInvalidation(ScrollbarOrientation);
   virtual bool isScrollCornerVisible() const = 0;
   virtual IntRect scrollCornerRect() const = 0;
   void setScrollCornerNeedsPaintInvalidation();
@@ skipping 21 matching lines @@
       const Scrollbar& scrollbar,
       const IntPoint& parentPoint) const {
     return scrollbar.Widget::convertFromContainingWidget(parentPoint);
   }
 
   virtual Scrollbar* horizontalScrollbar() const { return nullptr; }
   virtual Scrollbar* verticalScrollbar() const { return nullptr; }
 
   // scrollPosition is relative to the scrollOrigin. i.e. If the page is RTL
   // then scrollPosition will be negative. By default, scrollPositionDouble()
-  // just call into scrollPosition(). Subclass can override scrollPositionDouble()
-  // to return floating point precision scrolloffset.
+  // just call into scrollPosition(). Subclass can override
+  // scrollPositionDouble() to return floating point precision scrolloffset.
   // FIXME: Remove scrollPosition(). crbug.com/414283.
   virtual IntPoint scrollPosition() const = 0;
   virtual DoublePoint scrollPositionDouble() const {
     return DoublePoint(scrollPosition());
   }
   virtual IntPoint minimumScrollPosition() const = 0;
   virtual DoublePoint minimumScrollPositionDouble() const {
     return DoublePoint(minimumScrollPosition());
   }
   virtual IntPoint maximumScrollPosition() const = 0;
   virtual DoublePoint maximumScrollPositionDouble() const {
     return DoublePoint(maximumScrollPosition());
   }
 
   virtual DoubleRect visibleContentRectDouble(
       IncludeScrollbarsInRect = ExcludeScrollbars) const;
   virtual IntRect visibleContentRect(
       IncludeScrollbarsInRect = ExcludeScrollbars) const;
   virtual int visibleHeight() const { return visibleContentRect().height(); }
   virtual int visibleWidth() const { return visibleContentRect().width(); }
   virtual IntSize contentsSize() const = 0;
   virtual IntPoint lastKnownMousePosition() const { return IntPoint(); }
 
   virtual bool shouldSuspendScrollAnimations() const { return true; }
   virtual void scrollbarStyleChanged() {}
   virtual void scrollbarVisibilityChanged() {}
   virtual bool scrollbarsCanBeActive() const = 0;
 
-  // Returns the bounding box of this scrollable area, in the coordinate system of the enclosing scroll view.
+  // Returns the bounding box of this scrollable area, in the coordinate system
+  // of the enclosing scroll view.
   virtual IntRect scrollableAreaBoundingBox() const = 0;
 
   virtual bool scrollAnimatorEnabled() const { return false; }
 
   // NOTE: Only called from Internals for testing.
   void setScrollOffsetFromInternals(const IntPoint&);
 
   IntPoint clampScrollPosition(const IntPoint&) const;
   DoublePoint clampScrollPosition(const DoublePoint&) const;
 
@@ skipping 41 matching lines @@
   bool hasLayerForVerticalScrollbar() const;
   bool hasLayerForScrollCorner() const;
 
   void layerForScrollingDidChange(CompositorAnimationTimeline*);
 
   void cancelScrollAnimation();
   virtual void cancelProgrammaticScrollAnimation();
 
   virtual ~ScrollableArea();
 
-  // Called when any of horizontal scrollbar, vertical scrollbar and scroll corner is setNeedsPaintInvalidation.
+  // Called when any of horizontal scrollbar, vertical scrollbar and scroll
+  // corner is setNeedsPaintInvalidation.
   virtual void scrollControlWasSetNeedsPaintInvalidation() = 0;
 
   // Returns the default scroll style this area should scroll with when not
   // explicitly specified. E.g. The scrolling behavior of an element can be
   // specified in CSS.
   virtual ScrollBehavior scrollBehaviorStyle() const {
     return ScrollBehaviorInstant;
   }
 
   // TODO(bokan): This is only used in FrameView to check scrollability but is
@@ skipping 64 matching lines @@
   void clearNeedsPaintInvalidationForScrollControls() {
     m_horizontalScrollbarNeedsPaintInvalidation = false;
     m_verticalScrollbarNeedsPaintInvalidation = false;
     m_scrollCornerNeedsPaintInvalidation = false;
   }
 
  private:
   void programmaticScrollHelper(const DoublePoint&, ScrollBehavior);
   void userScrollHelper(const DoublePoint&, ScrollBehavior);
 
-  // This function should be overriden by subclasses to perform the actual scroll of the content.
+  // This function should be overriden by subclasses to perform the actual
+  // scroll of the content.
   virtual void setScrollOffset(const DoublePoint& offset, ScrollType) = 0;
 
   virtual int lineStep(ScrollbarOrientation) const;
   virtual int pageStep(ScrollbarOrientation) const;
   virtual int documentStep(ScrollbarOrientation) const;
   virtual float pixelStep(ScrollbarOrientation) const;
 
   mutable Member<ScrollAnimatorBase> m_scrollAnimator;
   mutable Member<ProgrammaticScrollAnimator> m_programmaticScrollAnimator;
 
   unsigned m_scrollbarOverlayStyle : 2;  // ScrollbarOverlayStyle
 
   unsigned m_scrollOriginChanged : 1;
 
   unsigned m_horizontalScrollbarNeedsPaintInvalidation : 1;
   unsigned m_verticalScrollbarNeedsPaintInvalidation : 1;
   unsigned m_scrollCornerNeedsPaintInvalidation : 1;
 
-  // There are 6 possible combinations of writing mode and direction. Scroll origin will be non-zero in the x or y axis
-  // if there is any reversed direction or writing-mode. The combinations are:
+  // There are 6 possible combinations of writing mode and direction. Scroll
+  // origin will be non-zero in the x or y axis if there is any reversed
+  // direction or writing-mode. The combinations are:
   // writing-mode / direction     scrollOrigin.x() set    scrollOrigin.y() set
   // horizontal-tb / ltr          NO                      NO
   // horizontal-tb / rtl          YES                     NO
   // vertical-lr / ltr            NO                      NO
   // vertical-lr / rtl            NO                      YES
   // vertical-rl / ltr            YES                     NO
   // vertical-rl / rtl            YES                     YES
   IntPoint m_scrollOrigin;
 };
 
 }  // namespace blink
 
 #endif  // ScrollableArea_h