Можно ли включать примеры кода при использовании HeaderDoc или Doxygen?

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

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

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

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


objective-c documentation-generation doxygen
person BWHazel    schedule 02.01.2011    source источник

Ответы (2)


arrow_upward
4
arrow_downward

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

/*!
   <pre>
   @textblock
   - (void)foo {
      // bar
   }
   @/textblock
   </pre>
*/
person polesen    schedule 18.08.2011

arrow_upward
2
arrow_downward

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

/**
 \code
 NSLog(@"Hello, World!");
 \endcode
*/
person BWHazel    schedule 05.01.2011