Jboss Maven JdocBook плагин, несколько исполнений - PullRequest
Новая
       9

Jboss Maven JdocBook плагин, несколько исполнений

2 голосов
/ 29 декабря 2011

Моя команда работает над проектом веб-сервиса, а я работаю над созданием документации для API веб-сервиса. Я использовал пользовательский доклет JavaDoc для создания двух выходных данных XML доступных методов: один для внутренних разработчиков и один для внешних разработчиков.

Теперь мы используем плагин Jboss Maven Jdocbook для создания вывода DocBook вместе с другими XML-файлами, чтобы создать руководство пользователя для наших веб-сервисов.

Я хочу запустить плагин Maven JdocBook дважды, один раз с использованием внутренних методов и один раз для внешних методов, чтобы создать два отдельных руководства пользователя для внутренних или внешних разработчиков с использованием двух разных файлов master.xml. Файл pom: 

<build>
  <defaultGoal>generate</defaultGoal>
  <plugins>
     <plugin>
        <groupId>org.jboss.maven.plugins</groupId>
        <artifactId>maven-jdocbook-plugin</artifactId>
        <extensions>true</extensions>
        <goals>
           <goal>generate</goal>
        </goals>
        <configuration>
           <formats>
              <format>
                 <formatName>html</formatName>
              </format>
              <format>
                 <formatName>html_single</formatName>
              </format>
           </formats>
        </configuration>
        <executions>
           <execution>
              <id>internal</id>
              <phase>compile</phase>
              <configuration>
                 <baseOutputDirectory>../../Test/JavaDocTest/internal/</baseOutputDirectory>
                 <sourceDocumentName>masterInternal.xml</sourceDocumentName>
              </configuration>
           </execution>
           <execution>
              <id>external</id>
              <phase>compile</phase>
              <configuration>
                 <baseOutputDirectory>../../Test/JavaDocTest/external/</baseOutputDirectory>
                 <sourceDocumentName>masterExternal.xml</sourceDocumentName>
              </configuration>
           </execution>
        </executions>
     </plugin>
     <plugin>
        <groupId>org.jboss.maven.plugins</groupId>
        <artifactId>maven-jdocbook-style-plugin</artifactId>
        <version>1.0.0</version>
        <extensions>true</extensions>
     </plugin>
  </plugins>

Проблема, с которой я сталкиваюсь, заключается в том, что, если я не помещу sourceDocumentName в базовую конфигурацию (вне секции выполнения и в секции с форматами), сборка не распознает другое имя исходного документа. Стандартный мастер-файл называется master.xml , и при компиляции в NetBeans он говорит, что ищет master.xml, который не может найти, потому что он не существует, и затем пропускает генерацию.

Кажется, что нужно просто пропустить разделы выполнения, так как когда я пытаюсь запустить сборку с несколькими выполнениями (например, как описано выше), она все равно запускается один раз. Есть идеи, почему он пропускает секции исполнения?

Я полагаю, что это может иметь какое-то отношение к метке фазы выполнения, но согласно http://www.jboss.org/maven-jdocbook-plugin/ есть только несколько фаз (ресурсы процесса, компиляция, упаковка, установка, развертывание), и я Я попробовал все из них, и ни один из них, кажется, не работает.
Заранее спасибо.

1 Ответ

2 голосов
/ 30 декабря 2011

Моя группа выяснила, что вам нужно установить sourceDocumentName в основной области конфигурации.Оказывается, что docbook генерируется один раз с использованием основного раздела конфигурации, а затем он ищет любые другие выполнения и запускает те, которые используют конкретную субконфигурацию для этого выполнения.

Надеюсь, это поможет кому-то в будущем.

...