問題タブ [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.
objective-c - 「appledoc」を使用して出力からプライベートメソッドを除外する方法は?
Objective-C(iOS)の静的ライブラリのドキュメントを作成するためにappledocを使用しています。ドキュメントは顧客向けに作成されており、私的な方法をドキュメント化したくありません。プライベートメソッドの文書化を防ぐには?
ios - CGImageCreateWithImageInRect がポイントで CGRect を取得するのに、ピクセルを使用するのはなぜですか?
CGImageCreateWithImageInRectに関するドキュメントは次のとおりです。
パラメータとして CGRect オブジェクトを取ります。私が理解していることから、CGRectはポイント単位です
ただし、ドキュメントには次のように記載されています。
「結果の長方形内のピクセルを参照し、長方形内の最初のピクセルをサブイメージの原点として扱います。」
これは不正確に思われ、UIImage のサイズを変更する必要があるときに証明されました。画像のサイズに画面のスケールを掛ける必要がありました。そうしないと、画像のサイズが間違っていました
縮尺を掛けないと、画像が小さすぎます。
これは悪いドキュメントです (ポイント単位の CGRect を取り、ピクセルとして読み取るべきではありません)、またはここで基本的なことを理解していませんか?
ios - appledoc/HeaderDoc でドキュメントをインデントする方法 (引数を取るブロックに関するドキュメント用)
ブロックをパラメーターとして持つメソッドを作成しました。ブロックはいくつかの引数を取るので、Apple が同様の形式を持つメソッドで行うように、ドキュメントをインデントしたいと思います...
これがコードでどのように見えるかの簡単な例は次のとおりです。
しかし、明らかに、これはドキュメントでは次のようにしか表示されません。
引数付きのブロックを取る Apple のメソッドのように、インデントを取得dataして表示するにはどうすればよいですか?fields
AppleのHeaderDocに関するドキュメントでこれを行う方法を見つけることができませんでした
ios - xcode プロジェクトの実行可能ファイルの拡張子は何ですか
先月、Apple Researchkit をダウンロードし、そのサンプルを実行しました。それはうまくいき、すべてがうまくいきました。今週私はそれを実行しようとしましたが、ビルドに失敗しました。エラーは、appledoc が必要だということです:
エラー: ResearchKit のドキュメントを作成するには、appledoc が必要です。http://appledoc.gentlebytes.comを参照してください。
私はいくつかの調査を行い、このページを見つけました
プロジェクトをダウンロードしてビルドしたところ、
ディレクトリを構築します。
しかし、このディレクトリにある実行可能ファイルが何であるか、パスに追加する方法がわかりませんでした。誰かが私を助けることができますか？どうもありがとう。
objective-c - コメントにコードを埋め込むときにappledocから参照エラーを取得する
次のようなコード コメントがあります。
したがって、コード例は 4 つのスペースでインデントされています。docset を appledoc でコンパイルすると、正しくコンパイルされ、生成した API リファレンスにコードがコードとして表示されます。ただし、XCode (doco の問題に関する警告を作成する appledoc がある場所) に戻ると、次の警告が表示されます。
何が起こっているのかと思うと、appledoc はコード ブロック内のマークダウン リンクを探しています。
この警告が表示されないようにするにはどうすればよいですか?
ios - Apple ドキュメントのように、Objective-C と Swift ドキュメントを一緒に
私は現在、Objective-C で書かれた iOS SDK の構築に取り組んでいます。SDK をテストして準備ができたので、Swift と Objective-C を組み合わせてドキュメントを追加したいと考えています。私は次のDocジェネレーターツールに取り組んできました
を。ドキシジェン
b. AppleDoc
c. ジャジー
d. Apple の HeaderDoc。
Objective-C ヘッダー ファイルのコメントを使用して、Appleが最近行っている方法と同様に、Objective C と Swift の複合ヘルプを生成したいと考えています。私の質問は、Objective-C ヘッダーから Swift と Objective-C のドキュメントを生成するにはどうすればよいですか?
ここに私の研究に基づくいくつかのリンクがあります：
ありがとうございました、
RAM。
こちらのアップルのドキュメントを参照してください。
xcode - デリゲート プロトコルを使用した Headerdoc - Swift および xcode 7.2
プロトコルを定義し、このプロトコルのメソッドに HeaderDoc ドキュメントを追加しました。メソッドをOption+クリックすると、正しく表示されます。
ただし、このプロトコルを実装するコントローラー内の実装を Option + クリックすると、ドキュメントが表示されません。
私が期待するのは、私がプロトコル用に書いたドキュメントが、Apple のドキュメントと同様にコントローラーに表示されることです。
プロトコル ドキュメントを他の場所で表示するにはどうすればよいですか?
objective-c - appledoc-runscript-行末が予期されていましたが、識別子が見つかりました
Appledoc プラグインを使用してドキュメントを生成する一環として、このスクリプトを実行しようとしています。このスクリプトを Xcode (またはターミナル) で実行するとエラーが発生します。私はスクリプトを書くのが初めてで、コード内の正確なエラーを特定できないので、助けてください!
最初のものは、ターミナルからスクリプトを実行した場合のログ スクリーン ショットです。2 番目は、Xcode からスクリプトを実行した場合のログのスクリーン ショットです。