問題タブ [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.
scala - 最新の Scala API ドキュメントはどこからダウンロードできますか?
Scala 2.10.2 以降、API ドキュメントのダウンロード リンクが見つかりません。これは意図的な省略ですか?どこでダウンロードできますか?
または、 http://www.scala-lang.org/api/current/index.htmlで同じものを生成する正確なscalac
コマンドは何ですか? (たとえば、どのソース jar を含める必要があるのか わかりません。)
scala - 標準ライブラリの SBT Scaladoc 構成
SBT から標準ライブラリにリンクするように ScalaDoc をセットアップしたいと思います。0.12.4 を使用していますが、まもなく 0.13 に切り替える予定です。また、0.13 のサポートを利用してセットアップを簡単にしたいと考えています。
最適なオプションは、 0.13 のautoAPIMappings
自動マッピングです。
そのpomが設定scala-library
されているため、 はそれをサポートする必要があり、それが SBT が読み取るものです。info.apiURL
ただし、これは機能しません。どちらString
もGenTraversable
ハイパーリンクされていません。引数last
にオプションが追加されていないことを示します。scaladoc
そう:
- どうすれば修正できます
autoAPIMappings
か? - 代替手段はありますか?
- この機能が機能していることは確認していませんが、設定する別のパッケージが必要なだけかもしれません
info.apiUrl
。思い当たるパッケージはありますか?Google は役に立たないように見えます。いくつかのプロパティを持つ Maven パッケージを照会する方法や、poms で全文検索を行う方法さえも明らかではありません。find ~/.m2 ~/.ivy2 -name '*.pom' -type f|xargs grep info.apiUrl
2G のローカル キャッシュで結果が見つかりませんでした。
(この質問はSBT Scaladoc Configurationの複製のように見えるかもしれませんが、更新された構成と異なる SBT バージョンを使用するためのものであるため、質問は異なります。さらに、既存の回答は非推奨のソリューションを示しています)。
scala - scaladoc がコンパイラのようにコンパイルされない
プログラムをコンパイルすると問題なくコンパイルされますが、scaladoc を実行すると動作しません。sbt compile
以下は、うまくコンパイルできてsbt doc
動作しない最小限のコードです。
の出力は次のsbt doc
とおりです。
私は sbt 0.13 と scala 2.10.2 を使用しています。このコードを機能させるにはどうすればよいですか?
java - IntelliJ 用の Scala API ドキュメントのセットアップ方法
Scala
を使用してインストールされhomebrew
、新しい Scala プロジェクトを作成するときは/usr/local/opt/scala/idea
、適切なシンボリック リンクを含むパスを使用します
IntelliJ はコンパイラとライブラリを正しく検出し、オートコンプリート、コンパイル、および実行は正常に機能します。
問題は、Javadocs パスが正しいにもかかわらず、IntelliJ が Scala API ドキュメントを検出しないことです。
ディレクトリの内容も正しいように見えます。
hanxue-mac:idea hanxue$ ls doc/scala-devel-docs/api index index.js package.html index.html lib scala hanxue-mac:idea hanxue$ ls /usr/local/opt/scala/idea doc lib src hanxue-mac:idea hanxue$ ls /usr/local/opt/scala/idea/doc/scala-devel-docs/api index index.js package.html index.html lib scala
これは、Scala クラスを選択してCtrl+キーを押したときのスクリーンショットです。J
IntelliJ Idea 132.719
と同様に同じ問題があることに注意してくださいIntelliJ Idea 12 CE
。Scala API の Javadocs パスはどのように設定すればよいですか?
sbt - 管理された依存関係に sbt の `apiMappings` 設定を使用できますか?
私は sbt で生成した ScalaDoc を外部ライブラリにリンクしてほしいと思っています.sbt 0.13 ではautoAPIMappings
、apiURL
. ただし、実際には、私が使用するライブラリのいずれも pom/ivy メタデータでこれを提供しておらず、これらのライブラリのいくつかは決して提供しないと思われます。
このapiMappings
設定はまさにそれを支援するはずですが、タイプされているMap[File, URL]
ため、管理されていない依存関係のドキュメント URL を設定することを目的としています。管理された依存関係は のインスタンスとして宣言されsbt.ModuleID
、そのマップに直接挿入することはできません。
apiMappings
URL を管理された依存関係に関連付ける何かを設定に取り込むことはできますか?
関連する質問: sbt は aFile
から aを取得する慣用的な方法を提供しModuleID
ますか? File
いくつかのクラスパスを評価してs を取得してそれらを s にマップしようとすることもできると思いますModuleID
が、もっと簡単なものがあることを願っています。
注: これはhttps://stackoverflow.com/questions/18747265/sbt-scaladoc-configuration-for-the-standard-library/18747266に関連していますが、その質問は標準ライブラリの scaladoc にリンクすることで異なります。よく知られている がありFile
scalaInstance.value.libraryJar
ますが、この場合はそうではありません。
scala - sbt が scaladoc 設定を無視する
scaladoc 生成については、 sbt のドキュメントに従おうとしています。一般的な設定用のマルチ プロジェクト (つまり、サブプロジェクトを含む集計) ビルドがあり./build.sbt
ます。次の例の最後のエントリを追加しました。
これは何の効果もありません。scaladoc は図を生成しようとせず、メイン ドキュメントのタイトルも設定しないため、これらの設定は単純に無視されます。同様に、"-foobar"
オプションを追加してもエラーは表示されません。
これを修正する方法 ( ではbuild.sbt
、 には行きたくありませんproject/Build.scala
、ありがとう)
scala - 拡張メソッドを含めるように scaladoc を構成する
暗黙的な変換を指定することで、暗黙的な変換からのメソッドを含めるように scaladoc を構成できますか?
例)
bar
のドキュメントにscaladoc に拡張メソッドを含めることはできますFoo
か?
scala - コンパニオン オブジェクトで再利用するための scaladoc マクロの定義
scaladoc マクロ の仕組みを理解しようとしています。例えば
私は、これはトレイトとコンパニオン オブジェクトの両方の説明を含むドキュメントを生成する必要があるという印象を受けました。またA Consumer simplifies resource management...
、apply
メソッドとtrait
.
しかし、マクロは特性では利用できないようです。オブジェクトは正しく文書化されていますが、trait doc にはマクロ名$DESCR
, $KEY
,が表示されているだけ$VALUE
です。