問題タブ [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 投票する
2 に答える
2149 参照

eclipse - ScalaEclipseプラグインはマウスホバーのドキュメントを表示しません

EclipseIndigoのフレッシュインストールでScalaIDEEclipseプラグインをインストールしました。Indigoの新規インストールについて、scala-ide.orgのメインページにある入門用のYouTubeビデオをフォローしました。String Javaクラスの完全なドキュメントを表示する代わりに、「type String=String」を表示します。

ちなみに、プロジェクトのプロパティを見て、プロジェクト内のscala-library.jarなどの「javadocの場所」の下に「(なし)-変更不可」と表示されていることに気付きました。これが問題なのか、Scalaエディターがドキュメントをどこか別の場所で入手しているのかはわかりません。

他の誰かがこれを経験したり、それを修正する方法を考え出したことがありますか?ありがとう!

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

scala - Scaladoc は @throws と @note タグを飲み込んだ

Scala ドキュメンテーションを作成するときは、ここ (Scaladoc Wiki - タグと注釈) に記載されているようにタグ@throwsとタグも使用します。@note

残念ながら、生成されたScaladocでこれらを見つけることができません。

特定のスイッチを設定する必要がありますか、特定のものを検討する必要がありますか、それとも既知の問題ですか?

ところで:警告も発行しないScala 2.9.0.1のscaladoc Antタスクを使用しています。

EDIT:@throws BTW2と明確にするために:私は注釈を意味するものではありません

これはこの注釈セクションに記載されていますdefが、@throwsScaladoc のタグは

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

java - 混合Java/Scalaプロジェクトの自動生成されたドキュメント

JavaとScalaが混在するプロジェクトのドキュメントを自動生成するための最善の方法についてアドバイスをいただければ幸いです。Scala2.8を使用しています。2.8.1に同梱されているscaladocツールは、Javaクラスに使用できるドキュメントを生成しないようです。構造は正しくなりますが、ドキュメントは含まれていません。そして、javadocは明らかにJava部分のみをカバーしています。

Doxygenを調べましたが、Scalaをそのまま使用すると機能しないため、これは少し研究プロジェクトです。

100%Javaまたは100%Scalaを使用する以外に、どうすればこれを実行できますか?

ありがとう!

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

scala - Play 用の scaladoc! フレームワークと Scala モジュール

Play で scaladoc を実行する方法について、私は少し困惑しています! フレームワーク プロジェクト。説明すべき複雑な点がたくさんあるようで、私は成功していません。

不足しているチュートリアルはありますか? 妥当なものにするために、sbt やビルド ツールを追加する必要がありますか?

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

scala - ドキュメントタスクでJavaソースファイルを除外するには?

Java/Scala 混合プロジェクトに sbt 0.11.2 を使用しています。docsbt 内からコマンドを実行すると、Scala ソース ファイルの scaladocs が作成されるだけsrc/main/scalaでなく、Java ソース ファイルの scaladocs も作成されることに気付きましたsrc/main/java(sbt wiki は、それらを作成すると主張していますが、src/main/scalaそれは真実ではないようです)。

しかし、これはあまりよく見えません。たとえば、Foo静的メソッドで名前が付けられた Java クラスの場合、生成された scaladoc にはFooクラスとFooオブジェクトの 2 つのエントリがあります。クラスにはコンストラクターのみがリストされ、オブジェクトには静的メソッドがリストされます。

src/main/javascaladoc 生成からフォルダーを除外するように sbt に指示する方法はありますか? 代わりに、それらの javadoc を作成したいと思います。

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

scala - 古いscalaコンパイラを使用した新しいscaladoc?

2.8.1用に書かれたScalaコードで問題なくトランクからscaladocを使用することは可能ですか?トランク内のscaladocは、2.8.1のscaladocでは実装されていないいくつかの追加タグをサポートしているためです。

問題はないと思いますが、確認したかっただけです。

もしそうなら、これはsbtからどのように行うことができますか?

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

documentation - IntelliJ Idea でカーソルの下にある要素のドキュメントを表示するボタンはありますか?

カーソル下の要素のタイプの ScalaDoc/JavaDoc ページを表示すると便利な場合があります。驚いたことに、これを行うための IDE 組み込みの方法を見つけることができませんでした (私が使用するほとんどのライブラリにはドキュメントとソース jar が付属しているにもかかわらず)。そこにいますか?

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

eclipse - EclipseでのScaladocの表示

Eclipseでは、ScalaプロジェクトのJavadocLocationプロパティをscalaプロジェクトの場所にfile:/D:/EclipseWorkspace/MyProject/target/scala-2.9.1/api設定しました。D:/EclipseWorkspace/MyProject

これで、クラス/トレイトを実装するScalaファイルを使用している場合、Shift+と入力F2すると、Eclipseはそのクラス/トレイトのScaladocページを開きます。<ObjectName>.htmlただし、Eclipseが開こうとするのに対し、Scaladocで生成されたファイル名はであるため、オブジェクトの場合は機能しません<ObjectName>$.html

回避策はありますか?

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

scala - scaladoc のそのままのコード

いくつかの有用な色を保持する Color コンパニオン オブジェクトがあり、次の方法でそれらを文書化したいと思います。

お気づきかもしれませんが、必要なのは、 のドキュメントの(.3, .3, .3, 1)すぐ下に文字列が表示されるようにすることだけです。問題は、Scaladoc が最初のピリオドより前のすべてを文と見なし、それより前のすべてが展開可能な矢印の「内側」に隠されていることです。だから私が得るのは次のようなものです:val darkGreyColor

ここに画像の説明を入力

これは明らかに望ましくありません。理想的には、文字列全体が表示されるか、文字列全体が非表示になります。これらのいずれかを達成する方法はありますか?

また、次の 2 つの方法も試しましたが、いずれも機能しません。

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

scala - ソースへのすべてのリンクを新しいタブで開くようにscaladocに指示することは可能ですか?

現在、scaladocは同じフレーム内のすべてのリンクを開こうとします。ソースの場所がフレーム内で機能しない場合(たとえば、githubページ)、エラーが発生します。

例:ホタテ

リンクを左クリックしてソースを開こうとすると、Chromeでは何も起こらず、Operaではエラーが発生します。

その動作を修正する方法はありますか?