view modules/js/doc/mainpage.cpp @ 619:da9c2e128cae

Executable: fix for macOS
author David Demelier <markand@malikania.fr>
date Wed, 11 Oct 2017 10:12:28 +0200
parents adc2dccc3ee6
children
line wrap: on
line source

/**
 * @mainpage
 *
 * Welcome to the js library.
 *
 * ## Introduction
 *
 * This library is a C++14 Duktape wrapper.
 *
 * It's currently in work in progress and not suitable for production.
 *
 * ## Features
 *
 *   1. Most common Duktape C functions are placed into the duk namespace,
 *   2. Sanity stack checker using duk::StackAssert,
 *   3. Convenient duk::TypeTraits mechanism,
 *   4. Overloads when applicable.
 *
 * ## Requirements
 * 
 *   - [Duktape](http://duktape.org),
 *   - C++14.
 * 
 * ## Installation
 * 
 * Just copy the file js.hpp and add it to your project.
 *
 * ## Overview
 *
 * @code
 * #include "js.hpp"
 *
 * int main()
 * {
 *   duk::UniqueContext ctx;
 *
 *   duk::pevalString(ctx, "print('hello world');");
 *
 *   return 0;
 * }
 * @endcode
 */