問題タブ [appledoc]

For questions regarding programming in ECMAScript (JavaScript/JS) and its various dialects/implementations (excluding ActionScript). Note JavaScript is NOT the same as Java! Please include all relevant tags on your question; e.g., [node.js], [jquery], [json], [reactjs], [angular], [ember.js], [vue.js], [typescript], [svelte], etc.

0 投票する
2 に答える
986 参照

ios - Appledocとカスタムリンクの説明

馬鹿なことをしていると、事前にごめんなさい。しかし、エラーを特定できません。

コード(ヘッダーファイル)は次のとおりです。

結果:

ここに画像の説明を入力してください

私はこれらの指示に従っています(「カスタムリンクの説明」セクション)。

私も試しました:

たぶんXcodeはファイルを台無しにしていますか?2番目の関連する質問で、Xcodeがエディターで自動的にリンクを作成するのをブロックする方法があるかどうか知っていますか?(フォントの色を青に変更して下線を引くことを意味します)。

前もって感謝します。

0 投票する
1 に答える
322 参照

github - appledoc を使用して GitHub プロジェクトにドキュメントを追加する

GitHub のいくつかのプロジェクトには、Appledoc で作成され、username.github.com/project/Documentation でホストされているドキュメント ページがあることに気付きました。例えば:

プロジェクト: http://pandamonia.github.com/BlocksKit/
ドキュメント: http://pandamonia.github.com/BlocksKit/Documentation/

これはどのように作動しますか?自分のプロジェクトでこれを行う方法はありますか?

0 投票する
1 に答える
146 参照

documentation - Appledoc のマクロまたは動的プレースホルダー

私の iOS プロジェクトでは、一部のクラスのドキュメントにスクリーンショット イメージを追加しました。
ドキュメントはappledocで生成されます。

基本的に、クラスのTheViewController場合、これは次のようになります。


これを乾かす方法はありますか?
マクロ、前処理 ( preprocess-headerdoc? 経由)、動的プレースホルダー、スクリプト、appledoc に供給されるオプション?

理想的には、私はこれをしたいと思います:




行を追加する必要さえなく、何らかの条件が満たされた場合にのみコンテンツが追加される場合のボーナスポイントSCREENSHOTS_FOR_IPAD_AND_IPHONE(つまり、期待される場所に画像が見つかった場合)。

0 投票する
0 に答える
1258 参照

objective-c - AppCode で appledoc を使用してドキュメントを生成する方法はありますか?

または、(他のドキュメントジェネレーターを使用して) AppCode で動作させる方法はありますか?

0 投票する
1 に答える
357 参照

xcode - AppleDoc カテゴリがクイックヘルプに表示されない

インストール手順に従って、AppleDoc でドキュメントセットを正常に生成しました。XCode Documentation Organiser に入ると、カテゴリを含むすべてがそこにあります。

ここに画像の説明を入力

しかし、私が⌥</kbd>-click on one of my category methods I see nothing but this:

ここに画像の説明を入力

私は多くのことを試しましたが、これらのどれも機能しません:

  • --no-merge-categories の追加
  • --merge-categories の追加
  • ファイル拡張子の変更
  • XCode を再起動する
  • マックブックを再起動する
  • Google で検索 (AppleDoc クイックヘルプ カテゴリ)
  • 検索スタックオーバーフロー
  • gitHub リポジトリの問題一覧を検索 ( https://github.com/tomaz/appledoc )

ドキュメントを生成したいのですが、私のライブラリのほとんどはカテゴリで構成されているため、助けてください。最新の AppleDoc (appledoc 2.1 (ビルド 858)) と Xcode 4.6.3 を使用しています。

編集: 実際に AppleDoc を使用しているユーザーはいますか? クイックヘルプは実際に役に立ちますか? また、リポジトリは定期的に更新されていますが、ドキュメントが不足していることにも注意してください。

0 投票する
1 に答える
928 参照

ios - Appledoc 例外: 少なくとも 1 つのディレクトリまたはファイル名のパスが必要です

上記のコマンドを入力すると、エラーが発生します。

少なくとも 1 つのディレクトリまたはファイル名のパスが必要です。' appledoc --help'を使用してください

gogopiao_v2は私のプロジェクトのルート ディレクトリです。誰かが問題を解決してくれることを願っています。

0 投票する
1 に答える
276 参照

protocols - Appledoc を使用してインライン プロトコルを文書化する方法

@interface の前のヘッダーで @protocol インラインを定義する Objective-C @class を定義しました。

プロトコルのドキュメントを生成するためのappledocを取得できません。インラインで可能ですか、それともプロトコルを別のファイルにする必要がありますか?

0 投票する
1 に答える
494 参照

ios - 入力パラメーター クラスへの Appledoc 参照が強調表示されないのはなぜですか?

Apple のドキュメントには、入力パラメータの相互参照があります。あなたはそれを見ることができNSStringEncodingNSError強調表示されています:ここに画像の説明を入力

しかし、appledoc を使用すると、相互参照がまったくありません。ここに画像の説明を入力

これは私の設定ファイルです:

どうしたの?

0 投票する
1 に答える
439 参照

ios - xcodeビルドフェーズの実行スクリプトでappledocが有効かどうかを確認する方法は?

ご存知のように、xcode ビルド フェーズの実行スクリプト用に sh スクリプトを記述できます。そして、リリース版のプロジェクトとソフトウェアのappledocが既にインストールされている場合にのみ実行したいので、次のように記述します。

まったく機能していないようです!問題はコマンド「which appledoc」が間違っていたことです。質問は次のとおりです。