Swift documentation: instance/type property/method notation

Viewed 621

To document Ruby, I'd write, eg, Time::now or Time#day. How do I document Swift?

That is, when documenting Swift, what is the notation for a type and its 1) type property or method or 2) instance property or method?

For example, in Ruby documentation, the symbol :: (two colons) denotes a class property or method, and the symbol # (number sign, hash, hashtag, or pound sign) denotes an instance property or method. So, Time::now means that now is a class property or method of Time, and Time#day means that day is an instance property or method of Time.

Does Swift documentation have such a notation syntax?

I know Swift documentation's function notation—for example, that the Swift append(_ newElement: Element) method for Array is documented as append(_:)—because I see many examples of this notation in Apple's documentation. But, how do I write Array#append(_:) for Swift?

2 Answers
Related