C-Plus-Plus OOP Doc

• A simple c-plus-plus project using premake5 as build system and doxygen for documentation.

• Project structure

   .
   ├── bin                    # Binaries will be here.
   ├── src                    # Source folder.
   │   ├── main.cpp           # Your code goes here.
   |   └── cpp-proj.make      # Project makefile
   ├── premake5.lua           # Build script `run premake in the same dir as this file`.
   ├── Doxyfile               # Doxygen config file.
   └── Makefile               # Main Makefile.

How to Use

• first download premake5 here and read the Wiki tutorial here

• execute the following commands

  git clone https://github.com/thiago-rezende/c-plus-plus-oop-doc.git
  cd c-plus-plus-oop-doc
  premake5 gmake
  make
  

Generate Documentation

• first download doxygen here
• open the Doxyfile with the Doxywizard
• run doxygen