Concept¶

Codoc regroups the sources into packages, and the packages into projects.

The package is the compilation unit. It contains source code and compilation instruction. It’s name must be unique.

The package belongs to a project. The project is just a directory containing the packages.

Codoc is a command line binary tool that allows to manage all the files. There is a GUI version too.

• given the path of the sources and codoc’s working directory
• give the path of a project or package
• list the projects
• list the packages in a project
• create projects
• create packages
• create test into a package
• create sources files into a package from template (source and header, class source and class header, main source, test source and header)
• use tool for package (external library)
• use library for package (compiled codoc package)
• use library for test into package
• increment the version of package
• generate complete CMake configuration file

Codoc forbids the creation of an already existing project or package, the creation of two tests with the same name in the same package. It also forbids a non-generated file to be overwritten.