Orlando Llanes wrote:
Hmmm... Should we just have one procedure declaration with parameters?Or should there be seperate declarations? Reason I have one of each (I know, I know, I didn't add one for the function :P) is to avoid the question of "Will asmname work on procedures with a parameter list?" Maybe there's a better way?
I think a better way is to give a mere description in the "Syntax" part of the doc section and to give examples only in the "Examples" section at the bottom. If `AsmName' were a procedure rather than a directive, the appropriate syntax description would be a Pascal procedure declaration, i.e. a header such as `Procedure Foo ( Bar: Integer );'. In the present case, we must mention that `AsmName' *is* a directive and describe how it is used, e.g.
@samp{AsmName} (directive)
@var{Procedure or Function heading}; AsmName @var{String constant};
Examples must be there in the "Examples" section, and one should be able to compile them without any modification, preferably. For this reason, they normally should not contain duplicate identifiers.
Good luck,
Peter