Gobelijn API documentation  - generated for commit a0cbea7
 All Classes Namespaces Files Functions Variables Typedefs Friends Macros Pages
Gobelijn Project


Documentation based on Gobelijn revision a0cbea7 of "2019-02-01 10:27:58 +0100"


Background

Gobelijn is a project by the Computational Modeling and Programming (CoMP) group
of the University of Antwerp. The aim is to develop C++ code and a project structure
for our programming courses.

Guidelines

The project follows a number of guidelines:

  • CMake is used to build programs, libraries, etc.
  • API documentation is generated with Doxygen.
  • For Code Conventions we follow (to some extent) Herb Sutter's guidelines.

Documentation

These web pages constitute the developer documentation for the Gobelijn project.

  • User documentation still needs to written
  • The file INSTALL.txt details the installation steps
  • Developer documentation is generated using the doxygen tool

License

Gobelijn is free software: you can redistribute it and/or modify it under the terms of the
GNU General Public License as published by the Free Software Foundation,
either version 3 of the License, or (at your option) any later version.

Gobelijn is distributed in the hope that it will be useful, but without any warranty, without
even the implied warranty of merchantability or fitness for a particular purpose.
See the GNU General Public License for more details.

A copy of the GNU General Public License can be found in the file NOTICE.txt in the root
directory of the project. A copy of the license text is also available at the GNU web site,
where you will also find background information on GNU software licenses.