CVS Directory Layout

This document describes the new directory layout for XDoclet 2.0.

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 behaviour
  • 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.

  • core - the XDoclet 2 Core
  • plugins - the XDoclet 2 Plug-ins
  • lib - the needed libraries for compilation
  • xdocs - the documentation

Plug-in Directory Layout

  • src
    • java - the java source codes
    • test - the unit tests
      • java - the java source codes
      • testdata - optionally needed input files for the tests
      • expected - hand written files to validate generated files against
    • templates - velocity templates and macros
  • xdocs - specific plug-in documentation