diff options
author | Charles Edward Pax <charles.pax@gmail.com> | 2017-07-29 16:15:21 -0400 |
---|---|---|
committer | Charles Edward Pax <charles.pax@gmail.com> | 2017-07-29 16:15:21 -0400 |
commit | 941b047a737bc8bc576e8b596c3c39ad437b0f93 (patch) | |
tree | b04fefcd3e856a3c1397df1f16fd5fea2dc23e6e /src/pipe.c | |
parent | f2a52e3cc5bd14c20376c24c6149bb11b3a9778a (diff) |
Doxygen comment in pipe.c.
Diffstat (limited to 'src/pipe.c')
-rw-r--r-- | src/pipe.c | 101 |
1 files changed, 101 insertions, 0 deletions
@@ -1,3 +1,47 @@ +/******************************************************************************* + * 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 pipe.c + * \author Andrés Martinelli <andmarti@gmail.com> + * \date 2017-07-18 + * \brief TODO Write a tbrief file description. + */ + /* * Adaptation of Chuck Martin's code - <nrocinu@myrealbox.com> */ @@ -11,6 +55,18 @@ #include "tui.h" // FIXME - pass fd is not neccesary? +/** + * \brief TODO Document getnum() + * + * \param[in] r0 + * \param[in] c0 + * \param[in] rn + * \param[in] cn + * \param[in[ df + * + * \return none + */ + void getnum(int r0, int c0, int rn, int cn, FILE * fd) { struct ent ** pp; struct ent * p; @@ -38,6 +94,15 @@ void getnum(int r0, int c0, int rn, int cn, FILE * fd) { linelim = -1; } +/** + * \brief TODO Document getformat() + * + * \param[in] col + * \param[in] df + * + * \return none + */ + void getformat(int col, FILE * fd) { sprintf(line, "%d %d %d\n", fwidth[col], precision[col], realfmt[col]); //write(fd, line, strlen(line)); @@ -45,6 +110,18 @@ void getformat(int col, FILE * fd) { linelim = -1; } +/** + * \brief TODO Document getfmt() + * + * \param[in] r0 + * \param[in] c0 + * \param[in] rn + * \param[in] cn + * \param[in] fd + * + * \return none + */ + void getfmt(int r0, int c0, int rn, int cn, FILE * fd) { struct ent **pp; int r, c; @@ -63,6 +140,18 @@ void getfmt(int r0, int c0, int rn, int cn, FILE * fd) { linelim = -1; } +/** + * \brief TODO Document getstring() + * + * \param[in] r0 + * \param[in] c0 + * \param[in] rn + * \param[in] cn + * \param[in] fd + * + * \return none + */ + void getstring(int r0, int c0, int rn, int cn, FILE * fd) { struct ent **pp; int r, c; @@ -82,6 +171,18 @@ void getstring(int r0, int c0, int rn, int cn, FILE * fd) { linelim = -1; } +/** + * \brief TODO Document getexp() + * + * \param[in] r0 + * \param[in] c0 + * \param[in] rn + * \param[in] cn + * \param[in] fd + * + * \return none + */ + void getexp(int r0, int c0, int rn, int cn, FILE * fd) { struct ent **pp; struct ent *p; |