Search code examples
iosobjective-cdocumentationheaderdoc

How to add multiline comment in HeaderDoc


This is my code

/**
 *    In touchesBegan: it is considered if it was succesfull click. Automatically changes on/off images
 */
@interface WOC_OnOffImageButton : SKSpriteNode

And when I do alt-click on WOC_OnOffImageButton in popup inside Description I get In touchesBegan: it is considered if it was succesfull click. Automatically changes on/off images all in one line.

I would like to have new line between ... click. Automatically..., because that it is easier to read.

Question
Is it posible, and if so, how to do it ?


Solution

  • enter image description here

    Yes, AppleDoc supports multiline comments. Here's how you use them:

     /**
     *    In touchesBegan: it is considered if it was succesfull click.
     *
     *    Automatically changes on/off images
     */
    

    The key is to put asterisks on the new lines. You may need to Save (Cmd+S) and/or Clean (Cmd+Shift+K) your project to see the result in a popup window.