home *** CD-ROM | disk | FTP | other *** search
/ OS/2 Shareware BBS: 10 Tools / 10-Tools.zip / harbb30i.zip / DOC / hdr_tpl.txt < prev    next >
Text File  |  1999-09-15  |  6KB  |  165 lines
  1. /*
  2.  * $Id: hdr_tpl.txt,v 1.9 1999/09/15 14:03:36 vszel Exp $
  3.  */
  4.  
  5. /* NOTE: - Please use these template for your new files, replace parts
  6.            between curly braces {} with the appropriate text.
  7.          - You can find a history at the end of the file. */
  8.  
  9. FILE HEADER TEMPLATE
  10. ====================
  11.  
  12. /*
  13.  * Harbour Project source code:
  14.  * {one-liner description about the purpose of this source file}
  15.  *
  16.  * Copyright 1999 {list of individual authors and e-mail addresses}
  17.  * www - http://www.harbour-project.org
  18.  *
  19.  * This program is free software; you can redistribute it and/or modify
  20.  * it under the terms of the GNU General Public License as published by
  21.  * the Free Software Foundation; either version 2 of the License, or
  22.  * (at your option) any later version, with one exception:
  23.  *
  24.  * The exception is that if you link the Harbour Runtime Library (HRL)
  25.  * and/or the Harbour Virtual Machine (HVM) with other files to produce
  26.  * an executable, this does not by itself cause the resulting executable
  27.  * to be covered by the GNU General Public License. Your use of that
  28.  * executable is in no way restricted on account of linking the HRL
  29.  * and/or HVM code into it.
  30.  *
  31.  * This program is distributed in the hope that it will be useful,
  32.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  33.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  34.  * GNU General Public License for more details.
  35.  *
  36.  * You should have received a copy of the GNU General Public License
  37.  * along with this program; if not, write to the Free Software
  38.  * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA (or visit
  39.  * their web site at http://www.gnu.org/).
  40.  *
  41.  */
  42.  
  43. FILE HEADER TEMPLATE (OPTIONAL ADDITION FOR PARTIAL COPYRIGHTS)
  44. ===============================================================
  45.  
  46. /*
  47.  * The following parts are Copyright of the individual authors.
  48.  * www - http://www.harbour-project.org
  49.  *
  50.  * Copyright 1999 {name} <{e-mail address}>
  51.  *    {function or subsystem name}
  52.  *
  53.  * See doc/license.txt for licensing terms.
  54.  *
  55.  */
  56.  
  57. FUNCTION HEADER TEMPLATE
  58. ========================
  59.  
  60. /*  $DOC$
  61.  *  $FUNCNAME$
  62.  *
  63.  *  $CATEGORY$
  64.  *
  65.  *  $ONELINER$
  66.  *
  67.  *  $SYNTAX$
  68.  *
  69.  *  $ARGUMENTS$
  70.  *
  71.  *  $RETURNS$
  72.  *
  73.  *  $DESCRIPTION$
  74.  *
  75.  *  $EXAMPLES$
  76.  *
  77.  *  $TESTS$
  78.  *
  79.  *  $STATUS$
  80.  *
  81.  *  $COMPLIANCE$
  82.  *
  83.  *  $SEEALSO$
  84.  *
  85.  *  $END$
  86.  */
  87.  
  88. FUNCTION HEADER EXAMPLE
  89. =======================
  90.  
  91. /*  $DOC$
  92.  *  $FUNCNAME$
  93.  *      IsLeapYr()
  94.  *  $CATEGORY$
  95.  *      Dates
  96.  *  $ONELINER$
  97.  *      Test if a date falls in a leap year.
  98.  *  $SYNTAX$
  99.  *      IsLeapYr( [<dDate>] ) --> lIsLeap
  100.  *  $ARGUMENTS$
  101.  *      <dDate> is an optional date. If not supplied is defaults to the
  102.  *      value returned from date().
  103.  *  $RETURNS$
  104.  *      TRUE if <dDate> falls in a leap year, FALSE if not.
  105.  *  $DESCRIPTION$
  106.  *      IsLeapYr() can be used to check if a given year is a leap year.
  107.  *  $EXAMPLES$
  108.  *      // Check if it's a leap year.
  109.  *
  110.  *      If IsLeapYr()
  111.  *         ? "One extra day before you get paid this Feb!!"
  112.  *      Else
  113.  *         ? "A normal year"
  114.  *      EndIf
  115.  *  $TESTS$
  116.  *      valtype( IsLeapYr( date() ) ) == "L"
  117.  *      valtype( IsLeapYr( ctod( "" ) ) ) == "L"
  118.  *      valtype( IsLeapYr() ) == "L"
  119.  *      IsLeapYr( SToD( "20000101" ) )
  120.  *      !IsLeapYr( SToD( "19000101" ) )
  121.  *      IsLeapYr( SToD( "19841231" ) )
  122.  *      !IsLeapYr()
  123.  *  $STATUS$
  124.  *      C
  125.  *  $COMPLIANCE$
  126.  *      IsLeapYr() works exactly like CA-Clipper's IsLeapYr(), if your
  127.  *      CA-Clipper doesn't have such a function you're probably in a
  128.  *      different universe from the author of this function.
  129.  *  $SEEALSO$
  130.  *      Date() IsWeekend() IsHarbourFinished() IsApocalypse()
  131.  *  $END$
  132.  */
  133.  
  134. /* ------------------------------------------------------------------------- */
  135.  
  136. /*
  137.  * ChangeLog:
  138.  *
  139.  * V 1.9    Victor Szel                 Small format changes.
  140.  * V 1.8    Victor Szel                 licence -> license
  141.  * V 1.7    Victor Szel                 History separated from the file header
  142.  *                                      template. Slight changes in the format
  143.  *                                      of the header. Removed "(proposal)"
  144.  *                                      from the top of the file. Added partial
  145.  *                                      copyright header template.
  146.  * V 1.6    Victor Szel                 RCS Id section separated from
  147.  *                                      Licenc text.
  148.  * V 1.5    Victor Szel                 Small name correction.
  149.  * V 1.4    David G. Holm               Removed "(C)" from Copyright notice
  150.  *                                      Put author's name rather than date
  151.  *                                      next to each version number, because
  152.  *                                      the RCS tracks dates, but only tracks
  153.  *                                      CVS user names, not author names.
  154.  * V 1.3    Victor Szel                 Description line changed to be a
  155.  *                                      template, too.
  156.  * V 1.2    David G. Holm               Added HRL/HVM license exception for
  157.  *                                      executables. Added GNU web site.
  158.  *                                      Replaced "?" in copyright statement
  159.  *                                      with "(list of individual authors)".
  160.  * V 1.1    Victor Szel                 Added templates for file and function
  161.  *                                      headers. Committed to CVS.
  162.  * V 1.0    Victor Szel                 Initial version.
  163.  *
  164.  */
  165.