-
- All Superinterfaces:
DocumentContext,GraphContext
- All Known Subinterfaces:
MutableDocumentation
public interface Documentation extends GraphContext, DocumentContext
Documentation about something- Author:
- Don Mendelson
-
-
Field Summary
Fields Modifier and Type Field Description static StringMARKDOWNDefault documentation format-
Fields inherited from interface io.fixprotocol.md.event.DocumentContext
UNKNOWN_POSITION
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description StringgetDocumentation()Return the contentsStringgetFormat()Returns the format of the documentation.-
Methods inherited from interface io.fixprotocol.md.event.DocumentContext
getCharPositionInLine, getLine
-
Methods inherited from interface io.fixprotocol.md.event.GraphContext
getParent
-
-
-
-
Field Detail
-
MARKDOWN
static final String MARKDOWN
Default documentation format- See Also:
- Constant Field Values
-
-
Method Detail
-
getDocumentation
String getDocumentation()
Return the contents- Returns:
- documentation
-
getFormat
String getFormat()
Returns the format of the documentation. This corresponds to infostring of a fenced code block, as defined by the markdown specification. Originally, it was the name of a programming language to support syntax-specific highlighting. However, it has been extended to support various encodings, such as XML. In some cases, it may map to a media type.- Returns:
- the format of documentation
-
-