Как настроить TLDDoc для создания документации для JSP TagLibs? - PullRequest
Новая
       10

Как настроить TLDDoc для создания документации для JSP TagLibs?

3 голосов
/ 03 мая 2011

Компания, в которой я работаю, в настоящее время имеет несколько ярлыков в нескольких проектах.Мы используем Maven и Hudson.Мне было поручено найти что-то, что мы можем использовать для автоматического создания документации для наших тегов.Я нашел TLDDoc , но мне не удалось найти ничего, объясняющего, как это настроить.Обратите внимание, я не Java-разработчик, я UI-разработчик, который работает в JSP среди других технологий.Любая помощь будет оценена.

Ответы [ 2 ]

1 голос
/ 08 февраля 2013

У меня было похожее требование.Я использовал сценарий Ant в файле maven, он нашел бы все файлы определения TLD в нужных мне проектах, зациклился над каждым файлом и что-то сделал.

Мне нужно 2 выхода.HTML и DITA (формат технической документации, преемник DOCBOOK).

  1. Для каждого TLD будет вызываться TLDDoc и к выходному каталогу, который будет одинаковым.
  2. Дополнительный скрипт выполнил таблицу стилей XSLT, которая преобразовывала TLD xml в DITA.Из DITA я использую «DITA Open Toolkit» для вывода в PDF и другой тип HTML.

С maven вам нужно немного изучить скрипт ANT и знать, как вызывать Java-классы.(TLDDOC) или механизм XSLT.

Это было действительно круто и довольно гибко.

0 голосов
/ 12 мая 2017

Если вы хотите выполнить TLDDoc как плагин maven, вы можете сделать это, например, так: 

        <plugin>
            <groupId>org.codehaus.mojo</groupId>
            <artifactId>exec-maven-plugin</artifactId>
            <executions>
                <execution>
                    <id>generateTldDoc</id>
                    <phase>prepare-package</phase>
                    <goals>
                        <goal>java</goal>
                    </goals>
                    <configuration>
                        <includePluginDependencies>true</includePluginDependencies>
                        <includeProjectDependencies>false</includeProjectDependencies>
                        <mainClass>com.sun.tlddoc.TLDDoc</mainClass>
                        <arguments>                  
                            <argument>-doctitle</argument>
                            <argument>Whatever Taglib</argument>
                            <argument>-windowtitle</argument>
                            <argument>Whatever Taglib</argument>   
                            <argument>-d</argument>
                            <argument>${project.build.directory}/tlddoc</argument>
                            <argument>src/main/resources/META-INF/something.tld</argument>
                            <argument>src/main/resources/META-INF/somethingelse.tld</argument>
                        </arguments>
                    </configuration>
                </execution>
            </executions>
            <dependencies>
                <dependency>
                    <groupId>taglibrarydoc</groupId>
                    <artifactId>tlddoc</artifactId>
                    <version>1.3</version>
                </dependency>
            </dependencies>
        </plugin>
...