DiscussionPart_String_Documentation_Callout_Documentation

DiscussionPart.String.Documentation.Callout.Documentation

Documentation for a Swift declaration.

public struct Documentation

Inheritance

DiscussionPart

Properties

`throws`

The documented error throwing behavior.

var `throws`: String?

discussionParts

The text segments and callouts that comprise the discussion, if any.

var discussionParts: [DiscussionPart] = []

isEmpty

Whether the documentation has any content.

var isEmpty: Bool

parameters

The documented parameters.

var parameters: [(name: String, description: String)] = []

returns

The documented return value.

var returns: String?

summary

The summary.

var summary: String?

Methods

==(lhs:rhs:)

public static func ==(lhs: Documentation, rhs: Documentation) -> Bool

hash(into:)

public func hash(into hasher: inout Hasher)

parse(_:)

Create and return documentation from Swift Markup text.

public static func parse(_ text: String?) throws -> Documentation

• Parameters
  • text: The documentation text in Swift Markup (CommonMark) format.

Throws

• CommonMark.Document.Error if the provided text can't be parsed.

Returns

A structured representation of the documentation.