-
Notifications
You must be signed in to change notification settings - Fork 0
rendering
-
filename: &str - a string slice representing the source filename with the source extension
-
elements: Vec - a vector full of markdown elements to be rendered
Writes a string to a file
Represents a chunk of comments to be rendered.
String
Holds the type of each parameter, currently either FUNC, VAR, CLASS
Vec<(String, String)>
Holds the raw source comments in a tuple, with the first element the
Vec
Holds a list of MarkdownElement's. Should be considered to be in order, and can be rendered simply by looping through. This instance variable will be built
-
raw_elements: Vec<(String, String)>- the raw extraction elements separated by type and content
-
Result<ParameterRep, SimpleError>- Either returns a parameter
&mut self
- String - string represenation of the markdown that can be dumped to a file.
Renders each ParameterRep based on its type, either as a class, var, or
-
&self
-
type_name: &str- the type contents to extract
-
Vec<String>- a Vector of contents associated with that type
Extracts and collects the content of raw_elements depending on the
Renders the markdown elements to a single String joined by newlines
- Steven Hanna - steventhanna@gmail.com
Representation of an arbritrary element to be represented in Markdown
String type that holds what kind of element the markdown should be
The text to be rendered out to the type
-
text - String - the text to be transformed to markdown
-
markdown_type - String - the type of element to render as
Creates a new markdown element that can be rendered
- String - the markdown representation of the object
Renders a MarkdownElement object to Markdown