add comment on disp.h and protos in string.h

2 files changed, 112 insertions, 2 deletions

diff --git a/src/string/includes/disp.h b/src/string/includes/disp.h
index d78fca52..72fa9cb6 100644
--- a/src/string/includes/disp.h
+++ b/src/string/includes/disp.h
@@ -19,22 +19,52 @@
 #include "floatComplex.h"
 #include "doubleComplex.h"
 
+/*
+** \brief display of a float scalar 
+*/
 void sdisps (float in);
 
+/*
+** \brief display of a double scalar
+*/
 void ddisps (double in);
 
+/*
+** \brief display of a float complex
+*/
 void cdisps (floatComplex in);
 
+/*
+** \brief display of a double complex
+*/
 void zdisps (doubleComplex in);
 
-
-
+/*
+** \brief display of a float scalar array
+** \param in the float scalar array to display
+** \param size the size of the array
+*/
 void sdispa (float* in, int size);
 
+/*
+** \brief display of a double scalar array
+** \param in the double scalar array to display
+** \param size the size of the array
+*/
 void ddispa (double* in, int size);
 
+/*
+** \brief display of a float complex array
+** \param in the float complex array to display
+** \param size the size of the array
+*/
 void cdispa (floatComplex* in, int size);
 
+/*
+** \brief display of a double complex array
+** \param in the double complex array to display
+** \param size the size of the array
+*/
 void zdispa (doubleComplex* in, int size);
 
 #endif /* !__DISP_H__ */
diff --git a/src/string/includes/string.h b/src/string/includes/string.h
index e69de29b..37ac2d09 100644
--- a/src/string/includes/string.h
+++ b/src/string/includes/string.h
@@ -0,0 +1,80 @@
+/*
+ *  Scilab ( http://www.scilab.org/ ) - This file is part of Scilab
+ *  Copyright (C) 2008-2008 - INRIA - Allan SIMON
+ *
+ *  This file must be used under the terms of the CeCILL.
+ *  This source file is licensed as described in the file COPYING, which
+ *  you should have received as part of this distribution.  The terms
+ *  are also available at
+ *  http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+ *
+ */
+
+
+
+#ifndef __STRING_H__
+#define __STRING_H__
+
+#include <stdio.h>
+#include "floatComplex.h"
+#include "doubleComplex.h"
+
+
+/*
+** \brief convert of a float scalar into a char array
+** \param in the float scalar to convert
+** \param out the output char array
+*/
+void sstrings (float in, char* out);
+
+/*
+** \brief convert of a double scalar into a char array
+** \param in the double scalar to convert
+** \param out the output char array
+*/
+void dstrings (double in, char* out);
+
+/*
+** \brief convert of a float complex into a char array
+** \param in the float complex to convert
+** \param out the output char array
+*/
+void cstrings (floatComplex in, char* out);
+
+/*
+** \brief convert of a double complex into a char array
+** \param in the double complex to convert
+** \param out the output char array
+*/
+void zstrings (doubleComplex in, char* out);
+
+
+/*
+** \brief convert of a float scalar array into an array of char arrays
+** \param in the float scalar array to convert
+** \param out the output array of char arrays
+*/
+void sstringa (float* in, int size, char** out);
+
+/*
+** \brief convert of a double scalar array into an array of char arrays
+** \param in the double scalar array to convert
+** \param out the output array of char arrays
+*/
+void dstringa (double* in, int size, char** out);
+
+/*
+** \brief convert of a float complex array into an array of char arrays
+** \param in the float complex array to convert
+** \param out the output array of char arrays
+*/
+void cstringa (floatComplex* in, int size, char** out );
+
+/*
+** \brief convert of a double complex array into an array of char arrays
+** \param in the double complex array to convert
+** \param out the output array of char arrays
+*/
+void zstringa (doubleComplex* in, int size, char** out);
+
+#endif /* !__STRING_H__ */