Hands-On Design Patterns with Swift

The anatomy of a documentation block

The documentation blocks come in a predetermined structure. Most of your documentation will use the following five sections:

• Summary: What your function does, always at the top of the documentation. This is also the first paragraph of your documentation comment.
• Discussion: Additional information about your function. This will be rendered with all other paragraphs, except the first one.
• Returned values: You can add more information about what your function returns by starting your line with Returns:.
• Parameters: Each parameter of your function can be described with Parameter <name>:.
• Thrown errors: You can provide additional information about the errors your method can throw by using Throws:.

The Parameters ...