This documenta- tion describes the current state of development.
Note that interfaces and functionality may still change.

Prokee Modules:

open all | close all

GUI Elements:

open all | close all

GUI Interactions:

open all | close all

GUI Layouts:

open all | close all

Games/Demos:

open all | close all

Third Party Libraries:

open all | close all

Information about this Website / Informationen zu dieser Webseite:

In case of any questions, or comments, please feel free to contact me via email at apoll500@gmail.com.

Module modtree [Version: v01]

[Documentation]

[Details]

[Wiki]

[Tests]

This documentation describes the Prokee module interface.

Static Methods:

run (version 1)
void modtree::run(const char *module_name)

run (version 2)
void modtree::run(const char *inimod_path,const char *module_name)

Motivation

This module provides functions to search for all modules required by a given module and create the files required by the inimod.sh script to setup a prokee module project.

Below is an example of a definition file. See documetation of prokee for more information about setting up modules.


    //MODULE::

    modname="label";
    modtype="mods";
    version="v01";
    INCLUDE="mods/inc/label.def";
    //--------------------------------------------------------------------------
    // Modules
    //--------------------------------------------------------------------------
    all_required_modules
    {
        prokee_module
        {
            dynamic
            {
                module
                {
                    modname="strconv";
                    modtype="mods";
                    version="v01";
                }
            }
            static
            {
            }
        }
        cli_program
        {
            include="prokee_module";
            include="fulltree";
            dynamic
            {
            }
            static
            {
            }
        }
    }
    //all content following from here will be ignored by modtree.

Static Methods

run (version 1)

Runs modtree for module module_name.
The definition file of the module (<module_name>.def) has to be in the current working directory.
The output files will be written to directory inc/.

Signature:

void modtree::run(const char *module_name)

Parameters:

Type	Name	Direction	Description
const char *	module_name	[IN]	The name of the module.

run (version 2)

Runs modtree for module module_name.
The path to the definition file of the module is constructed as follows: <inimod_path>mods/<module_name>.def.
The output files will be written to directory <inimod_path>mods/inc/.

Signature:

void modtree::run(const char *inimod_path,const char *module_name)

Parameters:

Type	Name	Direction	Description
const char *	inimod_path	[IN]	The path to the inimod directory.
const char *	module_name	[IN]	The name of the module.