スカラドックでパッケージにコメントを含めるにはどうすればいいですか？

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(); 
    } 
} 

しかし、私はどこか、どのようにインデックスに表示されるコメントが含まれます表示されません。パッケージの開始ページのためにscaladocによって生成されたhtml。これはどうですか？

Answer 1

パッケージオブジェクト（package.scala）を作成し、そこにドキュメントを追加します。

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