問題タブ [scaladoc]

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 投票する
1 に答える
11114 参照

sbt - Play 2.2.x の dist タスクで ScalaDoc 生成を無効にする方法 (project/build.scala を使用)?

Play 2.2.x アプリのファイルに次の設定を追加しても、build.sbtScaladoc 生成は無効になりません。どうすれば無効にできますか?

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

scala - sbt test:doc リンクするメンバーが見つかりませんでした

実行しようとするsbt test:docと、次のような警告がいくつか表示されます。

[警告] /Users/tleese/code/my/stuff/src/test/scala/com/my/stuff/common/tests/util/NumberExtractorsSpecs.scala:9: "com.my にリンクするメンバーが見つかりませんでした.stuff.common.util.IntExtractor」.

問題は、テスト ソースからメイン ソースへの Scaladoc 参照が正しくリンクできないことです。私が間違っていること、または構成する必要があることについて何か考えはありますか?

以下は、Build.scala の関連セクションです。

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

scala - scala, slick : 特定のメソッドによって発生した例外はどこで見つけることができますか?

そのようなコードによって発生した例外をどこで見つけることができるのだろうか:

洗練された scaladoc ( http://slick.typesafe.com/doc/2.0.1/api/#package ) では見つかりません。javadoc の tableQuery クラスで「最初に」メソッドを検索しましたが、成功しませんでした。

ありがとう。

オリビエ

ps:これが私の答えです、それは働いています:

答えてくれてありがとう、それは私を助けました。

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

scala - オーバーロードされたメソッドの ScalaDoc リンクを作成できません

オーバーロードの使用時に ScalaDoc がメソッド リンクを受け入れないという問題が発生しています。

スタンドアロンの例: File project/build.properties:

ファイルbuild.sbt:

ファイルsrc/main/scala/Foo.scala:

を実行するsbt docと、[[Bar#foo]]リンクは問題ありませんが、[[Bar#bar]]リンクが受け入れられません。

「クラッシュコース」を使用して、あらゆる種類のことを試しました。

これはどれも機能しません。他のオーバーロードされたバリアントを使用しない:

それで、(いつものように...) scala-doc が完全に壊れているか、何か間違ったことをしていますか?

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

playframework - Play 2.2.x で階層/UML 図を生成するには?

scaladoc自体を使用して階層図を生成できることは知っていますが、どうすればそれplay docを行うことができますか?

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

scala - IDEA または Maven の Scaladoc

ビルドには Maven を使用し、Scala プラグインでは IntelliJ IDEA を使用しています。プロジェクトは、pom の Scala 2.10.3 依存関係を使用して正常に実行およびデバッグされます。

しかし、IDEA を使用してプロジェクト全体から Scaladoc を生成しようとすると、文字通り何も出力されません。

関連して、Maven からも Scaladocs を作成したいと考えています。プロジェクトの Java 部分の Javadoc があります。sbt でこれを行うための手順はありますが、Maven で行う方法については何も見つかりません。

私のIDEAプロジェクトには次のScalaライブラリがあります

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

scala - sbt サブプロジェクトのドキュメント生成を無効にする

私は SBT でマルチプロジェクトの Scala ビルドを持っています。その中には、マクロ ライブラリとそのマクロ ライブラリを使用するコア ライブラリの 2 つのサブプロジェクトを効果的に集約するルート プロジェクトがあります。

私は優れたプラグインを使用して、ライブラリ全体 (マクロ + コアの組み合わせ) 用のsbt-unidoc単一の統合 API を作成しています。scaladoc

残念ながら、sbt-unidocいくつかの制限があります。たとえば、デフォルトでは、docタスクにフックされず、その出力はunidocフォルダーではなく、ターゲット ディレクトリのフォルダーに配置されapiます。これらを組み合わせると、publishまたはpublishLocalコマンドの実行時に結果のドキュメントが生成およびパッケージ化されなくなります。幸いなことに ( GitHubサイトで によって提起された問題のおかげで)、これには簡単な解決策があります。inkytonicsbt-unidoc

これらの設定は、ルート プロジェクトで使用されます。

docここで、sbt タスク、publishpublishLocalなどを実行すると、rootプロジェクトは 2 つのサブプロジェクトの統合ドキュメントを生成し、その統合ドキュメントは公開時にパッケージ化されます。

macro残念ながら、これらの同じコマンドは、サブプロジェクトとサブプロジェクトの両方の個々のサブプロジェクト API ドキュメントを生成しようとしますcoreが、私の特定のケースではさまざまな理由により、これらは失敗します。ドキュメントを 2 回生成するのに時間がかかることは言うまでもありません。

docだから、ここに私の質問があります:各サブプロジェクトのタスクを無効にする簡単な方法はありますか?

これまでに発見できた唯一の方法は、docScaladoc が埋め込まれたファイルがないと思い込ませることです。これは機能しますが、実際の解決策ではなく、ごまかしです。

助言がありますか?