This repository comprises the first part of the Algorithms and Data Structures course unit project. The goal was to create a solution for a specific problem applying the object-oriented paradigm in C++.
The theme approached in the problem is 'Fleet management and vehicle rental'. Besides implementing a solution for the problem the software produced must have basic CRUD operations (create, read, update, delete), file store handling and allow multiple listings of the data stored.
A formal approach of the software engineering solution to the problem is documented in the GitHub Wiki section. The wiki contains the following contents:
- Requirements Engineering - use case description;
- Analysis Object Oriented - domain model;
- Design - use case sequence diagram and class diagram.
The code documentation is generated with doxygen. Doxygen is a third-party documentation tool, thus, it is necessary a previous installation in order to be able to get the documentation. A standard project doxygen configuration file is located in the 'docs' directory under the name 'doxyfile'. Currently, the documentation is only exported in HTML. After exporting the files are stored in the 'docs' directory.
Here is an example of how to export the documentation with the standard project doxygen configuration file:
cd doc
doxygen DoxyfileThe unit tests are perfomed by Google Test, the Google's C++ test framework. Currently, the version used is v1.10.0.
Packaging and building done with CMake.
Here is an example of how to make a build of the project:
mkdir build
cd build
cmake ..
cmake --build .To be done.