問題タブ [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 に答える
821 参照

objective-c - Xcodeでインスタンス変数とメソッドのドキュメントを作成するにはどうすればよいですか?

Alt-Click作成したプログラムの一部としてインスタンス変数(またはメソッド)を作成し、その目的を読み取れるようにしたいと思います。

Xcodeがクラス変数が-で宣言されていると言っているという事実は素晴らしいですが、十分ではありません。この場合、実際に何であるかを説明するために入力したカスタムテキストを表示したいと思いますasset。さらに、ivarのタイプも知っておくと便利です。

これはどのように行うことができますか?この場合、私は正確に何を意味したのだろうかassets

具体的には、コンテンツの表示Xcodeと同じように、この情報を内部から表示できるのではないかと思います。EclipseJavaDoc

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

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

xcode - Xcode 4: カスタム動作で sh スクリプトが実行されませんか?

シェル スクリプト (実行可能に構成されている) を起動するために、Xcode 4 でカスタム ビヘイビアを作成しました (Xcode > ビヘイビア > ビヘイビアの編集 > +)。メニューまたはカスタム ショートカットを使用して動作を呼び出すことはできますが (コンソールは指定どおりに表示されます)、スクリプトは実行されません (コンソールに出力がありません)。スクリプトはすでにターミナルでテストされており、正常に動作します! また、単純なエコーでダミースクリプトを作成しましたが、結果は同じです...なぜですか? どうすればこれをデバッグできますか?

ここに画像の説明を入力

編集:

問題を解決した後、私が考えていたことに気付きました。興味がある場合は、次の記事を読んでください

0 投票する
3 に答える
11801 参照

xcode - appledocを使用してAppleのようなドキュメントを生成する方法

私はここでAppleのようなHTMLドキュメントを生成する方法についての記事を読んでいます。私の質問は、コマンドラインが何に使用されるかです。コマンドラインとappledocxcodeプロジェクトを組み合わせてHTMLを生成するにはどうすればよいですか。

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

xcode - appledoc 例外: 少なくとも 1 つのディレクトリ

何がうまくいかないのかを理解するために時間を無駄にした後、私はついに助けを求めなければなりません. Gentle Bytes の appledocs を使いたいです。クイック インストール ガイドのすべての手順に従いましたが、プロジェクトをコンパイルできません。

1. git://github.com/tomaz/appledoc.git からクローンを作成 2. テンプレートを ~/Library/Application Support/appledoc にインストール 3. プロジェクトのコンパイルを試行

コンパイルしようとするたびに、次のエラーが表示されます: ERROR: AppledocException: At least one directory or file name path is required, use 'appledoc --help'

私は今何をしなければなりませんか?

0 投票する
3 に答える
19845 参照

doxygen - Objective-C ドキュメント ジェネレーター: HeaderDoc vs. Doxygen vs. AppleDoc

職場にドキュメント生成ソリューションを実装する必要があり、タイトルに記載されている 3 つに絞り込みました。これらのソリューションを正式に比較する方法で、私はほとんど情報を見つけることができませんでした。上記の 1 つまたは複数の経験をお持ちの方が参考になることを願っています。

これが、最初のパスから収集できたものです。

HeaderDoc 長所: Apple の既存のドキュメントと一貫性があり、Apple Docsets の作成と互換性が
ある)。


Doxygenの長所: 幅広い使用ベースの活発なサポート コミュニティ b/c、非常にカスタマイズ可能、ほとんどの出力タイプ (latex など)

AppleDoc 長所: Apple の既存のドキュメントと一貫性があるように見える、Apple Docset の作成との互換性がある、
AppleDoc 短所: typedef、enum、関数のドキュメントに問題があり、活発に開発されている

