Тег DocBook для @since?

Question

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

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

Answer 1

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

.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:

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

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

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

Answer 2

Возможно, для него может быть использован тег revhistory с подзаголовком revision.

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

<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>