Блог

Можно ли наследовать 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, вам просто не нужно заключать @inheritdoc в фигурные скобки. Итак, следующее создаст желаемый результат:

 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 by sbt и в SCALADOC ДЛЯ АВТОРОВ БИБЛИОТЕК.