diff options
author | Charles Edward Pax <charles.pax@gmail.com> | 2017-07-29 16:17:55 -0400 |
---|---|---|
committer | Charles Edward Pax <charles.pax@gmail.com> | 2017-07-29 16:17:55 -0400 |
commit | 403074fdb7872051eb95737f4a8bff88a8310a18 (patch) | |
tree | 9c962b04acb7b66a8fd9de2c023a36d056a355c5 /src | |
parent | 941b047a737bc8bc576e8b596c3c39ad437b0f93 (diff) |
Doxygen comments in plot.c.
Diffstat (limited to 'src')
-rw-r--r-- | src/plot.c | 64 |
1 files changed, 64 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 plot.c + * \author Andrés Martinelli <andmarti@gmail.com> + * \date 2017-07-18 + * \brief TODO Write a tbrief file description. + */ + #include <string.h> #include <stdlib.h> #include <unistd.h> @@ -8,6 +52,14 @@ #include "file.h" #include "tui.h" +/** + * \brief TODO Document plotedit() + * + * \param[in] s + * + * \return none + */ + int plotedit(wchar_t * s) { #ifdef GNUPLOT // edit ~/.scim/plotxxxx (or /usr/local/share/scim/plotxxxx) @@ -44,6 +96,18 @@ int plotedit(wchar_t * s) { #endif } +/** + * \brief TODO Document plot() + * + * \param[in] s + * \param[in] r + * \param[in] c + * \param[in] rf + * \param[in] cf + * + * \return none + */ + int plot(char * s, int r, int c, int rf, int cf) { #ifdef GNUPLOT // create tmp file |