Hi,

> In addition I would like to suggest:
> 
> 1 Separate "$FILES$" into logical units
> 
>   $SOURCEFILE$     =>  It is always one and with relative qualified path
> from Harbour root

I'd vote strongly against this. First of all, 
for users this has near zero importance. Second, 
it requires such an additional effort when working 
with source code to keep this information true, 
that it practically will not be updated when 
source name changes, or function/source file gets 
moved, so the information becomes misinformation, 
which is bad.

>   $HEADERSFILES$  => Only names separated with "," 
>                            => if it depends on many or only one with
> primary dependance 

This is already included in $SYNTAX$ section, I 
think it's fine as it is:
---
 *  $SYNTAX$
 *      C Prototype
 *
 *      #include "hbapifs.h"
 *      hb_fsChDir( BYTE * pszDirName ) --> ( HB_BOOL ) bResult
---

>   $LIB$                 => only name without suffix.

I was thinking about it, but I'd rather vote 
to keep Harbour as easy to use as possible, so 
that users don't have to worry about lib names at 
all. In core this is already true if someone is 
using hbmk2, and for contribs it's also always 
obvious by linking <libname>.hbc file. This is 
a general rule, no need to replicate it for 
all functions, since it's huge and unnecessary 
maintenance work.

IOW this causes lots of extra maintenance 
work for us, with not too much gain for users.

> 2. $SEAALSO#  must also follow a certain pattern, say, separated with spaces
> or comma.

Definitely. I think it's already defined as comma. 
If not, we should now define it as comma. Space 
is not good, as commands may have spaces in them.

Brgds,
Viktor

_______________________________________________
Harbour mailing list (attachment size limit: 40KB)
[email protected]
http://lists.harbour-project.org/mailman/listinfo/harbour

Reply via email to