lib
: folder containing a library, with sublibrariessublib1
andsublib1
app
: folder containing apps that use the library,subapp1
andsubapp2
test
: unit tests, generates executable test file using Catch2
To compile:
mkdir build
cd build
cmake ..
make
cd ..
To run:
./build/app/subapp1
./build/app/subapp2
Other scripts:
compile.sh
: run commands to compileclean.sh
: delete all files in build folderrun_tests.sh
: run unit tests
Installing doxygen:
sudo apt-get install doxygen
Creating a configuration file (named Doxyfile
by default):
doxygen -g <config-file>
Tags in Doxyfile changed from default (more suggestions can be found in this tutorial):
PROJECT_NAME
: set to "My C++ Template"OUTPUT_DIRECTORY
: folder where to put docs. Here, it is set todocs
.FULL_PATH_NAMES = NO
INPUT = lib/
RECURSIVE = YES
GENERATE_TREEVIEW = YES
HAVE_DOT = NO
Generating the documentation:
doxygen <config-file>
Useful links: