Xcode code completion custom descriptions

Question

For some methods, Xcode's code completion / suggestion / auto-complete feature displays descriptions:

When I create classes, functions, variables, and what not and do provide descriptions, the description does not show up:

However, in the quick help menu on the right hand side, and when clicking alt+click, it does:

I tried this "solution", but it did not work. Is there any special characters I need to include in the description?

Note

I am currently on Xcode 9 beta 1, but I also experienced this issue in Xcode 8.

Update

Glad to say that it now works for me in Xcode 9 GM.

Nitish · Accepted Answer · 2017-06-28T11:27:34.570

3

I think the reason might be that there is no space after ///.
Right way should be

/// This is a description

As a matter of fact, if you add documentation for a function as mentioned in screenshot, comments are itself added wherein you can see that space is there after ///. Which is intact the right way to add comments/documentation.
Once you option click on the function calling, description is displayed.
The way Apple displays the description in autocomplete is something it does by itself. You may want to use AppleDoc for this.

edited Jun 28 '17 at 11:27

answered Jun 28 '17 at 11:18

Nitish

13,845
28
135
263

Uhh for me that does not seem to work. I also hit `shift+cmd+k` to clean, but it still does not appear. – LinusGeffarth Jun 28 '17 at 11:25
@LinusGeffarth : Edited my answer. Can you check again. – Nitish Jun 28 '17 at 11:28
You might have misunderstood my question: I'm not looking for the description to appear when option clicking - that already works. I want the description to show up when hitting `esc` to have the code suggestions pop up. (And whenever else the suggestions appear.) – LinusGeffarth Jun 28 '17 at 11:36
@LinusGeffarth : Correct. And that is why I have suggested AppleDoc in my answer :) That should solve your issue. – Nitish Jun 28 '17 at 11:37
Oh, right. If possible, I'd like to not use third party software… Thanks though! – LinusGeffarth Jun 28 '17 at 11:42

score 0 · Answer 2 · edited Jun 20 '20 at 09:12

0

Objective-C

1. Just add description before your method just like example.

@interface VVLabelBold : UILabel
-(void) setDefaultTextColor;

/**Disabled Label, This description will show in auto-complete*/
-(void) setDisabled;

@end

2 Call Method for UILabel

[lblSample setDisabled];

edited Jun 20 '20 at 09:12

Community

1
1

answered Apr 22 '19 at 06:28

Vivek

4,916
35
40

Xcode code completion custom descriptions

Note

Update

2 Answers2

Objective-C