コードを文書化するために HeaderDoc を使用していますが、文書内の他のメソッドにリンクしたいと考えています。HTML を生成しようとはしていませんが (少なくとも今のところ)、Xcode の右側のパネルに表示させたいと思っています。-applicationDidEnterBackground:
以下は、 Xcode で表示されるのドキュメントです。自分で書いた他のメソッドを参照する青いリンクを実現したい:
ドキュメントには を使用するように書かれています@link
が、うまくいかないようです:
これが私が試したことです:
/**
* @abstract Returns an array with a copy of all elements in the heap in sorted order.
*
* @discussion The original heap remains unchanged. This getter uses Heap Sort which takes O(n log n),
* although it copies the heap first (in linear time). If losing the elements on the heap is
* acceptable you should use @link -removeAllObjectsWithArray: @/link instead, which is faster.
*/
結果は次のとおりです。
ご覧のとおり、正しくレンダリングされていません。私は壊れているここを読みました@link
が、コメントは2013年にさかのぼります.修正はありますか? 私はそれを間違っていますか?
編集:私はサンタの提案を試みました、これは結果です:
/**
* @abstract Whether the heap is empty.
*
* @discussion An empty heap contains no objects, in which case this property returns <code>YES</code>.
* Returns <code>NO</code> otherwise, which also implies that calls to {@link count}
* return zero.
*/
次のようにレンダリングします。