Files
harbour-core/doc/hdr_tpl.txt
Viktor Szakats 760112e3c5 2017-09-12 15:13 UTC Viktor Szakats (vszakats users.noreply.github.com)
* bin/check.hb
  * config/*/*.mk
  * contrib/gtwvg/wvgwing.c
  * contrib/hbcomm/comm.prg
  * contrib/hbfbird/tfirebrd.prg
  * contrib/hbfimage/fi_wrp.c
  * contrib/hbformat/hbfmtcls.prg
  * contrib/hbformat/utils/hbformat.prg
  * contrib/hbhttpd/core.prg
  * contrib/hbnetio/utils/hbnetio/hbnetio.prg
  * contrib/hbnetio/utils/hbnetio/netiomgm.hb
  * contrib/hbsqlit3/hdbc.prg
  * contrib/hbwin/win_bmp.c
  * contrib/xhb/htmutil.prg
  * contrib/xhb/thtm.prg
  * contrib/xhb/xhbarr.c
  * contrib/xhb/xhbtedit.prg
  * ChangeLog.txt
  * debian/control
  * debian/copyright
  * doc/*.txt
  * LICENSE.txt
  * package/harbour.spec
  * README.md
  * src/compiler/hbusage.c
  * src/pp/hbpp.c
  * src/rtl/memoedit.prg
  * src/rtl/teditor.prg
  * src/rtl/tget.prg
  * src/rtl/version.c
  * utils/hbi18n/hbi18n.prg
  * utils/hbmk2/hbmk2.prg
  * utils/hbmk2/po/hbmk2.hu.po
  * utils/hbtest/hbtest.prg
    * sync with 3.4 fork (no change in functionality)
      CC3 -> CC4 license, copyright banners, some strings, minor
      code changes, doc folder, TOFIX -> FIXME
2017-09-12 15:15:14 +00:00

130 lines
2.3 KiB
Plaintext

/* 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
====================
FUNCTION HEADER TEMPLATE
========================
/* $DOC$
$AUTHOR$
Copyright YYYY FirstName LastName <me@example.org>
$NAME$
StartHere()
$CATEGORY$
$SUBCATEGORY$
$ONELINER$
$SYNTAX$
$ARGUMENTS$
$RETURNS$
$DESCRIPTION$
$EXAMPLES$
$STATUS$
$COMPLIANCE$
$PLATFORMS$
$VERSION$
$FILES$
$SEEALSO$
Comma separated list of references
$END$
*/
HEADER EXAMPLES
===============
/* $DOC$
$AUTHOR$
Copyright YYYY FirstName LastName <me@example.org>
$NAME$
IsLeapYr()
$CATEGORY$
Date functions
$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$
.T. if <dDate> falls in a leap year, .F. 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
$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(), SET DATE
$END$
*/
/* $DOC$
$AUTHOR$
Copyright YYYY FirstName LastName <me@example.org>
$TEMPLATE$
Function
$NAME$
hb_dateEncStr()
$CATEGORY$
C level API
$SUBCATEGORY$
Date/Time
$ONELINER$
$SYNTAX$
C Prototype
#include <hbdate.h>
long hb_dateEncStr( char * szDate )
$ARGUMENTS$
<szDate>
$RETURNS$
<lResult>
$DESCRIPTION$
$EXAMPLES$
$STATUS$
R
$COMPLIANCE$
NA
$FILES$
$PLATFORMS$
All
$VERSION$
1.0
$SEEALSO$
$END$
*/