]> git.mxchange.org Git - simgear.git/commitdiff
Missing include and more doxygen improvements
authorThomas Geymayer <tomgey@gmail.com>
Mon, 12 Nov 2012 12:57:10 +0000 (13:57 +0100)
committerThomas Geymayer <tomgey@gmail.com>
Mon, 12 Nov 2012 12:57:10 +0000 (13:57 +0100)
simgear/nasal/cppbind/Ghost.hxx
simgear/nasal/cppbind/from_nasal.hxx
simgear/nasal/cppbind/from_nasal_detail.hxx
simgear/nasal/cppbind/to_nasal.hxx

index 0e3e41827e7d731907c07633138ba128d62d7d98..b8b471eafbe1c6389a53356a3f89da6531ab0f29 100644 (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
 #include <boost/lambda/lambda.hpp>
 #include <boost/utility/enable_if.hpp>
 
+#include <map>
+
+/**
+ * Bindings between C++ and the Nasal scripting language
+ */
 namespace nasal
 {
 
index 23ac4683cee7ea4185a34de173c052e76f5141c8..d36d5826992e2ffdffd1ff12bccda24bfb47b20b 100644 (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:
    *
index d5db8cbdfe06b9d795b1dd7f8ab48151b409b524..2a053e4d59df1d9ab489baa49934e340d8be44d2 100644 (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:
index ae1eb2ff7723189ddb335a22817b5c6d55540f41..d90c6ab474e75a267b9aca33ffa66de908163877 100644 (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