public class CodeSnippetExtractor extends Object
A code snippet is a sample of source codes with a title and a short description that serves to illustrate a specific code usage. Code snippets can either provide a single snippet or contain a list of steps, each one with a title and a description.
| Constructor and Description |
|---|
CodeSnippetExtractor()
Construct a code snippet extractor.
|
| Modifier and Type | Method and Description |
|---|---|
List<CodeSnippetDTO> |
extract(String... directoryPaths)
Extract a list of code snippet by analyzing source codes contained in the
directory paths given in argument.
|
public CodeSnippetExtractor()
public List<CodeSnippetDTO> extract(String... directoryPaths)
Code snippets are ordered as they appear in the directories (files are first sorted in a lexicographic order).
directoryPaths - a list of directory paths from which code snippets
are looked up.Copyright © 2021. All rights reserved.