harbour-core/harbour/doc/hdr_tpl.txt

/*
 * $Id$
 */

/* NOTE: - Please use these template for your new files, replace parts
           between curly braces {} with the appropriate text.
         - You can find a history at the end of the file. */

FILE HEADER TEMPLATE
====================

/*
 * Harbour Project source code:
 * {one-liner description about the purpose of this source file}
 *
 * Copyright 2001 {list of individual authors and e-mail addresses}
 * www - http://www.harbour-project.org
 *
 * 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, 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 software; see the file COPYING.  If not, write to
 * the Free Software Foundation, Inc., 59 Temple Place, Suite 330,
 * Boston, MA 02111-1307 USA (or visit the web site http://www.gnu.org/).
 *
 * As a special exception, the Harbour Project gives permission for
 * additional uses of the text contained in its release of Harbour.
 *
 * The exception is that, if you link the Harbour libraries with other
 * files to produce an executable, this does not by itself cause the
 * resulting executable to be covered by the GNU General Public License.
 * Your use of that executable is in no way restricted on account of
 * linking the Harbour library code into it.
 *
 * This exception does not however invalidate any other reasons why
 * the executable file might be covered by the GNU General Public License.
 *
 * This exception applies only to the code released by the Harbour
 * Project under the name Harbour.  If you copy code from other
 * Harbour Project or Free Software Foundation releases into a copy of
 * Harbour, as the General Public License permits, the exception does
 * not apply to the code that you add in this way.  To avoid misleading
 * anyone as to the status of such modified files, you must delete
 * this exception notice from them.
 *
 * If you write modifications of your own for Harbour, it is your choice
 * whether to permit this exception to apply to your modifications.
 * If you do not wish that, delete this exception notice.
 *
 */

FILE HEADER TEMPLATE (OPTIONAL ADDITION FOR PARTIAL COPYRIGHTS)
===============================================================

/*
 * The following parts are Copyright of the individual authors.
 * www - http://www.harbour-project.org
 *
 * Copyright 2001 {name} <{e-mail address}>
 *    {function or subsystem name}
 *
 * See doc/license.txt for licensing terms.
 *
 */

FUNCTION HEADER TEMPLATE
========================

/*  $DOC$
 *  $FUNCNAME$
 *
 *  $CATEGORY$
 *
 *  $ONELINER$
 *
 *  $SYNTAX$
 *
 *  $ARGUMENTS$
 *
 *  $RETURNS$
 *
 *  $DESCRIPTION$
 *
 *  $EXAMPLES$
 *
 *  $TESTS$
 *
 *  $STATUS$
 *
 *  $COMPLIANCE$
 *
 *  $PLATFORMS$
 *
 *  $FILES$
 *
 *  $SEEALSO$
 *
 *  $END$
 */

FUNCTION HEADER EXAMPLE
=======================

/*  $DOC$
 *  $FUNCNAME$
 *      IsLeapYr()
 *  $CATEGORY$
 *      Dates
 *  $ONELINER$
 *      Test if a date falls in a leap year.
 *  $SYNTAX$
 *      IsLeapYr( [<dDate>] ) --> lIsLeap
 *  $ARGUMENTS$
 *      <dDate> is an optional date. If not supplied is defaults to the
 *      value returned from date().
 *  $RETURNS$
 *      TRUE if <dDate> falls in a leap year, FALSE if not.
 *  $DESCRIPTION$
 *      IsLeapYr() can be used to check if a given year is a leap year.
 *  $EXAMPLES$
 *      // Check if it's a leap year.
 *
 *      If IsLeapYr()
 *         ? "One extra day before you get paid this Feb!!"
 *      Else
 *         ? "A normal year"
 *      EndIf
 *  $TESTS$
 *      valtype( IsLeapYr( date() ) ) == "L"
 *      valtype( IsLeapYr( ctod( "" ) ) ) == "L"
 *      valtype( IsLeapYr() ) == "L"
 *      IsLeapYr( SToD( "20000101" ) )
 *      !IsLeapYr( SToD( "19000101" ) )
 *      IsLeapYr( SToD( "19841231" ) )
 *      !IsLeapYr()
 *  $STATUS$
 *      C
 *  $COMPLIANCE$
 *      IsLeapYr() works exactly like CA-Cl*pper's IsLeapYr(), if your
 *      CA-Cl*pper doesn't have such a function you're probably in a
 *      different universe from the author of this function.
 *  $PLATFORMS$
 *      All
 *  $FILES$
 *
 *  $SEEALSO$
 *      Date() IsWeekend() IsHarbourFinished() IsApocalypse()
 *  $END$
 */

/* ------------------------------------------------------------------------- */

/*
 * ChangeLog:
 *
 * V 1.15   Viktor Szakats              Name correction
 * V 1.14   David G. Holm               Second year 2000 chaned to 2001
 * V 1.13   David G. Holm               Year changed to 2001 from 2000.
 *                                      License changed to be compatible with
 *                                      the Guile 1.4 license (the old one
 *                                      was based on an earlier Guile).
 * V 1.12   Viktor Szakats              Year changed to 2000 from 1999.
 * V 1.11   Viktor Szakats              $FILES$ added.
 * V 1.10   Viktor Szakats              $PLATFORMS$ added.
 * V 1.9    Viktor Szakats              Small format changes.
 * V 1.8    Viktor Szakats              licence -> license
 * V 1.7    Viktor Szakats              History separated from the file header
 *                                      template. Slight changes in the format
 *                                      of the header. Removed "(proposal)"
 *                                      from the top of the file. Added partial
 *                                      copyright header template.
 * V 1.6    Viktor Szakats              RCS Id section separated from
 *                                      Licenc text.
 * V 1.5    Viktor Szakats              Small name correction.
 * V 1.4    David G. Holm               Removed "(C)" from Copyright notice
 *                                      Put author's name rather than date
 *                                      next to each version number, because
 *                                      the RCS tracks dates, but only tracks
 *                                      CVS user names, not author names.
 * V 1.3    Viktor Szakats              Description line changed to be a
 *                                      template, too.
 * V 1.2    David G. Holm               Added HRL/HVM license exception for
 *                                      executables. Added GNU web site.
 *                                      Replaced "?" in copyright statement
 *                                      with "(list of individual authors)".
 * V 1.1    Viktor Szakats              Added templates for file and function
 *                                      headers. Committed to CVS.
 * V 1.0    Viktor Szakats              Initial version.
 *
 */