From fb5755f95f3fa553f7ce0cf8ce6ae249a46f668a Mon Sep 17 00:00:00 2001 From: Dmitry Batrak Date: Mon, 25 May 2015 13:41:32 +0300 Subject: [PATCH] javadocs --- .../openapi/editor/impl/view/EditorCoordinateMapper.java | 7 +++++++ .../intellij/openapi/editor/impl/view/EditorPainter.java | 3 +++ .../openapi/editor/impl/view/EditorSizeManager.java | 3 +++ .../openapi/editor/impl/view/FontLayoutService.java | 4 ++++ .../intellij/openapi/editor/impl/view/IterationState.java | 4 ++++ .../editor/impl/view/VisualLineFragmentsIterator.java | 4 ++++ 6 files changed, 25 insertions(+) diff --git a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorCoordinateMapper.java b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorCoordinateMapper.java index 3c1b30befc2b..ffa1b1c8266e 100644 --- a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorCoordinateMapper.java +++ b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorCoordinateMapper.java @@ -24,6 +24,13 @@ import org.jetbrains.annotations.NotNull; import java.awt.*; +/** + * Performs transformations between various location representations in editor + * (offset, logical position, visual position, pixel coordinates). + * + * @see LogicalPosition + * @see VisualPosition + */ class EditorCoordinateMapper { private final EditorView myView; private final Document myDocument; diff --git a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorPainter.java b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorPainter.java index 934b5cf3af63..73936d0c3993 100644 --- a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorPainter.java +++ b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorPainter.java @@ -43,6 +43,9 @@ import javax.swing.*; import java.awt.*; import java.util.Collection; +/** + * Renders editor contents. + */ class EditorPainter { private static final Stroke IME_COMPOSED_TEXT_UNDERLINE_STROKE = new BasicStroke(1, BasicStroke.CAP_ROUND, BasicStroke.JOIN_ROUND, 0, new float[]{0, 2, 0, 2}, 0); diff --git a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorSizeManager.java b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorSizeManager.java index 15608b2445ae..882df8e34a7c 100644 --- a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorSizeManager.java +++ b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/EditorSizeManager.java @@ -34,6 +34,9 @@ import org.jetbrains.annotations.NotNull; import java.awt.*; import java.util.Collection; +/** + * Calculates width (in pixels) of editor contents. + */ class EditorSizeManager implements PrioritizedDocumentListener, Disposable, FoldingListener { private final EditorView myView; private final EditorImpl myEditor; diff --git a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/FontLayoutService.java b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/FontLayoutService.java index 65a6dd8eef69..fc99cddf03fe 100644 --- a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/FontLayoutService.java +++ b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/FontLayoutService.java @@ -23,6 +23,10 @@ import java.awt.*; import java.awt.font.FontRenderContext; import java.awt.font.GlyphVector; +/** + * Encapsulates logic related to font metrics. Mock instance can be used in tests to make them independent on font properties on particular + * platform. + */ public abstract class FontLayoutService { private static final FontLayoutService DEFAULT_INSTANCE = new DefaultFontLayoutService(); private static FontLayoutService INSTANCE = DEFAULT_INSTANCE; diff --git a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/IterationState.java b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/IterationState.java index ebd5d918fb4b..602073dfd193 100644 --- a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/IterationState.java +++ b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/IterationState.java @@ -42,6 +42,10 @@ import java.util.Arrays; import java.util.Comparator; import java.util.List; +/** + * Iterator over editor's text contents. Each iteration step corresponds to a text fragment having common graphical attributes + * (font style, foreground and background color, effect type and color). + */ // This class should replace com.intellij.openapi.editor.impl.IterationState when new editor rendering engine will become default public class IterationState { private static final Logger LOG = Logger.getInstance(IterationState.class); diff --git a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/VisualLineFragmentsIterator.java b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/VisualLineFragmentsIterator.java index 9aec6168f619..dddb61289a63 100644 --- a/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/VisualLineFragmentsIterator.java +++ b/platform/platform-impl/src/com/intellij/openapi/editor/impl/view/VisualLineFragmentsIterator.java @@ -25,6 +25,10 @@ import java.awt.*; import java.util.Iterator; import java.util.NoSuchElementException; +/** + * Iterator over visual line's fragments. Fragment's text has the same font and directionality. Collapsed fold regions are also represented + * as fragments. + */ class VisualLineFragmentsIterator implements Iterator { static Iterable create(final EditorView view, final int offset) {