Search code examples
xcodeformattingdocumentationmarkup

Why doesn't asterisk work in Xcode Quick Help markup?

As Markup Formatting Reference states, you can use *,+ or - characters as prefixes for markup keywords. For example, take a look at Parameter:

enter image description here

Now, when I try to use *, markup doesn't work:

/**
 * Parameter piece: A piece to validate.
 * Parameter matchBlock: Called only if necessary.
 */
init(piece: MSPiece?, matchBlock: MatchBlock) { ... }

The above code results in: enter image description here

But if we put + or - instead of *,

/**
 + Parameter piece: A piece to validate.
 - Parameter matchBlock: Called only if necessary.
 */
init(piece: MSPiece?, matchBlock: MatchBlock) { ... }

The documentation will be correct: enter image description here

Why doesn't * work? It would be actually cool to use an asterisk because /** */ comment stats and ends with asterisk and it would be really neat.

Solution

  • It was a bug and it's fixed in Xcode 10.0.