使用项目布局和用法记录maven原型

时间:2014-08-19 13:58:15

标签: java maven documentation-generation maven-archetype

当我使用site插件生成网站文档时,我在About页面中看到的只是archetype中对<description>所述的描述{{1}} 1}}原型的POM元素。

如何查看生成的项目布局和this等原型用法之类的内容?我只需要手动完成吗?

1 个答案:

答案 0 :(得分:1)

Maven Site插件在src/site下查找文档。默认情况下,它希望使用Doxia Markup language编写文档。您引用的项目结构是使用此标记编写的。您可以在source code of src/site/apt/index.apt in the Maven archetypes project

中找到它

您提到的项目结构的标记在那里定义:

34  +----+
35  
36  project
37  |-- pom.xml
38  `-- src
39      `-- site
40          |-- apt
41          |   |-- format.apt
42          |   `-- index.apt
43          |-- fml
44          |   `-- faq.fml
45          |-- fr
46          |   |-- apt
47          |   |   |-- format.apt
48          |   |   `-- index.apt
49          |   |-- fml
50          |   |   `-- faq.fml
51          |   `-- xdoc
52          |       `-- xdoc.xml
53          |-- xdoc
54          |   `-- xdoc.xml
55          |-- site_fr.xml
56          `-- site.xml
57  
58  +----+

看起来应该相当明显,如何为自己的结构编写标记。如果你想自动生成这样的结构,那么我怀疑你可能需要编写一个简单的Maven插件来迭代你的项目目录。我不知道有任何预先存在的插件,但在那里找到一个插件我不会感到惊讶。