これは正確に聞こえますか?望ましいソリューションには次のものがあります。

  • apples Objective-C クラス リファレンスとの一貫したルック アンド フィール
  • オプションを押しながらクリックして Xcode 内からドキュメント リファレンスを取得し、ドキュメントにリンクする機能 (Apple のクラスと同様)
  • カテゴリ、拡張機能などのスマートな処理 (Apple のクラスのカスタム カテゴリも)
  • 独自の参照ページを作成する機能 (このページのように: Loading... には、画像を含めることができ、生成されたクラス参照からシームレスにリンクできます。たとえば、Apple の UIViewController クラス参照がリンクされたページにリンクする方法のように.
  • ビルド スクリプトに統合できる、実行しやすいコマンド ライン コマンド
  • 非常に大きなコードベースの適切な処理

上記のすべての情報に基づいて、上記のソリューションのいずれかが他のソリューションよりも明らかに優れていますか? 追加する提案や情報は非常に高く評価されます。

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

svn - Doxygen / AppleDoc と Objective-C を使用した Jenkins: Doxygen / AppleDoc の出力はどこに保存する必要がありますか?

現在、私たちのチームは SVN リポジトリを使用してサーバー A のコードを管理しており、このリポジトリに変更を加えると、Jenkins を介してビルドがサーバー B で開始されます (したがって、サーバー B にはサーバー A のリポジトリをミラーリングするワークスペースがあります)。ここで、doxygen や appledoc などのドキュメント ジェネレーターを使用したいと考えていますが、結果のドキュメントをどこに置くべきかわかりません。

たとえば、Jenkins には doxygen プラグインがあります。ただし、jenkins ビルド コマンドは現在のワークスペースにしかアクセスできないため、これは、jenkins プラグインがアクセスする doxyfile がワークスペースに存在し、ソース管理下 (リポジトリから取得) にある必要があることを意味します。これは問題ありませんが、結果の doxygen 出力は実際にはソース管理されるべきではありません。つまり、doxyfile はワークスペース外のサーバー B のどこかに出力を作成するように指定する必要があるということですか?

さらに、全体的な目標は、ドックセットを生成して、個々のチーム メンバーの Xcode を介してシームレスに使用できるようにすることです。しかし、これは、結果のドケット/メイクファイルなどが実際に何らかの形でワークスペースの一部である必要があることを暗示しているように思われます(個々のチームメンバーがSVN更新を介して結果を受け取ることができるようにするため)...しかし、これは不格好に思えます. SVNリポジトリからのものではないワークスペースにフォルダー/ファイルを作成することがコーシャであるかどうかさえわかりません(ワークスペースはミラーであることを意図しているため)。

基本的に私は、ビルド プロセスの一部として Jenkins を介してドキュメント/ドキュメントセットを生成する方法を探しています。また、個々のチーム メンバーがその結果のドキュメントに対して Xcode のオプション クリックの良さを利用できるようにする方法を探しています (理想的には、手動の手順は必要ありません)。これは可能ですか?

ありがとうございました。

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

xcode - Xcode を再起動せずにドキュメントセットをリロードする

ドキュメントセットの生成にappledocを使用しています。再構築するたびに(plistを使用してシェルスクリプトを実行する)、xcodeを再起動して変更を確認する必要があることを除いて、すべてが良好です。

xcode に強制的に docset をリロードさせる方法はありますか?

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

appledoc - Appledoc-カテゴリによるクラスのグループ化

コメントの生成にAppledocを使用しています。基本的なバリアントでは、次のようなページが表示されますhttp://sdk.quickblox.com/ios/

このhttp://qblx.co/OrAHzEのようなものを取得したい-カテゴリごとにグループ化されたクラス。

このドキュメントhttp://gentlebytes.com/appledoc-docs-comments/を読みましたが、これに関する情報は見つかりませんでした。誰かがこのようなことをしましたか?タンク

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

ios - FacebookDocsetとXcodeの統合

そこで、最新の3.1 Facebook iOS SDKをダウンロードし、スクリプトの下で、実行したbuild_documentation.shを見つけました。これにより、com.facebook.Facebook-SDK-3_0-for-iOS.docsetファイルが完成して生成されました。XCodeとうまく統合できるようにしようとしています。アップルのドキュメントは、クイックヘルプパネルに表示されるドキュメントを作成できることを知っています。私自身のカスタムドキュメントはうまく機能します。

Facebookと同じ種類のドキュメントを統合するために私がしなければならないことを誰かが知っていますか?


編集:ここの指示に従って対応するフォルダにドキュメントセットを追加しようとしました が、Xcodeを再起動しましたが、機能しませんでした

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

ios - Appledoc は自動的に html をプロジェクト ディレクトリにコピーします

そのため、ライブラリをxcodeでビルドした後に実行されるビルドスクリプトがあり、appledocドキュメントを生成してXCodeにインストールします。

面倒なことに、これにより、すべての HTML などが、ユーザーのホーム フォルダー内の (非表示の) Library フォルダー内のあいまいなフォルダーに置かれます。

これらのドキュメントセットから HTML をコピーして、プロジェクト ディレクトリ内のフォルダーに配置できるとしたら、本当に素晴らしいことです。これは、公開する必要がある場合に、ライブラリの zip アーカイブにコピーできます。

手動で行う場合 (appledoc のヘルプ ページを見ると、これをすぐに実行できるようには見えません)、それを行うことはできますが、appledoc から最終的なディレクトリ パスを取得する方法はありますか? 私が見ることができる唯一の方法は、出力ファイルを分解してそこにあるパスを見つけることです。

助けてくれてありがとう!:)

トム