PY-16771 Never return null as description in section based docstrings

This commit is contained in:
Mikhail Golubev
2015-09-25 15:38:34 +03:00
parent 955263d152
commit 6d3d0a4be2
6 changed files with 7 additions and 1 deletions
@@ -27,6 +27,7 @@ import java.util.List;
public interface StructuredDocString {
String getSummary();
@NotNull
String getDescription(); // for formatter
@NotNull
@@ -50,6 +50,7 @@ public class EpydocString extends TagBasedDocString {
super(docstringText, "@");
}
@NotNull
@Override
public String getDescription() {
final String html = inlineMarkupToHTML(myDescription);
@@ -57,6 +57,7 @@ public class PlainDocString extends DocStringLineParser implements StructuredDoc
return mySummary;
}
@NotNull
@Override
public String getDescription() {
return myDescription;
@@ -299,9 +299,10 @@ public abstract class SectionBasedDocString extends DocStringLineParser implemen
return mySummary != null ? mySummary.concatTrimmedLines("\n") : "";
}
@NotNull
@Override
public String getDescription() {
return null;
return "";
}
@NotNull
@@ -123,6 +123,7 @@ public class SphinxDocString extends TagBasedDocString {
return paramName == null ? getTagValue("type") : getTagValue("type", paramName);
}
@NotNull
@Override
public String getDescription() {
return myDescription.replaceAll("\n", "<br/>");
@@ -74,6 +74,7 @@ public abstract class TagBasedDocString extends DocStringLineParser implements S
public abstract List<String> getAdditionalTags();
@NotNull
@Override
public String getDescription() {
return myDescription;