Add javadoc for new settingsAnchor parameter of PyFunctionBuilder and PyDocstringGene...
authorMikhail Golubev <mikhail.golubev@jetbrains.com>
Thu, 24 Sep 2015 10:54:04 +0000 (13:54 +0300)
committerMikhail Golubev <mikhail.golubev@jetbrains.com>
Fri, 25 Sep 2015 12:38:33 +0000 (15:38 +0300)
python/src/com/jetbrains/python/documentation/docstrings/PyDocstringGenerator.java
python/src/com/jetbrains/python/psi/impl/PyFunctionBuilder.java

index b319b1b775d999320c8fc99995d3196f27f95fea..3bea55856ffb38b7a7c246b3ce644ea67d61fe10 100644 (file)
@@ -95,6 +95,11 @@ public class PyDocstringGenerator {
     return new PyDocstringGenerator(owner, docStringText, DocStringUtil.getConfiguredDocStringFormat(owner), indentation, owner);
   }
   
+  /**
+   * @param settingsAnchor any PSI element, presumably in the same file/module where generated function is going to be inserted.
+   *                       It's needed to detect configured docstring format and Python indentation size and, as result, 
+   *                       generate properly formatted docstring. 
+   */
   @NotNull
   public static PyDocstringGenerator create(@NotNull DocStringFormat format, @NotNull String indentation, @NotNull PsiElement settingsAnchor) {
     return new PyDocstringGenerator(null, null, format, indentation, settingsAnchor);
@@ -109,6 +114,11 @@ public class PyDocstringGenerator {
                                     docString);
   }
 
+  /**
+   * @param settingsAnchor any PSI element, presumably in the same file/module where generated function is going to be inserted.
+   *                       It's needed to detect configured docstring format and Python indentation size and, as result, 
+   *                       generate properly formatted docstring. 
+   */
   @NotNull
   public static PyDocstringGenerator update(@NotNull DocStringFormat format,
                                             @NotNull String indentation,
index 9a27f2fbee2a254e0a49971fb7d4b427cc6fe7b3..a3ad0223e8a58ce127ea5057bbb4a34d7ccc3f3d 100644 (file)
@@ -80,6 +80,11 @@ public class PyFunctionBuilder {
     myDocStringGenerator = null;
   }
 
+  /**
+   * @param settingsAnchor any PSI element, presumably in the same file/module where generated function is going to be inserted.
+   *                       It's needed to detect configured docstring format and Python indentation size and, as result, 
+   *                       generate properly formatted docstring. 
+   */
   public PyFunctionBuilder(@NotNull String name, @NotNull PsiElement settingsAnchor) {
     myName = name;
     myDocStringGenerator = PyDocstringGenerator.create(DocStringUtil.getConfiguredDocStringFormat(settingsAnchor),