Uploaded image for project: 'Java Driver'
  1. Java Driver
  2. JAVA-4337

Remove scaladoc warnings

    XMLWordPrintableJSON

Details

    • Icon: Improvement Improvement
    • Resolution: Fixed
    • Icon: Unknown Unknown
    • 4.4.0
    • None
    • Documentation, Scala
    • None

    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 *

      Attachments

        Activity

          People

            ross@mongodb.com Ross Lawley
            ross@mongodb.com Ross Lawley
            Votes:
            0 Vote for this issue
            Watchers:
            1 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: