Adding Custom Documentation to Overridden Functions

Question

I've been trying to get into the habit of adding Apple's variant of Markdown documentation to all functions that I write. However, I'm unsure how to add this documentation to show up in quicklook windows. Is it possible to replace, or ideally append to existing documentation?

For example, in this picture, the quicklook window shows the existing Markdown documentation instead of the documentation that I've written above.

user3151675 · Accepted Answer · 2018-02-07 16:36:40Z

1

Sadly, there seems to be no way to do this.

You can define a new function with its own documentation that calls the overridden function and nothing else.

Example:

/**
 custom documentation
 */
func viewDidLoadOverridden() {
    viewDidLoad()
}

Result:

answered Feb 7, 2018 at 16:36

user3151675

58.4k29 gold badges186 silver badges240 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

Dafurman Over a year ago

Bummer, over a year and there’s still no good way of doing this. I think your idea is interesting, but a bit too much of a workaround for my liking (imagine trying to get a team of devs to agree to write functions like that as a workaround for documentation).

Collectives™ on Stack Overflow

Adding Custom Documentation to Overridden Functions

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related