Instigate Scripting Library Documentation

v 0.1

Introduction

This is the main page of the Instigate Open Source project documentation, generated by Doxygen. This is C++ library that allows to implement TCL, Python (and others in future) embedded scripting API into application by registering C++ functions as TCL/Python commands, and evaluation TCL/Python code from C++ functions.

The source code of these documents is located in the directory src/doc. Doxygen also generates documentation from C/C++ code comments.

Directory Structure

Source code is organized in following files/directories:

• makefile - the main makefile
• Doxyfile - the Doxygen project file
• mkf/ - auxiliary makefiles
• src/ - the source code directory.

make command should be invoked from project top directory. It will not work if invoked from subdirectories.

After invoking make command, the following directories will be created:

• obj - contains temporary files generated during build.
• bin - contains main executable and unit-test executables.
• inc - contains symbolic links to the origin header files in src sub-directories.

After invoking make user_docs, the documentation will be generated. The entry page is doc/user/manual/html/index.html