Parameter

public struct Parameter : Fragment

Represents a parameter documentation in the proper format

  • Standard initializer.

    Declaration

    Swift

    public init(name: String, documentation: String)

    Parameters

    name

    The name of the parameter
    documentation

    The documentation that describes the parameter

Stored Properties

  • The name of the parameter

    Declaration

    Swift

    public let name: String

  • The documentation that describes the parameter

    Declaration

    Swift

    public let documentation: String

Methods

  • Renders this Parameter as a string.

    The String format is as follows:

    "   - \(self.name): \(self.documentation)"

    Declaration

    Swift

    @inlinable
public func renderContent() -> String