DocstringExtractor (Python :: Squid 1.14.1.3143 API)

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.

- Field Summary
  
  Fields
  Modifier and Type Field Description
  
  static Set<com.sonar.sslr.api.AstNodeType> DOCUMENTABLE_NODE_TYPES
- Method Summary
  
  All Methods Static Methods Concrete Methods
  Modifier and Type Method Description
  
  static com.sonar.sslr.api.Token extractDocstring(com.sonar.sslr.api.AstNode documentableNode)
  - Methods inherited from class java.lang.Object
    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DOCUMENTABLE_NODE_TYPES

public static final Set<com.sonar.sslr.api.AstNodeType> DOCUMENTABLE_NODE_TYPES

Method Detail

extractDocstring

public static com.sonar.sslr.api.Token extractDocstring(com.sonar.sslr.api.AstNode documentableNode)