[Formatter] remove obvious comments
authorYaroslav Lepenkin <yaroslav.lepenkin@jetbrains.com>
Tue, 15 Nov 2016 10:09:01 +0000 (13:09 +0300)
committerYaroslav Lepenkin <yaroslav.lepenkin@jetbrains.com>
Tue, 15 Nov 2016 11:32:19 +0000 (14:32 +0300)
platform/lang-api/src/com/intellij/formatting/Alignment.java
platform/lang-impl/src/com/intellij/formatting/AbstractBlockAlignmentProcessor.java
platform/lang-impl/src/com/intellij/formatting/AlignmentImpl.java

index 68eb0d6ee900f47ee3faa591adc05ae0f35d04f0..48ad2b4f32edf0a75f84c445b05e9e87c2bd0793 100644 (file)
@@ -22,8 +22,8 @@ import org.jetbrains.annotations.NotNull;
  * alignment object instance from the <code>getAlignment</code> method
  * are aligned with each other.
  *
- * @see com.intellij.formatting.Block#getAlignment()
- * @see com.intellij.formatting.ChildAttributes#getAlignment()
+ * @see Block#getAlignment()
+ * @see ChildAttributes#getAlignment()
  */
 
 public abstract class Alignment {
@@ -36,23 +36,10 @@ public abstract class Alignment {
     myFactory = factory;
   }
 
-  /**
-   * Shorthand for calling {@link #createAlignment(boolean)} with <code>'false'</code>.
-   *
-   * @return      alignment object with default settings
-   */
   public static Alignment createAlignment() {
     return createAlignment(false, Anchor.LEFT);
   }
 
-  /**
-   * Delegates the processing to {@link #createAlignment(boolean, Anchor)} with given <code>'allow backward shift'</code> value
-   * and {@link Anchor#LEFT}.
-   *
-   * @param allowBackwardShift    flag that specifies if former aligned block may be shifted to right in order to align to subsequent
-   *                              aligned block
-   * @return                      alignment object with the given <code>'allow backward shift'</code> setting
-   */
   public static Alignment createAlignment(boolean allowBackwardShift) {
     return createAlignment(allowBackwardShift, Anchor.LEFT);
   }
index f3571b6d7c03d5714e3424aaacedd7dfaf412b90..c202510eabbe6c4409de1d769af86f780329f94e 100644 (file)
@@ -20,12 +20,6 @@ import org.jetbrains.annotations.Nullable;
 
 import java.util.Set;
 
-/**
- * Gof Template Method for {@link BlockAlignmentProcessor}.
- * 
- * @author Denis Zhdanov
- * @since 4/29/11 11:52 AM
- */
 public abstract class AbstractBlockAlignmentProcessor implements BlockAlignmentProcessor {
 
   @Override
index 3af772a999e20e5fe40472ebfb05ae2480419514..35b60ee4db4a79a1392720f4ddbd5cfea53470b3 100644 (file)
@@ -33,20 +33,10 @@ public class AlignmentImpl extends Alignment {
   private AlignmentImpl myParentAlignment;
   private ProbablyIncreasingLowerboundAlgorithm<LeafBlockWrapper> myOffsetRespBlocksCalculator;
 
-  /**
-   * Creates new <code>AlignmentImpl</code> object with <code>'false'</code> as <code>'allows backward shift'</code> argument flag.
-   */
   AlignmentImpl() {
     this(false, Anchor.LEFT);
   }
 
-  /**
-   * Creates new <code>AlignmentImpl</code> object with the given <code>'allows backward shift'</code> argument flag.
-   *
-   * @param allowBackwardShift    flag that indicates if it should be possible to shift former aligned block to right
-   *                              in order to align to subsequent aligned block (see {@link Alignment#createAlignment(boolean, Anchor)})
-   * @param anchor                alignment anchor (see {@link Alignment#createAlignment(boolean, Anchor)})
-   */
   AlignmentImpl(boolean allowBackwardShift, @NotNull Anchor anchor) {
     myAllowBackwardShift = allowBackwardShift;
     myAnchor = anchor;