Bug 1515556 comment fix-ups for the tree reformat (layout/) r=Ehsan,heycam

Differential Revision: https://phabricator.services.mozilla.com/D13125

--HG--
extra : moz-landing-system : lando

layout/base/nsBidi.h

@@ -34,8 +34,8 @@ class nsBidi {
    * @param aText is a pointer to the single-paragraph text that the
    *      Bidi algorithm will be performed on
    *      (step (P1) of the algorithm is performed externally).
-   *      <strong>The text must be (at least) <code>aLength</code>
-   * long.</strong>
+   *      <strong>The text must be (at least) <code>aLength</code> long.
+   *      </strong>
    *
    * @param aLength is the length of the text; if <code>aLength==-1</code> then
    *      the text must be zero-terminated.

layout/base/nsCSSFrameConstructor.cpp

@@ -4232,15 +4232,15 @@ void nsCSSFrameConstructor::FinishBuildingScrollFrame(
  * scrollbars.
  *
  * @param aContent the content node of the child to wrap.
-
+ *
  * @param aScrolledFrame The frame of the content to wrap. This should not be
  * Initialized. This method will initialize it with a scrolled pseudo and no
  * nsIContent. The content will be attached to the scrollframe returned.
-
+ *
  * @param aContentStyle the style that has already been resolved for the content
  * being passed in.
  *
- * @param aParentFrame The parent to attach the scroll frame to
+ * @param aParentFrame   The parent to attach the scroll frame to
  *
  * @param aNewFrame The new scrollframe or gfx scrollframe that we create. It
  * will contain the scrolled frame you passed in. (returned) If this is not

layout/forms/nsComboboxControlFrame.cpp

@@ -793,8 +793,8 @@ void nsComboboxControlFrame::Reflow(nsPresContext* aPresContext,
     return;
   }
 
-  // Make sure the displayed text is the same as the selected option, bug
-  // 297389.
+  // Make sure the displayed text is the same as the selected option,
+  // bug 297389.
   if (!mDroppedDown) {
     mDisplayedIndex = mListControlFrame->GetSelectedIndex();
   }

layout/forms/nsComboboxControlFrame.h

@@ -125,7 +125,7 @@ class nsComboboxControlFrame final : public nsBlockFrame,
    * and FireOnChange() will be called.
    * @param aOn true if got focus, false if lost focus.
    * @param aRepaint if true then force repaint (NOTE: we always force repaint
-   * currently)
+   *        currently)
    * @note This method might destroy |this|.
    */
   MOZ_CAN_RUN_SCRIPT_BOUNDARY

layout/generic/nsBulletFrame.cpp

@@ -289,7 +289,7 @@ class BulletRenderer final {
   LayoutDeviceRect mPathRect;
 
   // mColor indicate the color of list-style. Both text and path type would use
-  // this memeber.
+  // this member.
   nscolor mColor;
 
   // mPath record the path of the list-style for later drawing.

layout/generic/nsColumnSetFrame.cpp

@@ -574,13 +574,15 @@ bool nsColumnSetFrame::ReflowChildren(ReflowOutput& aDesiredSize,
   if (colBSizeChanged) {
     mLastBalanceBSize = aConfig.mColMaxBSize;
     // XXX Seems like this could fire if incremental reflow pushed the column
-    // set down so we reflow incrementally with a different available height. We
-    // need a way to do an incremental reflow and be sure availableHeight
+    // set down so we reflow incrementally with a different available height.
+    // We need a way to do an incremental reflow and be sure availableHeight
     // changes are taken account of! Right now I think block frames with
     // absolute children might exit early.
-    // NS_ASSERTION(aKidReason != eReflowReason_Incremental,
-    //             "incremental reflow should not have changed the balance
-    //             height");
+    /*
+    NS_ASSERTION(
+        aKidReason != eReflowReason_Incremental,
+        "incremental reflow should not have changed the balance height");
+    */
   }
 
   // get our border and padding

layout/generic/nsFlexContainerFrame.cpp

@@ -1535,8 +1535,8 @@ static bool ResolveAutoFlexBasisFromRatio(
              "Should only be called to resolve an 'auto' flex-basis");
   // If the flex item has ...
   //  - an intrinsic aspect ratio,
-  //  - a [used] flex-basis of 'main-size' [auto?] [We have this, if we're
-  //  here.]
+  //  - a [used] flex-basis of 'main-size' [auto?]
+  //    [We have this, if we're here.]
   //  - a definite cross size
   // then the flex base size is calculated from its inner cross size and the
   // flex item’s intrinsic aspect ratio.

layout/generic/nsFrame.cpp

@@ -8010,13 +8010,11 @@ nsresult nsIFrame::PeekOffset(nsPeekOffsetStruct* aPos) {
       // mSawBeforeType means "we already saw characters of the type
       // before the boundary we're looking for". Examples:
       // 1. If we're moving forward, looking for a word beginning (i.e. a
-      // boundary
-      //    between whitespace and non-whitespace), then eatingWS==true means
-      //    "we already saw some whitespace".
+      //    boundary between whitespace and non-whitespace), then
+      //    eatingWS==true means "we already saw some whitespace".
       // 2. If we're moving backward, looking for a word beginning (i.e. a
-      // boundary
-      //    between non-whitespace and whitespace), then eatingWS==true means
-      //    "we already saw some non-whitespace".
+      //    boundary between non-whitespace and whitespace), then
+      //     eatingWS==true means "we already saw some non-whitespace".
       PeekWordState state;
       int32_t offsetAdjustment = 0;
       bool done = false;

layout/generic/nsIFrame.h

@@ -54,18 +54,18 @@
 /**
  * New rules of reflow:
  * 1. you get a WillReflow() followed by a Reflow() followed by a DidReflow() in
- * order (no separate pass over the tree)
+ *    order (no separate pass over the tree)
  * 2. it's the parent frame's responsibility to size/position the child's view
- * (not the child frame's responsibility as it is today) during reflow (and
- * before sending the DidReflow() notification)
+ *    (not the child frame's responsibility as it is today) during reflow (and
+ *    before sending the DidReflow() notification)
  * 3. positioning of child frames (and their views) is done on the way down the
- * tree, and sizing of child frames (and their views) on the way back up
+ *    tree, and sizing of child frames (and their views) on the way back up
  * 4. if you move a frame (outside of the reflow process, or after reflowing
- * it), then you must make sure that its view (or its child frame's views) are
- * re-positioned as well. It's reasonable to not position the view until after
- * all reflowing the entire line, for example, but the frame should still be
- * positioned and sized (and the view sized) during the reflow (i.e., before
- * sending the DidReflow() notification)
+ *    it), then you must make sure that its view (or its child frame's views)
+ *    are re-positioned as well. It's reasonable to not position the view until
+ *    after all reflowing the entire line, for example, but the frame should
+ *    still be positioned and sized (and the view sized) during the reflow
+ *    (i.e., before sending the DidReflow() notification)
  * 5. the view system handles moving of widgets, i.e., it's not our problem
  */
 
@@ -4384,8 +4384,9 @@ class nsIFrame : public nsQueryFrame {
   /**
    * Search for the first paragraph boundary before or after the given position
    * @param  aPos See description in nsFrameSelection.h. The following fields
-   * are used by this method: Input: mDirection Output: mResultContent,
-   * mContentOffset
+   *              are used by this method:
+   *              Input: mDirection
+   *              Output: mResultContent, mContentOffset
    */
   nsresult PeekOffsetParagraph(nsPeekOffsetStruct* aPos);
 

layout/generic/nsLineLayout.cpp

@@ -2182,9 +2182,9 @@ void nsLineLayout::VerticalAlignFrames(PerSpanData* psd) {
       //           to jam together when 'font-size-adjust' is enabled
       //           and layout is using dynamic font heights (bug 20394)
       //        -- Note #1: With this code enabled and with the fact that we are
-      //        not
-      //           using Em[Ascent|Descent] as nsDimensions for text metrics in
-      //           GFX mean that the discussion in bug 13072 cannot hold.
+      //           not using Em[Ascent|Descent] as nsDimensions for text
+      //           metrics in GFX mean that the discussion in bug 13072 cannot
+      //           hold.
       //        -- Note #2: We still don't want empty-text frames to interfere.
       //           For example in quirks mode, avoiding empty text frames
       //           prevents "tall" lines around elements like <hr> since the

layout/mathml/nsIMathMLFrame.h

@@ -130,7 +130,7 @@ class nsIMathMLFrame {
    *      and the process will feed upon itself.
    *
    * 2. Use TransmitAutomaticData() to set properties related to your
-   * descendants:
+   *    descendants:
    *    - set properties that depend on the state that you expect your
    *      descendants to have reached upon processing their own
    *      TransmitAutomaticData().

layout/mathml/nsMathMLContainerFrame.h

@@ -360,8 +360,9 @@ class nsMathMLContainerFrame : public nsContainerFrame, public nsMathMLFrame {
 // 1) line-breaking
 // 2) proper inter-frame spacing
 // 3) firing of Stretch() (in which case FinalizeReflow() would have to be
-// cleaned) Issues: If/when mathml becomes a pluggable component, the separation
-// will be needed.
+//    cleaned)
+// Issues: If/when mathml becomes a pluggable component, the separation will be
+// needed.
 class nsMathMLmathBlockFrame final : public nsBlockFrame {
  public:
   NS_DECL_QUERYFRAME

layout/mathml/nsMathMLmunderoverFrame.cpp

@@ -15,8 +15,9 @@
 using namespace mozilla;
 
 //
-// <munderover> -- attach an underscript-overscript pair to a base -
-// implementation <mover> -- attach an overscript to a base - implementation
+// <munderover> -- attach an underscript-overscript pair to a base
+//                 implementation
+// <mover> -- attach an overscript to a base - implementation
 // <munder> -- attach an underscript to a base - implementation
 //
 

layout/tables/celldata.h

@@ -66,8 +66,8 @@ class CellData {
    */
   uint32_t GetRowSpanOffset() const;
 
-  /** set the distance from the current entry to the corresponding origin of the
-   * rowspan
+  /** set the distance from the current entry to the corresponding origin of
+   * the rowspan
    * @param    the distance in the column to the originating cell
    */
   void SetRowSpanOffset(uint32_t aSpan);
@@ -77,8 +77,8 @@ class CellData {
    */
   bool IsColSpan() const;
 
-  /** get the distance from the current entry to the corresponding origin of the
-   * colspan
+  /** get the distance from the current entry to the corresponding origin of
+   *  the colspan
    * @return    containing the distance in the row to the originating cell
    */
   uint32_t GetColSpanOffset() const;
@@ -95,8 +95,8 @@ class CellData {
   bool IsOverlap() const;
 
   /** mark the current entry as spanned by a row- and a colspan
-   * @param aOverlap    if true mark the entry as covered by a row- and a
-   * colspan
+   * @param aOverlap    if true mark the entry as covered by a row- and
+   *                    a colspan
    */
   void SetOverlap(bool aOverlap);
 

layout/tables/nsCellMap.h

@@ -288,13 +288,13 @@ class nsCellMap {
    *
    * @param aMap               - reference to the table cell map
    * @param aCellFrame         - a pointer to the cellframe which will be
-   * appended to the row
+   *                             appended to the row
    * @param aRowIndex          - to this row the celldata entry will be added
    * @param aRebuildIfNecessay - if a cell spans into a row below it might be
    *                             necesserary to rebuild the cellmap as this
-   * rowspan might overlap another cell.
+   *                             rowspan might overlap another cell.
    * @param aDamageArea        - area in cellmap coordinates which have been
-   * updated.
+   *                             updated.
    * @param aColToBeginSearch  - if not null contains the column number where
    *                             the search for a empty or dead cell in the
    *                             row should start

layout/tables/nsTableRowFrame.h

@@ -89,8 +89,8 @@ class nsTableRowFrame : public nsContainerFrame {
    * Cells are resized in nsTableFrame::BalanceColumnWidths and
    * nsTableFrame::ShrinkWrapChildren
    *
-   * @param aDesiredSize width set to width of the sum of the cells, height set
-   * to height of cells with rowspan=1.
+   * @param aDesiredSize width set to width of the sum of the cells,
+   *                     height set to height of cells with rowspan=1.
    *
    * @see nsIFrame::Reflow
    * @see nsTableFrame::BalanceColumnWidths
@@ -296,8 +296,8 @@ class nsTableRowFrame : public nsContainerFrame {
   // cell if mHasFixedBSize is set
   nscoord mStyleFixedBSize;
 
-  // max-ascent and max-descent amongst all cells that have 'vertical-align:
-  // baseline'
+  // max-ascent and max-descent amongst all cells that have
+  // 'vertical-align: baseline'
   nscoord mMaxCellAscent;   // does include cells with rowspan > 1
   nscoord mMaxCellDescent;  // does *not* include cells with rowspan > 1
 

layout/tables/nsTableRowGroupFrame.h

@@ -291,8 +291,9 @@ class nsTableRowGroupFrame final : public nsContainerFrame,
 
   /**
    * Get the first row that might contain y-coord 'aY', or nullptr if you must
-   * search all rows. The actual row returned might not contain 'aY', but if
-   * not, it is guaranteed to be before any row which does contain 'aY'.
+   * search all rows.
+   * The actual row returned might not contain 'aY', but if not, it is
+   * guaranteed to be before any row which does contain 'aY'.
    * aOverflowAbove is the maximum over all rows of -row.GetOverflowRect().y.
    * To find all rows that intersect the vertical interval aY/aYMost, call
    * GetFirstRowContaining(aY, &overflowAbove), and then iterate through all

layout/xul/BoxObject.cpp

@@ -21,8 +21,7 @@
 #include "nsComponentManagerUtils.h"
 #include "mozilla/dom/BoxObjectBinding.h"
 
-// Implementation
-// /////////////////////////////////////////////////////////////////
+// Implementation /////////////////////////////////////////////////////////////
 
 namespace mozilla {
 namespace dom {
@@ -69,8 +68,7 @@ BoxObject::GetElement(Element** aResult) {
   return NS_OK;
 }
 
-// nsPIBoxObject
-// //////////////////////////////////////////////////////////////////////////
+// nsPIBoxObject //////////////////////////////////////////////////////////////
 
 nsresult BoxObject::Init(Element* aElement) {
   mContent = aElement;

layout/xul/grid/nsGrid.cpp

@@ -949,8 +949,8 @@ nscoord nsGrid::GetRowFlex(int32_t aIndex, bool aIsHorizontal) {
     // affect us. We need to do this for this case:
     // <grid>
     //   <rows>
-    //     <rows> // this is not flexible. So our children should not be
-    //     flexible
+    //     <rows> // this is not flexible.
+    //            // So our children should not be flexible
     //        <row flex="1"/>
     //        <row flex="1"/>
     //     </rows>