Можно ли включить примеры кода при использовании HeaderDoc или Doxygen? - PullRequest
0 голосов
/ 02 января 2011

Я пишу фреймворк Cocoa в Objective-C и хотел бы использовать средство записи документации для генерации ссылки на API. Для .NET легко включить примеры, используя:

/// <example>
/// <code lang="c#">
/// Console.WriteLine("Hello, World!");
/// </code>
/// </example>

Возможно ли это при использовании инструмента Apple HeaderDoc, и если да, то как это будет сделано?

Если это невозможно, как бы я это сделал при использовании Doxygen?

Ответы [ 2 ]

4 голосов
/ 18 августа 2011

Для тех, кто использует Apple с уже установленным инструментом «headerdoc», он может выглядеть так:

<code>/*!
   <pre>
   @textblock
   - (void)foo {
      // bar
   }
   @/textblock
   
* /
2 голосов
/ 06 января 2011

Хорошо - у меня есть ответы! Я решил пойти с Doxygen:

/**
 \code
 NSLog(@"Hello, World!");
 \endcode
*/
...