問題タブ [appledoc]

簡単な再利用可能なコントロールを作成し、その機能とプロパティを文書化する方法を探していたところ、appledoc という名前の便利なツールを見つけました。

コントロールの機能を示すデモ プロジェクトを作成しました。これで、appledoc を使用してドキュメントを生成すると、デモ クラスの参照も作成されます。私はこれをしたくありません。Appledoc が再利用可能なクラスのドキュメントのみを生成することを期待しています。どうすればそれができますか？

私のランスクリプトは次のようなものです：

AppDelegate--ignore タグに myとclass を追加しようとViewControllerしましたが、機能していないようです。ここに欠けているものはありますか？

私のアプリケーションで使用-startMonitoringSignificantLocationChangesしています。

バックグラウンドでのアプリケーション

- (void) locationManager:(CLLocationManager *)manager didUpdateToLocation:(CLLocation *)newLocation fromLocation:(CLLocation *)oldLocation

メソッドが呼び出されます。didUpdateToLocation で API を呼び出したい (アプリケーションがバックグラウンドの場合)。場所が大幅に変更された場合、上記のメソッドが呼び出されます。そのメソッドで、API を呼び出しました。これはすべてバックグラウンドで発生し、すべてうまく機能します。大丈夫か知りたいです。私はアップルのドキュメントについてよく知りませんでした。このメソッドアップルは拒否しないと思います。どなたかアイデアをください。

ありがとう

これが重複していないことを願っていますが、他の問題を閲覧した後、Appledoc 2.2-963 で私が抱えていたいくつかの問題が発生したと思います。私はbrewを使ってインストールしましたが、うまくいきました.apple docは素晴らしいドキュメントを生成してくれました. 以下は、プロジェクト ファイルを含む作業ディレクトリ内で appledoc を実行するために使用するスクリプトです。

さらに、ここにある VVDocumenter を使用しています: https://github.com/onevcat/VVDocumenter-Xcode。

すべてが正常に生成されているようですが、ここにいくつかのエラーがあります。セグメンテーション違反: 11 およびその他のエラーは、問題が発生したことです。（この簡単な問題では再現できませんでした）。とにかく、あなたはポイントを取得します。使用するたびにクラッシュしています。

また、VVを使用した私の文書化の例もここにあります

私の質問だと思いますが、半分は機能していますが、これを正しく行っていますか? また、ドキュメントを作業ディレクトリにhtmlとして生成して、githubにもプッシュできるようにする方法はありますか(または、それは良い習慣ではありませんか)? 私はこれを学ぼうとしているだけで、提供されている --help オプションと、IMO にかなり劣るいくつかのブログを除いて、良い使用例はほとんどないようです。

とにかく、他の人がこの投稿を参考にしてくれることを願っています.

-- マイケル・バプティスト

編集：

また、上記の例のように、すべてのクラスが文書化されていないことも言及するのを忘れていました。これは、私が完了していないか、間違っているためです。

ああ..最後にもう1つ、基礎クラスをドキュメントにリンクする方法もあります。関数で NSArray を使用し、その NSArray をメインのドキュメントセットにリンク可能にするなどです。

再度、感謝します。

編集：2014年4月7日

これは典型的なクラッシュレポートです。

Appledoc コメントのようにインライン コード ブロックを示すにはどうすればよいですか?this

バックティックは、Xcode のクイック ヘルプ パネルでバックティックとして読み込まれます。

NSStringFromClassどうにかして成文化したいと本当に思っています。

私は自分のコードをこのように説明したかった

しかし、loadXML のクイック ヘルプを使用しようとすると、Xcode が次のエラーでクラッシュします。

誰か助けてくれませんか？

私の悪い英語でごめんなさい

クラスには、次のメソッドとコメントがあります。

このコメントは Xcode のクイック ヘルプで見ることができ、うまく機能します。

ただし、2 番目のコメント行に GSDContentLayer を指すリンクを作成して、クイック ヘルプ ウィンドウで「GSDContentLayer」をクリックすると、GSDContentLayer クラスを含む .h ファイルに直接移動できるようにしたいと考えています。

それは可能ですか？もしそうなら、どのように？

私たちはいくつかの内部プロジェクトに取り組んでいます。すべてのドキュメントを同じ場所に保管したいと考えています。コードのドキュメントにはappledocsを使用しています。ただし、同じドキュメントにバンドルしたいページがいくつか必要です (Apple にはコンパニオン ガイドがあります)。これはappledocsで可能ですか？もしそうなら、どのように？