Coding Style

This project mainly uses K&R coding style. You may format your code using indent and the following .indent.pro settings

/*
 * .indent.pro
 * (C) 99/10/27 Holger Mueller <holger.mueller@web.de>
 * Last change: 99/11/04 Mr
 */
--k-and-r-style
--blank-lines-after-commas
--declaration-indentation2
--indent-level2
--start-left-side-of-comments
--tab-size0
--comment-indentation33
--no-space-after-casts
--else-endif-column0

The code is documented by using doxygen. All modules have a standard header like this:

/**
 * @file
 * @brief  Description of the modules purpose
 ******************************************************************
 * $Source: /cvsroot/joblog/www/coding.php,v $
 * $Author: hmueller $
 * $Date: 2001/11/26 15:04:06 $
 * $Revision: 1.1 $
 ******************************************************************
 * @verbatim
 * OS       : Palm OS 1.0
 * Target   : Palm Pilot I, II, III, V
 * Compiler : prc-tools Version 2.0 (GCC 2.95)
 * Copyright: Holger Mueller <holger.mueller@web.de>
 *            http://hmueller.purespace.de/pilot
 * @endverbatim
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the license, or (at
 * your option) any later version.
 *    
 * This program is distributed in the hope that it will be useful, but
 * WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 *
 ******************************************************************
 */

All functions are documented by using this header:

/**
 ******************************************************************
 * @brief  Insert a new note in the history list
 * @author Holger Mueller
 * @date   2001-11-19
 *
 * @param  new_note - new note to insert
 * @retval notes - all notes data
 * @return TRUE: successful <br>
 *         FALSE: failed
 ******************************************************************
 */