Scaladoc继承通知

问题描述

是否可以从父类型继承scaladoc并添加自定义通知？

例如：

trait Parent {
  
  /** Add arbitrary number of key-value pairs to entity. */
  def addFields(fields: (String,String)*): this.type
}

class Child extends Parent {

   /** 
    * {@inheritdoc }
    *
    * @note PrevIoUsly existing keys would be overwritten 
    */
  def addFields(fields: (String,String)*): this.type = ???
}

我希望有以下scaladoc输出：

class Child extends Parent {

   /** 
    * Add arbitrary number of key-value pairs to entity.
    *
    * @note PrevIoUsly existing keys would be overwritten 
    */
  def addFields(fields: (String,String)*): this.type = ???
}

解决方法

实际上，您已经掌握了解决方案。与Java不同，您不需要用花括号将PYTHONPATH括起来。因此，以下将创建所需的输出：

@inheritdoc

I've attached a screenshot to show the final result.

trait Parent { /** Add arbitrary number of key-value pairs to entity. */ def addFields(fields: (String,String)*): this.type } class Child extends Parent { /** * @inheritdoc * * @note Previously existing keys would be overwritten */ override def addFields(fields: (String,String)*): this.type = ??? } 和Generate API documentation可以在SCALADOC FOR LIBRARY AUTHORS阅读更多信息。