Тег DocBook для @since?

Question

Содержит ли стандарт DocBook какие-либо элементы, эквивалентные тегу JavaDoc @since?

Я специально пытаюсь сделать это в элементе "refentry", но ничего не кажется подходящим.

Answer 1

Я совершенно уверен, что нет семантического эквивалента Javadoc @since тег. DocBook-х <refentry>смоделирован на страницах man, и для этого нет специальной разметки в groff (man macros), AFAIK. Например, на справочной странице mmap есть несколько аннотаций "с тех пор", которые просто включаются в источник groff следующим образом:

.BR MAP_32BIT " (since Linux 2.4.20, 2.6)"

dbdoclet - это инструмент, который преобразует Javadoc в DocBook XML. Для класса, который имеет @since тег в комментарии к документации верхнего уровня, он выводит разметку следующим образом:

<variablelist>
    <varlistentry>
      <term><emphasis>Since</emphasis></term>
      <listitem>
        <para><simplelist type="inline"><member>January 8, 2014</member></simplelist></para>
      </listitem>
    </varlistentry>
</variablelist>

В этом нет ничего "плохого", но это довольно многословно.

---

Я предлагаю держать это простым. Просто добавьте информацию "с" в любой контейнер разметки, который кажется подходящим. Например:

• Название рефлексии:

  <refsection>
     <title>TITLE HERE (since release X.Y.Z)</title>
      ...
  </refsection> 
  

• Абзац (возможно, с role атрибуты):

  <para role="since">Since release X.Y.Z</para>
  

Answer 2

Может быть, тег revhistory с ревизией sub tag, может быть использован для него.

Ниже небольшой пример, чтобы захватить идею:

<section  title="Section with history information">
  <revhistory>
    <revision>
      <revnumber>0.9</revnumber>
      <date>1996-12-11</date>
    </revision>
  </revhistory>

  <para>
    <revhistory>
      <revision>
        <revnumber>0.8</revnumber>
        <date>1996-11-11</date>
      </revision>
    </revhistory>
    This paragraph has it's own revision history.
  </para>
</section>