BuildEnterHandler: Add note about newer platform API
We directly add a comment to the code as this is the only place we'll
notice when we need to touch this file in the future (e.g. when it
potentially breaks in newer IntelliJ versions).
@@ -53,9 +53,14 @@ import com.intellij.util.text.CharArrayUtil;
import javax.annotation.Nullable;
/**
- * Inserts indents as appropriate when enter is pressed.<br>
- * This is a substitute for implementing a full FormattingModel for the BUILD language. If we ever
- * decide to do that, this code should be removed.
+ * Inserts indents as appropriate when enter is pressed.
+ *
+ * <p>This is a substitute for implementing a full FormattingModel for the BUILD language. If we
+ * ever decide to do that, this code should be removed.
+ *
+ * <p>By now, there's a better way to implement custom indent handling: {@link
+ * com.intellij.psi.codeStyle.lineIndent.LineIndentProvider}. If we need to rework this class in the
+ * future, we should switch to this other API.
*/
public class BuildEnterHandler extends EnterHandlerDelegateAdapter {
