CVS Directory Layout

This document describes the new directory layout for XDoclet 2.

The files

  • .cvsignore - a list of directories and files to be ignored by CVS
  • LICENSE.txt - contains the XDoclet license (required by Maven)
  • maven.xml - build script that contains preGoal and postGoal targets to override Maven's default behavior
  • project.properties - project properties (primarily used by Maven)
  • project.xml - the project descriptor (used by Maven)

The directories

If you need other directories than these standard ones to store files, please discuss with the development team before creating the directories.

Please note that test classes MUST follow the same package structure as the class the test is for.

  • aptdocs - Almost Plain Text documentation for XDoclet
  • demo - the XDoclet 2 Plug-in demo
  • lib - the needed libraries for compilation (local repos for Maven)
  • maven-aptdoc-plugin - plugin to generate xdoc from .apt
  • plugins - the plug-ins the XDoclet Team maintains
  • src - the XDoclet 2 sources
  • xrai - XRAI sources