Make XCode's documentation command span multiple words?

Asked Sep 30 '14 at 07:19

Active Feb 21 '15 at 15:56

Viewed 163 times

4

A lot of the new documentation commands for XCode has been discussed here, but even with the commands explained there, I can't seem to find a way to make a command span multiple words.

Let me give an example:

Input: Hi, I am for @a cosmetic purposes only.

Output: Hi, I am for cosmetic purposes only.

Nothing wrong there, but imagine me wanting to make the word purposes italic as well. There the problem starts. I tried:

Input: Hi, I am for @a cosmetic @a purposes only.

Output: Hi, I am for cosmeticpurposes only.

--

Input: Hi, I am for @a cosmetic <any amount of spaces> @a purposes only.

Output: Hi, I am for cosmeticpurposes only.

--

Input: Hi, I am for @a cosmetic @a @a purposes only.

Output: Hi, I am for cosmeticpurposes only.

--

Input: Hi, I am for @a cosmetic @a @a @a purposes only.

Output: Hi, I am for cosmeticpurposes only.

--

Input: Hi, I am for @a cosmetic <line break> @a purposes only.

Output: Hi, I am for cosmeticpurposes only.

--

As you can see, I can't seem to find a way to do it. Somehow all whitespaces seem to get trimmed. Does anyone knows a solution to this one?

edited May 23 '17 at 11:50

Community

1
1

asked Sep 30 '14 at 07:19

Gerald Eersteling

1,244
14
28

2 Answers2

4

I'm not sure if you already knew this or not but the following works for XCode 6:

Italic:

Hi, I am for <em>cosmetic purposes</em> only.

Bold:

Hi I am for <b>cosmetic purposes</b> only.

I am currently looking for a solution to @c, couldn't find one yet.

Edit: Oh well, <code>...</code> works for @c.

answered Feb 21 '15 at 15:56

mostruash

4,169
1
23
40

By the way, try out HTML tags, most of them works! You might be surprised with `
`, `
```
` etc.
```

Feb 21 '15 at 16:02

Yeah, I just tried a lot of HTML..indeed surprising how that just works. Makes documenting your code that much better! – Gerald Eersteling Feb 22 '15 at 14:01

`` works in the way that if underlines and colours it like a link but it doesn't open the url :(. Maybe could someone tweak it to make it work, or even better, to redirect to another method like Apple own documentation does. – Iulian Onofrei Mar 31 '15 at 13:56

I guess you can make it work using a `href` attribute but you need to generate a docset to be able to follow links as you do in Apple's docs. – mostruash Mar 31 '15 at 14:55

0

You can put space in following way:

/*! Sample @a italic &#x200B; @a comment  */

just putting blank space code in between two tags

answered Nov 06 '14 at 07:16

Mehul Thakkar

12,440
10
52
81

This still doesn't make the code span multiple words but, it is a nice workaround though. Until there is some way to really solve it, I'll use it. – Gerald Eersteling Nov 06 '14 at 08:39
you can try other special character code too :http://www.sagehill.net/docbookxsl/SpecialChars.html, many of them may work for you – Mehul Thakkar Nov 06 '14 at 08:57
Thanks, I was aware of the usage of character codes in the documentation. But I was hoping for a 'true' way to make a span in documentation (i.e. the tag in HTML). – Gerald Eersteling Nov 06 '14 at 10:39
I dont think there may be such things available for documentation, still not sure – Mehul Thakkar Nov 07 '14 at 06:57
Hm. Since Xcode6 and Swift were coming, I was secretly hoping for them to add new documentation commands as well. Alas, nothing yet. Currently scanning Apple-docs if they _do_ use a span or something. – Gerald Eersteling Nov 07 '14 at 07:45
1

Will tell you if i get it anywhere – Mehul Thakkar Nov 07 '14 at 09:07