-
Notifications
You must be signed in to change notification settings - Fork 2
Callout_Delimiter
A label that marks the beginning of a callout.
public enum Delimiter: Hashable Codable, Hashable, RawRepresentable
public init?(rawValue: String) public init(from decoder: Decoder) throws Highlighted information for the user of the symbol.
case attentionAn example of using the Attention callout:
The author of the code for a symbol.
case authorAn example of using the Author callout:
The authors of the code for a symbol.
case authorsAn example of using the Authors callout:
Aristotle
Other amazing classical folk
A bug for a symbol.
case bugAn example of using the Bug callout:
The algorithmic complexity of a method or function.
case complexityAn example of using the Complexity callout:
Copyright information for a symbol.
case copyrightAn example of using the Copyright callout:
A date associated with a symbol.
case dateAn example of using the Date callout:
Last date this example was changed
Days the method produces special results
A suggestion to the user for usage of a method or function.
case experimentAn example of using the Experiment callout:
Information that can have adverse effects on the tasks a user is trying to accomplish
case importantAn example of using the Important callout:
A condition that is guaranteed to be true during the execution of the documented symbol.
case invariantAn example of using the Invariant callout:
A note to the user of the symbol.
case noteAn example of using the Note callout:
A condition that must hold for the symbol to work.
case preconditionAn example of using the Precondition callout:
A condition of guaranteed values upon completion of the execution of the symbol.
case postconditionAn example of using the Postcondition callout:
A remark to the user of the symbol.
case remarkAn example of using the Remark callout:
A requirement for the symbol to work.
case requiresAn example of using the Requires callout:
A references to other information.
case seealsoAn example of using the SeeAlso callout:
Information about when the symbol became available, which may include dates, framework versions, and operating system versions.
case sinceAn example of using the Since callout:
A task required to complete or update the functionality of the symbol.
case todoAn example of using the ToDo callout:
Version information for the symbol.
case versionAn example of using the Version callout:
A warning for the user of the symbol.
case warningAn example of using the Warning callout:
A callout with a custom title.
case custom(String)An example of using a custom callout:
- Callout(Llama Spotting Tips): Pack warm clothes with your binoculars.
public var rawValue: String public func encode(to encoder: Encoder) throws Generated at 2021-06-10T10:51:02+0000 using swift-doc 1.0.0-rc.1.