2016-10-07 6 views
3

最近、最初のHexパッケージが作成されました。 Ecto.Rutと私は現在、そのドキュメントに取り組んでいます。後ろにEcto.Repoを使用し、Ecto.SchemaEcto.Changesetの型を返すので、@specsでリンクしたいと思っていました。ExDocの外部タイプへのリンク

内部およびエリキシルコアタイプ(Keyword.tなど)は自動的にリンクされますが、ex_docはEctoモジュールで定義された外部タイプをリンクしません。それはどうしたらいいのですか?

私は現在、@specで完全なモジュール名を指定して試してみたが、それは動作しません:

@callback all(opts :: Keyword.t) :: [Ecto.Schema.t] | no_return 
+0

サポートされていない可能性があります。 '@ doc'や' @ moduledoc'で手動で書くことができます: https://github.com/phoenixframework/phoenix/blob/a1efd8cc419ff09bd5304349a5fca5245e89094c/lib/phoenix/endpoint.ex#L100 – ma2gedev

+0

@ ma2gedev正式にサポートされています今日現在。 – dimitarvp

+0

@pdimitar wow!いいよ! – ma2gedev

答えて

3

some discussion on ElixirForum後、ホセは、この機能を追加しました。 ExDoc v0.14.2以降では、外部依存モジュールの自動リンクをサポートしています。 Github Pageから

などMyDepとして、あなたの依存関係のいずれかからモジュール、機能、タイプやコールバックを参照することにより、ExDocは、自動的に(hexdocs.pmにその依存関係のドキュメントへのリンクをリンクしますで構成することができます。これは、単に種類、コールバック、モジュールおよびメソッドを自動リンクです、完全なモジュール名を挙げ、意味


)あなたのmix.exsでオプションをDEPS。したがって、最新のExDocにアップデートすることで、既存のコードが自動的にリンクされます。

@callback all(opts :: Keyword.t) :: [Ecto.Schema.t] | no_return 
関連する問題