Good comment but can you format it with
/**    ...   */

so that it gets picked up by scaladocs