Doxygen comments in xmalloc.c

1 files changed, 79 insertions, 1 deletions

diff --git a/src/xmalloc.c b/src/xmalloc.c
index 858accb..f17e026 100644
--- a/src/xmalloc.c
+++ b/src/xmalloc.c
@@ -1,3 +1,49 @@
+/*******************************************************************************
+ * Copyright (c) 2013-2017, Andrés Martinelli <andmarti@gmail.com              *
+ * All rights reserved.                                                        *
+ *                                                                             *
+ * This file is a part of SC-IM                                                *
+ *                                                                             *
+ * SC-IM is a spreadsheet program that is based on SC. The original authors    *
+ * of SC are James Gosling and Mark Weiser, and mods were later added by       *
+ * Chuck Martin.                                                               *
+ *                                                                             *
+ * Redistribution and use in source and binary forms, with or without          *
+ * modification, are permitted provided that the following conditions are met: *
+ * 1. Redistributions of source code must retain the above copyright           *
+ *    notice, this list of conditions and the following disclaimer.            *
+ * 2. Redistributions in binary form must reproduce the above copyright        *
+ *    notice, this list of conditions and the following disclaimer in the      *
+ *    documentation and/or other materials provided with the distribution.     *
+ * 3. All advertising materials mentioning features or use of this software    *
+ *    must display the following acknowledgement:                              *
+ *    This product includes software developed by Andrés Martinelli            *
+ *    <andmarti@gmail.com>.                                                    *
+ * 4. Neither the name of the Andrés Martinelli nor the                        *
+ *   names of other contributors may be used to endorse or promote products    *
+ *   derived from this software without specific prior written permission.     *
+ *                                                                             *
+ * THIS SOFTWARE IS PROVIDED BY ANDRES MARTINELLI ''AS IS'' AND ANY            *
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED   *
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE      *
+ * DISCLAIMED. IN NO EVENT SHALL ANDRES MARTINELLI BE LIABLE FOR ANY           *
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES  *
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;*
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND *
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  *
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE       *
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.           *
+ *******************************************************************************/
+
+/**
+ * @file xmalloc.c
+ * @author Andrés Martinelli <andmarti@gmail.com>
+ * @date 2017-07-18
+ * @brief TODO Write a tbrief file description.
+ *
+ * TODO Write a longer file description here.
+ */
+
 #include <stdlib.h>
 
 #include "sc.h"
@@ -11,6 +57,14 @@
 extern void free();
 extern int shall_quit;
 
+/**
+ * \brief TODO \document scxmalloc()
+ *
+ * \param[in] n
+ *
+ * \return pointer to 
+ */
+
 char * scxmalloc(unsigned n) {
     //register char *ptr;
     //if ((ptr = malloc(n + sizeof(double))) == NULL) fatal("scxmalloc: no memory");
@@ -23,7 +77,15 @@ char * scxmalloc(unsigned n) {
     return (ptr);
 }
 
-/* we make sure realloc will do a malloc if needed */
+/**
+ * \brief TODO Make sure realloc will do a malloc if needed
+ *
+ * \param[in] ptr
+ * \param[in] n
+ *
+ * \returns: pointer
+ */
+
 char * scxrealloc(char *ptr, unsigned n) {
     //if (ptr == NULL) return(scxmalloc(n));
     //ptr -= sizeof(double);
@@ -38,6 +100,14 @@ char * scxrealloc(char *ptr, unsigned n) {
     return(ptr);
 }
 
+/**
+ * \brief TODO Documetn scxfree()
+ *
+ * \param[in] p
+ *
+ * \returns: none
+ */
+
 void scxfree(char *p) {
     //if (p == NULL) fatal("scxfree: NULL");
     //p -= sizeof(double);
@@ -48,6 +118,14 @@ void scxfree(char *p) {
     free(p);
 }
 
+/**
+ * \brief TODO Document fatal()
+ *
+ * \param[in] str
+ *
+ * \return none
+ */
+
 void fatal(char * str) {
     //fprintf(stderr,"%s\n", str);
     sc_error("%s", str);