問題タブ [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 に答える
4248 参照

scala - Scaladoc で、同じクラスのメソッドにリンクする方法は?

同じクラスのメソッドへのリンクを作成する正しい方法は何ですか? Scaladoc のドキュメントには、この例はありません。

次のようなクラスを検討してください。

IntelliJ IDEA の「クイック ドキュメント」ポップアップでは、これらはすべて赤で表示されます。

  • [[current]]
  • [[#current]]
  • [[AccountController.current]]
  • [[AccountController#current]]
  • [[controllers.AccountController.current]]

ここに画像の説明を入力

これは青色で表示されます。

これは正しいと思いますが、もっと簡単で正しい方法はありませんか?

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

scala - Maven での Scaladoc オプション

scala-maven-pluginfor Mavenのヘルプを探しています。Scaladoc を生成したいのですが、いくつか問題があります。

実際に、次のコマンドを入力して Scaladoc を作成できます。

ここでの問題は、Scaladoc を生成するときに-no-link-warnings.

誰もこれを行う方法を知っていますか? 私は方法を見つけました(以下のコードは機能します)が、それが私がすべき方法だとは思いません。

私のpomファイルは次のとおりです。


編集

最初の返信でユーザー Tunaki によってより良いアプローチが提案されました。そこにコードが表示されます。

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

scala - Scaladoc に外部 HTTP URL へのハイパーリンクを含める方法はありますか?

Scaladoc を使用して、外部 HTTP URL へのハイパーリンクを含める方法はありますか?

Javadoc を使用すると、これは簡単でした..しかし、Scaladoc の構文を理解するのに苦労しています。私はここを見ました:https://wiki.scala-lang.org/display/SW/Writing+Documentation、しかし乾いた状態になりました。

この > https://en.wikipedia.org/wiki/Aardvark < ドキュメントのような外部リソースにリンクしたいとします。使用すべきマークアップは何ですか?

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

scala - SBT での自動 API マッピングのオーバーライド

Catsに依存するライブラリがいくつかあります。apiURL新しい Cats 0.4.0 リリースのPOMに間違った値があるとしましょう。API ドキュメントを壊したくないので、次の URL マッピングを提供しますapiMappings

これは、API ドキュメント内の Cats 型へのリンクには問題なく機能しますが、標準ライブラリやその他の依存関係からの型へのリンクが失われることを意味します。ただし、に変更autoAPIMappingsするtrueと、カスタム マッピングがなくなります。

これは私には意味がありません。もちろん、明示的に定義されたマッピングは、依存関係 POM から自動的にプルされるマッピングによってオーバーライドされるべきではないようです。

特定の依存関係に対して使用できますautoAPIMappingsが、オーバーライドできますか?

0 投票する
0 に答える
423 参照

scala - BigInt クラスの scala doc でメソッド probablePrime() を見つけることができません

私は Scala でまったく新しいので、BIgInt class の scala doc で probablePrime() メソッドを検索していました。しかし、私はその方法を見ることができませんでした。BigInt.scala の github coce をチェックしているときに、存在することがわかりました。

メソッドがscala docに存在しない理由を理解できる人はいますか。

ありがとう!!

0 投票する
0 に答える
583 参照

scala - コメント ブロック内のクラスへの Scaladoc リンクに関する問題

明らかな何かが欠けているかもしれませんが、Scaladoc をクラスにリンクさせることはできません。コンパニオン オブジェクトにのみリンクさせてください。これらの例を考えてみましょう。

これはうまくいきます:

これはリンクしませんがCould not find any member to link for "play.api.libs.json.JsObject"、警告としてログに記録されます。

ただし、これは(あいまいさの解消構文を考慮して)次のようにリンクします。

外部 API マッピングを SBT で整理し、関数シグネチャの生成されたドキュメントを外部サイトに正しくリンクしているので、(かなり) これが私の問題に関係していないと確信しています。

どこが間違っていますか?(それともバグですか?)

0 投票する
0 に答える
23 参照

scala - Scaladoc: すべてのページにリンクを挿入することは可能ですか?

私のホームページへのリンクをすべての Scaladoc ページに挿入することは可能ですか? コンテンツを追加したり、レイアウトを変更したり、すべてのページのスタイルを変更したりする方法はありますか?

0 投票する
0 に答える
40 参照

scala - HTTPリクエストボディのScaladocタグ?

Scala で Play2 を使用しており、エンドポイントの Scaladoc にリクエストの本文に関する情報を書きたいと考えています。

Scaladoc のドキュメントに適切なタグが見つかりませんでした。適切なタグは何でしょうか?