Markdown in Xcode 12.5.1

I'm trying to document my code using the Markdown, but it doesn't matter what I do, I am not seeing what I've typed show up when I ctrl-click a function and left click Show Quick Help.

Quick Help shows the parameters of the function, but it does not show the function description I typed or the description for the parameters that I typed.

Is there something I am doing wrong or I've not set within Xcode?

I went through the preferences and didn't see anything that appeared to affect displaying of Markdown.

Up vote post of southernyankee Down vote post of southernyankee
1k views
Posted by
southernyankee
Reply
Add a Comment

Accepted Reply

Put the comment above the function declaration!

/// this is just an example of markdown.
///
/// - Parameters:
///     - someString: A simple string.
///     - someInteger: A simple integer
func myFunction(someString: String, someInteger: Int) {
Posted by
robnotyou
Up vote reply of robnotyou Down vote reply of robnotyou
Post marked as solved
Add a Comment

Replies

Put the comment above the function declaration!

/// this is just an example of markdown.
///
/// - Parameters:
///     - someString: A simple string.
///     - someInteger: A simple integer
func myFunction(someString: String, someInteger: Int) {
Posted by
robnotyou
Up vote reply of robnotyou Down vote reply of robnotyou
Post marked as solved
Add a Comment