changeset 174:053253436eb6

doc: general documentation for python_to_octave.h file
author Juan Pablo Carbajal <ajuanpi+dev@gmail.com>
date Sun, 17 Apr 2016 14:29:56 +0200
parents 28dc607532c2
children a7d597726985
files python_to_octave.h
diffstat 1 files changed, 8 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- a/python_to_octave.h	Thu Apr 07 15:26:53 2016 -0700
+++ b/python_to_octave.h	Sun Apr 17 14:29:56 2016 +0200
@@ -21,6 +21,14 @@
 
 */
 
+/*! \file python_to_octave.h
+    \brief Conversion of data values from Python to GNU Octave
+
+    The functions in this file define the translation of Python
+    object to GNU Octave values using the Boost.Python library and
+    the Octave/C++ API.
+*/
+
 #if ! defined (pytave_python_to_octave_h)
 #define pytave_python_to_octave_h