appledoc icon indicating copy to clipboard operation
appledoc copied to clipboard

AppleDoc DON't support @textblock or @code

Open afatcoder opened this issue 2 years ago • 1 comments

Hi, rencently I used AppleDoc to generate API doc for Objective-C SDK. It is amazing. But I found it seems to not support @textblock and @code tag. I know appleDoc support to write code block with a tab or 4 (or more) spaces.. But I want to use @textblock or @code because which can show example code in quick help of XCode, as shown below. How can AppleDoc parse @textblock or @code tag? image

afatcoder avatar Jun 28 '22 03:06 afatcoder

You'll have to implement this yourself if you need it. It would require adding support to parser to detect the code block and report it into parsed data structure in the same way existing code does. Then it should get printed automatically during output generation. The simplest to get familiar and then change would be to open the project in Xcode, set cmd line arguments and breakpoints and run.

tomaz avatar Jun 28 '22 05:06 tomaz