sublime-jsdocs

sublime-jsdocs copied to clipboard

Scala declarations can include type information for both parameters and return values. It'd be great if DocBlockr could parse them.

Some examples:

def add(a: Int, b: Int): Int = a + b

would produce a block like:

/**
 * [add description]
 * @param {Int} a
 * @param {Int} b
 * @return {Int}
 */

class Person(
    name: String,
    age: Int,
    birthdate: Date,
    astrologicalSign: String,
    shoeSize: Int,
    favoriteColor: java.awt.Color) {
  def firstMethod: Foo = ...
}

would produce a block like:

/**
 * [Person description]
 * @param {String} name
 * @param {Int} age
 * @param {Date} birthdate
 * @param {String} astrologicalSign
 * @param {Int} shoeSize
 * @param {java.awt.Color} favoriteColor
 */

def getFutureStatus(statusId: Long, request: Request): Future[Option[Status]] = {
}

would produce a block like:

/**
 * [getFutureStatus description]
 * @param {Long} statusId
 * @param {Request} Request
 * @return {Future[Option[Status]]}
 */

+1

+1

+1