diff options
| author | Michael Williamson <mike@zwobble.org> | 2016-03-25 11:26:42 +0000 |
|---|---|---|
| committer | Michael Williamson <mike@zwobble.org> | 2016-03-25 11:26:42 +0000 |
| commit | 53a408351d8a267350613babaa08957a0897ce28 (patch) | |
| tree | f47ae836337e2de3ced97b74d5b35d2f4c9eb373 | |
| parent | ceca8b2d7c425b7d91401656638672f5c3c30771 (diff) | |
Document default idPrefix
| -rw-r--r-- | README.md | 1 | ||||
| -rw-r--r-- | src/main/java/org/zwobble/mammoth/DocumentConverter.java | 1 |
2 files changed, 2 insertions, 0 deletions
@@ -204,6 +204,7 @@ Methods: * `DocumentConverter idPrefix(String idPrefix)`: a string to prepend to any generated IDs, such as those used by bookmarks, footnotes and endnotes. + Defaults to the empty string. #### `Result<T>` diff --git a/src/main/java/org/zwobble/mammoth/DocumentConverter.java b/src/main/java/org/zwobble/mammoth/DocumentConverter.java index b523bba..abd99bb 100644 --- a/src/main/java/org/zwobble/mammoth/DocumentConverter.java +++ b/src/main/java/org/zwobble/mammoth/DocumentConverter.java @@ -40,6 +40,7 @@ public class DocumentConverter { /** * A string to prepend to any generated IDs, * such as those used by bookmarks, footnotes and endnotes. + * Defaults to the empty string. */ public DocumentConverter idPrefix(String idPrefix) { return new DocumentConverter(options.idPrefix(idPrefix)); |
