Fixed usage of |variable| markup in comments.

Reviewers: O1 Material components iOS, featherless Reviewed By: O1 Material components iOS, featherless Subscribers: featherless Tags: #material_components_ios Differential Revision: http://codereview.cc/D1042
material-components · Jun 27, 2016 · f971eef · f971eef
1 parent 4365ebb
commit f971eef
Show file tree

Hide file tree

Showing 11 changed files with 16 additions and 16 deletions.
diff --git a/components/AppBar/src/MDCAppBar.m b/components/AppBar/src/MDCAppBar.m
@@ -138,7 +138,7 @@ - (UIBarButtonItem *)backButtonItem {
 
   UIViewController *iterator = fhvParent;
 
-  // In complex cases it might actually be a parent of |fhvParent| which is on the nav stack.
+  // In complex cases it might actually be a parent of @c fhvParent which is on the nav stack.
   while (index == NSNotFound && iterator && ![iterator isEqual:navigationController]) {
     iterator = iterator.parentViewController;
     index = [viewControllerStack indexOfObject:iterator];

diff --git a/components/Buttons/src/MDCButton.h b/components/Buttons/src/MDCButton.h
@@ -67,7 +67,7 @@
 
 /**
  A custom title color for the non-disabled states. The default is nil, which means that the button
- chooses its title color automatically based on |underlyingColor|, whether the button is opaque,
+ chooses its title color automatically based on @c underlyingColor, whether the button is opaque,
  its current background color, etc.
 
  Setting this to a non-nil color overrides that logic, and the caller is responsible for ensuring

diff --git a/components/CollectionCells/src/MDCCollectionViewCell.h b/components/CollectionCells/src/MDCCollectionViewCell.h
@@ -51,14 +51,14 @@ typedef NS_ENUM(NSUInteger, MDCCollectionViewCellAccessoryType) {
 @property(nonatomic) UIEdgeInsets accessoryInset;
 
 /**
- Whether to hide the separator for this cell. If not set, the |shouldHideSeparators| property of
+ Whether to hide the separator for this cell. If not set, the @c shouldHideSeparators property of
  the collection view styler will be used. Defaults to NO.
  */
 @property(nonatomic) BOOL shouldHideSeparator;
 
 /**
  The separator inset for this cell. Only left/right insets are valid as top/bottom insets will be
- ignored. If this property is not changed, the |separatorInset| property of the collection view
+ ignored. If this property is not changed, the @c separatorInset property of the collection view
  styler will be used instead. Defaults to UIEdgeInsetsZero.
  */
 @property(nonatomic) UIEdgeInsets separatorInset;

diff --git a/components/Collections/src/MDCCollectionViewEditingDelegate.h b/components/Collections/src/MDCCollectionViewEditingDelegate.h
@@ -287,7 +287,7 @@
 
 /**
  Sent to the receiver when a collection view section begins to swipe for dismissal. The
- collection view property |allowsSwipeToDismissSection| must be true in order for this
+ collection view property @c allowsSwipeToDismissSection must be true in order for this
  subsequent delegate method to be called. The collection view is NOT required to be in
  edit mode to allow swipe-to-dismiss sections. Returning NO here will prevent swiping the
  designated section. If not implemented, will default to NO.

diff --git a/components/Collections/src/MDCCollectionViewStylingDelegate.h b/components/Collections/src/MDCCollectionViewStylingDelegate.h
@@ -41,7 +41,7 @@
 
 /**
  Asks the delegate for the cell style at the specified collection view section index. All
- remaining sections to have their cells styled per the styler |cellStyle| property.
+ remaining sections to have their cells styled per the styler @c cellStyle property.
 
  @param collectionView The collection view.
  @param section The collection view section.

diff --git a/components/Collections/src/private/MDCCollectionInfoBarView.h b/components/Collections/src/private/MDCCollectionInfoBarView.h
@@ -63,7 +63,7 @@ typedef NS_ENUM(NSUInteger, MDCCollectionInfoBarViewStyle) {
  @param infoBar The MDCCollectionInfoBarView info bar.
  @param animated YES the transition will be animated; otherwise, NO.
  @param willAutoDismiss YES the info bar will be auto-dismissed after the time interval
-        set in |autoDismissAfterDuration|.
+        set in @c autoDismissAfterDuration.
  */
 - (void)infoBar:(nonnull MDCCollectionInfoBarView *)infoBar
     willShowAnimated:(BOOL)animated
@@ -75,7 +75,7 @@ typedef NS_ENUM(NSUInteger, MDCCollectionInfoBarViewStyle) {
  @param infoBar The MDCCollectionInfoBarView info bar.
  @param animated YES the transition was animated; otherwise, NO.
  @param willAutoDismiss YES the info bar will be auto-dismissed after the time interval
-        set in |autoDismissAfterDuration|.
+        set in @c autoDismissAfterDuration.
  */
 - (void)infoBar:(nonnull MDCCollectionInfoBarView *)infoBar
     didShowAnimated:(BOOL)animated
@@ -87,7 +87,7 @@ typedef NS_ENUM(NSUInteger, MDCCollectionInfoBarViewStyle) {
  @param infoBar The MDCCollectionInfoBarView info bar.
  @param animated YES the transition will be animated; otherwise, NO.
  @param willAutoDismiss YES the info bar will be auto-dismissed after the time interval
-        set in |autoDismissAfterDuration|.
+        set in @c autoDismissAfterDuration.
  */
 - (void)infoBar:(nonnull MDCCollectionInfoBarView *)infoBar
     willDismissAnimated:(BOOL)animated

diff --git a/components/Collections/src/private/MDCCollectionViewEditor.m b/components/Collections/src/private/MDCCollectionViewEditor.m
@@ -536,7 +536,7 @@ - (void)panToDismissWithRecognizer:(UIPanGestureRecognizer *)recognizer {
       // Update the tracked item's position and alpha.
       CGAffineTransform transform;
       CGFloat alpha;
-      // The item is fully opaque until it pans at least |kDismissalDistanceBeforeFading| points.
+      // The item is fully opaque until it pans at least @c kDismissalDistanceBeforeFading points.
       CGFloat panDistance = (CGFloat)fabs(translation.x) - kDismissalDistanceBeforeFading;
       if (panDistance > 0) {
         transform = [self transformItemDismissalToTranslationX:translation.x];
@@ -558,7 +558,7 @@ - (void)panToDismissWithRecognizer:(UIPanGestureRecognizer *)recognizer {
       CGFloat translationX = translation.x + momentumX;
 
       if (fabs(translationX) > [self distanceThresholdForDismissal]) {
-        // |translationX| is only guaranteed to be over the dismissal threshold;
+        // @c translationX is only guaranteed to be over the dismissal threshold;
         // make sure the view animates all the way off the screen.
         translationX = (CGFloat)copysign(
             MAX(fabs(translationX), CGRectGetWidth(_collectionView.bounds)), translationX);
@@ -603,7 +603,7 @@ - (CGAffineTransform)transformItemDismissalToTranslationX:(CGFloat)translationX
     correctedXTranslation = MIN(-kDismissalDistanceBeforeFading, correctedXTranslation);
   }
 
-  // Reverse |initialTranslation| and add |translation.x| to ensure that
+  // Reverse @c initialTranslation and add @c translation.x to ensure that
   // we pan along with the arc.
   CGAffineTransform reverseTranslation =
       CGAffineTransformMakeTranslation(correctedXTranslation, kDismissalArcYOffset);

diff --git a/components/Collections/src/private/MDCCollectionViewStyler.m b/components/Collections/src/private/MDCCollectionViewStyler.m
@@ -466,7 +466,7 @@ - (UIImage *)backgroundImageForCellLayoutAttributes:(MDCCollectionViewLayoutAttr
   BOOL isGroupedStyle = cellStyle == MDCCollectionViewCellStyleGrouped;
   BOOL isGridLayout = (_cellLayoutType == MDCCollectionViewCellLayoutTypeGrid);
   if (!isCardStyle && !isGroupedStyle) {
-    // If not card or grouped style, revert |isBottom| to allow drawing separator at bottom.
+    // If not card or grouped style, revert @c isBottom to allow drawing separator at bottom.
     isBottom = NO;
   }
   CGFloat borderRadius = (isCardStyle) ? kCollectionViewCellDefaultBorderRadius : 0.0f;

diff --git a/components/Ink/src/MDCInkTouchController.m b/components/Ink/src/MDCInkTouchController.m
@@ -137,7 +137,7 @@ - (void)handleInkGesture:(MDCInkGestureRecognizer *)recognizer {
       break;
     case UIGestureRecognizerStateChanged: {
       // Due to changes on iPhone 6s, possibly due to the force touch,
-      // |UIGestureRecognizerStateChanged| constantly fires. However, we do not want to cancel the
+      // @c UIGestureRecognizerStateChanged constantly fires. However, we do not want to cancel the
       // ink unless the users moves.
       if (_shouldRespondToTouch && !CGPointEqualToPoint(touchLocation, _previousLocation)) {
         _shouldRespondToTouch = NO;

diff --git a/components/private/ThumbTrack/src/MDCThumbTrack.h b/components/private/ThumbTrack/src/MDCThumbTrack.h
@@ -197,7 +197,7 @@
             userGenerated:(BOOL)userGenerated
                completion:(nullable void (^)())completion;
 
-/** Set the |icon| shown on the thumb. */
+/** Set the @c icon shown on the thumb. */
 - (void)setIcon:(nullable UIImage *)icon;
 
 @end

diff --git a/components/private/ThumbTrack/src/MDCThumbView.h b/components/private/ThumbTrack/src/MDCThumbView.h
@@ -27,7 +27,7 @@
 /** The corner radius of the thumbview layer. */
 @property(nonatomic, assign) CGFloat cornerRadius;
 
-/** Set the |icon| shown on the thumb. */
+/** Set the @c icon shown on the thumb. */
 - (void)setIcon:(nullable UIImage *)icon;
 
 @end