Hi Viktor

1.  FUNCTION HEADER TEMPLATE
    ======================

/*  $DOC$
    $NAME$

    $CATEGORY$

    $SUBCATEGORY$

    $ONELINER$

    $SYNTAX$

    $ARGUMENTS$

    $RETURNS$

    $DESCRIPTION$

    $EXAMPLES$

    $TESTS$

    $STATUS$

    $COMPLIANCE$

    $PLATFORMS$

    $VERSION$

    $FILES$

    $SEEALSO$
       comma separated list of references
    $END$
 */

And it does not include the $TEMPLATE$.
Later in one example it is present:

/*  $DOC$
    $TEMPLATE$
        Function
    $NAME$
        hb_dateEncStr()
    $CATEGORY$
  
Does not it be included in definition too ?

2.  $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.

My understanding suggests that instead of "description" it 
should be "data", like Clipper 5.3, Xbase++, ...
a comma separated list of compilers and/or OS's.


3.  $NAME$ 

Should it contain opening/closing braces "()".
I think it should be the part of $SYNTAX$.

And few more but later...
  



-----
                 enjoy hbIDEing...
                    Pritpal Bedi 
_a_student_of_software_analysis_&_design_
-- 
View this message in context: 
http://n2.nabble.com/Harbour-Documentation-doc-hdr-tpl-txt-Clarifications-tp4615380p4615380.html
Sent from the harbour-devel mailing list archive at Nabble.com.
_______________________________________________
Harbour mailing list (attachment size limit: 40KB)
Harbour@harbour-project.org
http://lists.harbour-project.org/mailman/listinfo/harbour

Reply via email to