Package org.sonar.python

Class DocstringExtractor

java.lang.Object

org.sonar.python.DocstringExtractor

public class DocstringExtractor
extends Object

Extractor of docstring tokens.

Reminder: a docstring is a string literal that occurs as the first statement in a module, function, class, or method definition.

Method Summary

Modifier and Type	Method	Description
static StringLiteral	extractDocstring(StatementList statements)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

extractDocstring

public static StringLiteral extractDocstring(@Nullable
                                             StatementList statements)