From f26d7fe03e7b07b323059d15b3297756ff6424b9 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Yann=20C=C3=A9bron?= <yann.cebron@jetbrains.com>
Date: Wed, 3 Aug 2016 14:57:47 -0700
Subject: [PATCH] DomExtender: some javadoc

---
 .../intellij/util/xml/reflect/DomExtender.java    | 15 ++++++++-------
 .../util/xml/reflect/DomExtensionsRegistrar.java  | 13 +++++++++++--
 2 files changed, 19 insertions(+), 9 deletions(-)

diff --git a/xml/dom-openapi/src/com/intellij/util/xml/reflect/DomExtender.java b/xml/dom-openapi/src/com/intellij/util/xml/reflect/DomExtender.java
index fa50a2a00909..b31cc58c68e4 100644
--- a/xml/dom-openapi/src/com/intellij/util/xml/reflect/DomExtender.java
+++ b/xml/dom-openapi/src/com/intellij/util/xml/reflect/DomExtender.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2000-2009 JetBrains s.r.o.
+ * Copyright 2000-2016 JetBrains s.r.o.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -20,18 +20,18 @@ import com.intellij.util.xml.DomElement;
 import org.jetbrains.annotations.NotNull;
 
 /**
- * Register DOM extenders via dom.extender extension point. Specify 2 attributes:
- *   domClass - the DOM element class for which this extender will be called. Should be equal to T.
- *   extenderClass - this class qualified name.
- *
- * For registering extenders, use "com.intellij.dom.extender" extension point.
+ * Register DOM extenders via {@code dom.extender} extension point. Specify 2 attributes:
+ * <ul>
+ * <li>domClass - the DOM element class for which this extender will be called, must be equal to T</li>
+ * <li>extenderClass - this class qualified name</li>
+ * </ul>
  *
  * @author peter
  */
 public abstract class DomExtender<T extends DomElement> {
 
   /**
-   * @param t DOM element where new children may be added to
+   * @param t         DOM element where new children may be added to
    * @param registrar a place to register your own DOM children descriptions
    */
   public abstract void registerExtensions(@NotNull T t, @NotNull final DomExtensionsRegistrar registrar);
@@ -39,6 +39,7 @@ public abstract class DomExtender<T extends DomElement> {
   /**
    * Makes stub building for extensions available.
    * To be compatible with general stubs contract, extension should NOT depend on anything beyond current file's content.
+   *
    * @since 13.1
    */
   public boolean supportsStubs() {
diff --git a/xml/dom-openapi/src/com/intellij/util/xml/reflect/DomExtensionsRegistrar.java b/xml/dom-openapi/src/com/intellij/util/xml/reflect/DomExtensionsRegistrar.java
index bcf836684384..12472f8d9cf7 100644
--- a/xml/dom-openapi/src/com/intellij/util/xml/reflect/DomExtensionsRegistrar.java
+++ b/xml/dom-openapi/src/com/intellij/util/xml/reflect/DomExtensionsRegistrar.java
@@ -22,16 +22,27 @@ import org.jetbrains.annotations.NotNull;
 import java.lang.reflect.Type;
 
 /**
+ * Allows runtime extension of DOM Model.
+ *
  * @author peter
  */
 public interface DomExtensionsRegistrar {
 
+  /**
+   * Register single occurence subtag extension.
+   */
   @NotNull
   DomExtension registerFixedNumberChildExtension(@NotNull XmlName name, @NotNull Type type);
 
+  /**
+   * Register multiple occurence subtag extension.
+   */
   @NotNull
   DomExtension registerCollectionChildrenExtension(@NotNull XmlName name, @NotNull Type type);
 
+  /**
+   * Register {@link com.intellij.util.xml.GenericAttributeValue} using given parameterType.
+   */
   @NotNull
   DomExtension registerGenericAttributeValueChildExtension(@NotNull XmlName name, final Type parameterType);
 
@@ -44,8 +55,6 @@ public interface DomExtensionsRegistrar {
   DomExtension registerAttributeChildExtension(@NotNull XmlName name, @NotNull final Type type);
 
   /**
-   * @param type
-   * @return
    * @see com.intellij.util.xml.CustomChildren
    */
   @NotNull