I am adding some description to my method in class. This is how I achieved this:
And it looks like this upon clicking...
How can I make the underlined method clickable? I want it to be referenced so that when a user clicks on it, they are directed to a particular web page for documentation.
Is it even possible?
Thanks in advance, any help will be appreciated
You can link to another method by tagging it with /// - Tag:
and referring to it by Tag
using the x-source-tag://[Tag]
scheme like so:
/// - Tag: someMethod
func someMethod() {
...
}
/// Make sure to call [someMethod](x-source-tag://someMethod) at some point when overriding.
func otherMethod() {
...
}
Clicking on the someMethod
link in the Quick Help pop-over will take you to the method and flash-highlight it in yellow.
This link solved my problem
Particularly, this is how I went about it
Thanks to Oleg for the link
Use this
/**
* <#Description#>
*
* @link UILabel <#UILabel description#>
*
* @return <#return value description#>
*/
Or you can try vvDocumenter for giving comments