Skip to content

Commit

Permalink
Minor Javadoc cleanup of enabledBlockTypes
Browse files Browse the repository at this point in the history
  • Loading branch information
robinst committed Jan 6, 2017
1 parent b28bc74 commit 8c5934a
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions commonmark/src/main/java/org/commonmark/parser/Parser.java
Original file line number Diff line number Diff line change
Expand Up @@ -121,30 +121,30 @@ public Builder extensions(Iterable<? extends Extension> extensions) {
/**
* Describe the list of markdown features the parser will recognize and parse.
* <p>
* By default, Commonmark will recognize and parse the following set of core markdown features:
* By default, CommonMark will recognize and parse the following set of "block" elements:
*
* <ul>
* <li>{@link Heading} ({@code #})
* <li>{@link HtmlBlock} ({@code <html></html>})
* <li> {@link ThematicBreak} (Horizontal Rule) ({@code ---})
* <li>{@link ThematicBreak} (Horizontal Rule) ({@code ---})
* <li>{@link FencedCodeBlock} ({@code ```})
* <li>{@link IndentedCodeBlock}
* <li>{@link BlockQuote} ({@code >})
* <li>{@link ListBlock} (Ordered / Unordered List) ({@code 1. / *})
* </ul>
*
* <p>
* To parse only a subset of the features listed above, pass a list of each feature's associated Node class.
* To parse only a subset of the features listed above, pass a list of each feature's associated {@link Block} class.
* <p>
* E.g., to only parse Headings and Lists:
* E.g., to only parse headings and lists:
* <pre>
* {@code
* Parser.builder().enabledBlockTypes(Heading.class, ListBlock.class);
* Parser.builder().enabledBlockTypes(new HashSet<>(Arrays.asList(Heading.class, ListBlock.class)));
* }
* </pre>
*
* @param enabledBlockTypes A list of nodes the parser will parse.
* If this list is empty, the parser will not recognize any Commonmark core markdown features.
* @param enabledBlockTypes A list of block nodes the parser will parse.
* If this list is empty, the parser will not recognize any CommonMark core features.
*
* @return {@code this}
*/
Expand Down

0 comments on commit 8c5934a

Please sign in to comment.