如何在编译时获取Javadoc类描述?

时间:2013-02-16 01:52:12

标签: java maven javadoc

我正在尝试为我的Wicket Web应用程序构建一些文档。我创建了一个页面来抓取所有已挂载的页面并将它们显示在/sitemap.xml中。 在文档的过程中,我为文件<siteMap:Description>添加了一个新标记 现在我想用描述类文件的javadoc条目填充该描述。

我知道在运行时可以直接访问它们。所以相反,我希望在编译时将它们复制到List中,然后可以从运行时访问它们。我该怎么做?

我正在使用Maven进行构建。

修改
我可能还应该提到我确实有一个AntTask已经定义为我的构建过程的一部分,以将编译日期/时间保存到属性文件。
在我看来,一个任务来扫描我的类,然后将信息放入文件可能是要走的路。问题是我不确定如何继续。

My Ant-Task的定义与我的pom.xml相同:

  <plugin>
    <artifactId>maven-antrun-plugin</artifactId>
    <dependencies>
       <dependency>
         <groupId>ant</groupId>
         <artifactId>ant-nodeps</artifactId>
         <version>1.6.5</version>
       </dependency>
     </dependencies>
    <executions>
       <execution>
         <id>set-build-time</id>
         <phase>process-sources</phase>
         <configuration>
           <tasks>
             <tstamp>
               <format property="build.timestamp" pattern="yyyy/MM/dd HH:mm:ss"/>
               <format property="build.time" pattern="HH:mm:ss" />
               <format property="build.date" pattern="MM/dd/yyyy" />
               <format property="build.year" pattern="yyyy"/>
             </tstamp>
             <replaceregexp byline="true">
               <regexp pattern="copyYear\=.*" />
               <!--suppress MavenModelInspection -->
               <substitution expression="copyYear=${build.year}" />
               <fileset dir="src/main/java/" includes="**/*.properties" />
             </replaceregexp>
             <replaceregexp byline="true">
               <regexp pattern="buildTime\=.*" />
               <!--suppress MavenModelInspection -->
               <substitution expression="buildTime=${build.date} ${build.time}" />
               <fileset dir="src/main/java/" includes="**/*.properties" />
             </replaceregexp>
           </tasks>
         </configuration>
         <goals>
           <goal>run</goal>
         </goals>
       </execution>
     </executions>
   </plugin>

1 个答案:

答案 0 :(得分:0)

经过更多的研究,我确定我正在吠叫错误的树。

我自从我试图获得Javadoc评论时,Doclet是更好的答案。 所以我实现了一个自定义doclet并将其连接起来以自动运行,如中所述 以下跟进问答。
How can I compile and run my Custom Doclet class in my project?