Enunciate не создает описания из xs:documentation на xs:elements

Мы используем плагин maven-enunciate-plugin версии 1.26.2 и столкнулись с проблемой при создании нашей документации. Мы добавили комментарии к нашим XSD следующим образом:

<xs:complexType name="PagingParameters">
    <xs:annotation>
        <xs:documentation>information about PagingParameters</xs:documentation>
    </xs:annotation>
    <xs:sequence>
        <xs:choice minOccurs="0">
            <xs:element name="StartPos" type="xs:long" nillable="false">                    
                <xs:annotation>
                    <xs:documentation>information about StartPos</xs:documentation>
                </xs:annotation>
            </xs:element>
            <xs:element name="FollowOnBrowseToken" type="xs:string" nillable="false">
                <xs:annotation>
                    <xs:documentation>information about token</xs:documentation>
                </xs:annotation>
            </xs:element>
        </xs:choice>
        <xs:element name="NoOfRecords" type="xs:long" nillable="false">
            <xs:annotation>
                <xs:documentation>information about noOfRecords</xs:documentation>
            </xs:annotation>
        </xs:element>
    </xs:sequence>
</xs:complexType>

Первый набор анализируется и правильно выводится на странице объявления, однако все комментарии для отдельных элементов в нем полностью теряются. Как ни странно, это происходит только с последовательностями элементов, но с перечислениями все в порядке.

Я пробовал несколько различных способов форматирования документации, включая использование блоков CDATA, но, похоже, ничего не работает.

Что мне не хватает? При необходимости я могу включить больше XSD.


xsd enunciate
person Plenoge    schedule 08.03.2013    source источник

Ответы (2)


arrow_upward
0
arrow_downward

Enunciate использует JavaDoc для разбора своей документации. Можете ли вы подтвердить, что JavaDoc отображается в сгенерированных классах Java?

person Ryan Heaton    schedule 06.07.2013

arrow_upward
0
arrow_downward

Javadoc НЕ отображается в сгенерированных классах, но затем jaxb перезаписывает его своим собственным стандартным комментарием, например:

/**
 * Gets the value of the X property.
 * 
 * @return
 *     possible object is
 *     {@link String }
 *     
 */
public String getX() {

но по-прежнему не отображается javadoc в enuciate

person Peter Isberg    schedule 07.10.2013