You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Oct 17, 2021. It is now read-only.
SwiftMarkup parses Swift Markup from documentation comments
into structured documentation entities.
import SwiftMarkup
letmarkdown=#"""Creates a new bicycle with the provided parts and specifications.- Remark: Satisfaction guaranteed!The word *bicycle* first appeared in English print in 1868to describe "Bysicles and trysicles" on the"Champs Elysées and Bois de Boulogne".- Parameters: - style: The style of the bicycle - gearing: The gearing of the bicycle - handlebar: The handlebar of the bicycle - frameSize: The frame size of the bicycle, in centimeters- Returns: A beautiful, brand-new bicycle, custom-built just for you."""#letdocumentation=tryDocumentation.parse(markdown)
documentation.summary?.description // "Creates a new bicycle with the provided parts and specifications."
documentation.discussionParts.count // 2
if case .callout(let remark)= documentation.discussionParts[0]{
_ = remark.content // "Satisfaction guaranteed\\!"
}if case .paragraph(let paragraph)= documentation.discussionParts[1]{
_ = paragraph.description // "The word *bicycle* first appeared in English print in 1868 [ ... ]"
}
documentation.parameters[0].name // "style"
documentation.parameters[0]?.content.description // "The style of the bicycle"
documentation.returns?.description // A beautiful, brand-new bicycle, custom-built just for you.