[JAVA-4337] Remove scaladoc warnings Created: 08/Oct/21  Updated: 28/Oct/23  Resolved: 21/Oct/21

Status: Closed
Project: Java Driver
Component/s: Documentation, Scala
Affects Version/s: None
Fix Version/s: 4.4.0

Type: Improvement Priority: Unknown
Reporter: Ross Lawley Assignee: Ross Lawley
Resolution: Fixed Votes: 0
Labels: None
Remaining Estimate: Not Specified
Time Spent: Not Specified
Original Estimate: Not Specified


 Description   

Fix ambiguity of overloads and any broken links.

Scaladoc is notorious finicky when it comes to links, this stackoverflow answer may help:

  • Everything must be fully qualified, even the class/object itself
  • Package dots should be escaped with \
  • You cannot use any spaces in the signature
  • Parameters should include the name not just the type i.e. foo(a:String) not foo(String)
  • The signature should end with a *


 Comments   
Comment by Githook User [ 21/Oct/21 ]

Author:

{'name': 'Ross Lawley', 'email': 'ross.lawley@gmail.com', 'username': 'rozza'}

Message: Scaladocs: Remove link ambiguity for collect

Caused by the addition of a new collect method in JAVA-4312

JAVA-4337
Branch: master
https://github.com/mongodb/mongo-java-driver/commit/c50482f8125a0cbbb52dbf4e50a5699780d8d922

Generated at Thu Feb 08 09:01:48 UTC 2024 using Jira 9.7.1#970001-sha1:2222b88b221c4928ef0de3161136cc90c8356a66.