diff options
author | Charles Edward Pax <charles.pax@gmail.com> | 2017-07-28 10:13:16 -0400 |
---|---|---|
committer | Charles Edward Pax <charles.pax@gmail.com> | 2017-07-28 10:13:16 -0400 |
commit | fcadb092b4097a57c5fe039f36a086b46ab62b4f (patch) | |
tree | 44a9f1aafc693c6c78ae804620e8c5457797d94f /src | |
parent | 8e383ff1cbf2b8784c9925cba4c47f08b3357152 (diff) |
Doxygen comments.
Diffstat (limited to 'src')
-rw-r--r-- | src/cmds_normal.c | 52 | ||||
-rw-r--r-- | src/cmds_visual.c | 69 |
2 files changed, 121 insertions, 0 deletions
diff --git a/src/cmds_normal.c b/src/cmds_normal.c index 67ba6ad..f858c83 100644 --- a/src/cmds_normal.c +++ b/src/cmds_normal.c @@ -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 cmds_normal.c + * \author Andrés Martinelli <andmarti@gmail.com> + * \date 2017-07-18 + * \brief TODO Write a tbrief file description. + */ + #include <ctype.h> #include <stdlib.h> @@ -37,6 +81,14 @@ extern struct history * insert_history; extern char ori_insert_edit_submode; #endif +/** + * \brief TODO Document do_normalmode() + * + * \param[in] buf + * + * \return none + */ + void do_normalmode(struct block * buf) { int bs = get_bufsize(buf); struct ent * e; diff --git a/src/cmds_visual.c b/src/cmds_visual.c index ab3d2ce..ff3191c 100644 --- a/src/cmds_visual.c +++ b/src/cmds_visual.c @@ -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 cmds_visuals.c + * \author Andrés Martinelli <andmarti@gmail.com> + * \date 2017-07-18 + * \brief TODO Write a tbrief file description. + */ + #include <stdlib.h> #include "utils/string.h" @@ -25,6 +69,17 @@ char visual_submode = '0'; srange * r; // SELECTED RANGE! int moving = FALSE; +/** + * \brief TODO Document start_visualmode() + * + * \param[in] tlrow + * \param[in] tlcol + * \param[in] brrow + * \param[in] brcol + * + * \return none + */ + void start_visualmode(int tlrow, int tlcol, int brrow, int brcol) { unselect_ranges(); @@ -62,6 +117,12 @@ void start_visualmode(int tlrow, int tlcol, int brrow, int brcol) { return; } +/** + * \brief TODO Document exit_visualmode() + * + * \return none + */ + void exit_visualmode() { moving = FALSE; visual_submode = '0'; @@ -72,6 +133,14 @@ void exit_visualmode() { return; } +/** + * \brief TODO Document do_visualmode() + * + * \param[in] buf + * + * \return none + */ + void do_visualmode(struct block * buf) { // we are moving (previous to a 'C-o' keypress) if (moving == TRUE) { |