Missing include and more doxygen improvements

This commit is contained in:
Thomas Geymayer
2012-11-12 13:57:10 +01:00
parent f51e1f0cc8
commit 55fbe68e62
4 changed files with 36 additions and 8 deletions

View File

@@ -1,5 +1,6 @@
///@file Expose C++ objects to Nasal as ghosts
//
///@file
/// Expose C++ objects to Nasal as ghosts
///
// Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
//
// This library is free software; you can redistribute it and/or
@@ -29,6 +30,11 @@
#include <boost/lambda/lambda.hpp>
#include <boost/utility/enable_if.hpp>
#include <map>
/**
* Bindings between C++ and the Nasal scripting language
*/
namespace nasal
{

View File

@@ -1,5 +1,6 @@
///@file Conversion functions to convert Nasal types to C++ types
//
///@file
/// Conversion functions to convert Nasal types to C++ types
///
// Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
//
// This library is free software; you can redistribute it and/or
@@ -27,6 +28,12 @@ namespace nasal
/**
* Convert a Nasal type to any supported C++ type.
*
* @param c Active Nasal context
* @param ref Nasal object to be converted
* @tparam T Target type of conversion
*
* @throws bad_nasal_cast if conversion is not possible
*
* @note Every type which should be supported needs a function with the
* following signature declared:
*

View File

@@ -1,5 +1,6 @@
// Conversion helpers used by from_nasal<T>(naContext, naRef)
//
///@file
/// Conversion helpers used by from_nasal<T>(naContext, naRef)
///
// Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
//
// This library is free software; you can redistribute it and/or
@@ -39,10 +40,23 @@ namespace nasal
public std::bad_cast
{
public:
/**
* Construct with generic error message
*/
bad_nasal_cast();
/**
* Construct from an error message
*
* @param msg Error message/description
*/
explicit bad_nasal_cast(const std::string& msg);
virtual ~bad_nasal_cast() throw();
/**
* Get a description of the cause of the failed cast.
*/
virtual const char* what() const throw();
protected:

View File

@@ -1,5 +1,6 @@
///@file Conversion functions to convert C++ types to Nasal types
//
///@file
/// Conversion functions to convert C++ types to Nasal types
///
// Copyright (C) 2012 Thomas Geymayer <tomgey@gmail.com>
//
// This library is free software; you can redistribute it and/or