Как включить комментарии для пакета с scaladoc?

Question

Таким образом, для scaladoc, вы можете указать комментарии для определенного компонента вашего кода следующим образом:

package connector

import java.io.RandomAccessFile;

/** Fs class guides file opening
  *
  */
object fs {
    def printFile(path:String):Unit = {
        val fl = new RandomAccessFile(path, "rw");
        println(fl.readLine());
        println(fl.getFilePointer());
        fl.close();
    }
}

Однако я не вижу, где и как вы могли бы добавить комментарий, который будет отображаться в index.html, сгенерированном scaladoc для начальной страницы пакета. Как это сделать?

Answer 1

Создайте объект пакета (package.scala) и добавьте туда свою документацию:

/**
 * Fs class guides file opening
 */
package object connector {}