問題タブ [ngdoc]

angular サービス内の関数宣言に ngdoc ドキュメントを追加したいと考えています。以下の例の myFunction に対してこれを行うにはどうすればよいですか?

@closure、@functionOf、または @functionIn のようなものが必要だと思います。

(myMethod とは対照的に) myFunction はメソッドではないことに注意してください。

このコードを考えると：

私はこのドキュメントを取得します：

つまり、Foo.bar.bazプロパティはドキュメントに表示されません。適切に解析されます。@propertyOfからzomg.Foo.barのようなものに変更するとzomg.Foo.doesnotexist、ドキュメントのコンパイル時にエラーが発生するためです。しかし、結果は結果の HTML には表示されません。

ネストされたオブジェクトを文書化するにはどうすればよいですか? 実際の使用例は、 を含むサービスがあり$resource、 の特別なメソッドを文書化したいというもの$resourceです。非標準の方法でに含めるのではなく、標準の jsdoc の方法で (@ngdoc function特殊@methodOf関数自体を使用して)実行したいと思います。@description$resource

Angular プロジェクトで ngDoc を使用して動作する基本的な例を取得しようとしています。

以下に例を示します。

ドキュメントがコンパイルされると、例のタイトルが表示されますが、埋め込まれた例はありません。

コンパイルされたドキュメントへのリンクは次のとおりです。

http://thinkingmedia.github.io/thinkingmedia-ui/#/api/ui.components.uiRepeat

例がどのように見えるかを示す Angular ドキュメントへのリンクを次に示します。

https://docs.angularjs.org/api/ng/directive/ngClick

ngDoc の何が問題なのですか?

私の css スタイルシートを ngdocs ドキュメントのライブ デモの例に追加したいと思います。

スタイルがデモ自体に影響を与えることを望んでいますが、明らかに、Web ページ全体に影響を与えるべきではありません。

次のように、スタイルシートを gruntfile ngdocs オプションに追加してみました。

これにより、head セクションに最後に含まれるリンク タグとして mylayout.css が index.html のマークアップにリンク タグとして追加されますが、その中のスタイルはページ全体のスタイルをオーバーライドします。ダメ。

スタイルがライブ デモ内で機能し、ページの残りの部分では機能しないようにするにはどうすればよいですか?

ご協力いただきありがとうございます！これが ng-docs で入手できる非常に限られた情報に貢献することを願っています!

編集:私がやったことは、myNgdocsLayout.css という名前の新しい css ファイルを作成することです。このファイルでは、mylayout.css スタイルをライブデモに適用できるようにしながら、mylayout.css の一部をオーバーライドするいくつかのスタイルを記述しました。

これで私のページは問題ないように見えますが、これは完全な解決策ではありません。ページの残りの部分でスタイルをオーバーライドする必要なく、スタイルをライブデモにのみ適用できるようにするアイデアを誰かが思いつくことができれば幸いです... -ngdocsでこれを行う方法。

「utils」という名前のサービスがあります。このサービスにはいくつかの方法があります。

また、このサービスは「authUtilsFailed」と「authUtilsLoaded」の 2 つのブロードキャストを起動します。

この 2 つのブロードキャストを記録するにはどうすればよいですか? (angular-jsdoc を使用)

ありがとう、

クフィル。

私はコードのドキュメントを作成するのが初めてで、角度のあるアプリケーションを grunt-ngdocs でドキュメント化しようとしています。

https://github.com/m7r/grunt-ngdocs-exampleから実際の例を複製しました

与えられた例には文書化されたコントローラーがないため、次のコードを使用して独自の文書化されたコントローラーを追加しました。

コマンド ラインから grunt を実行してドキュメントを作成しようとすると、次のエラー メッセージが表示されます。

これを修正するにはどうすればよいですか? このガイドhttp://www.shristitechlabs.com/adding-automatic-documentation-for-angularjs-apps/を読みましたが、コントローラーを文書化しようとするとエラーメッセージが表示され続ける理由がわかりません:(ありがとうどんな助けでも！