Resources  
  FAQ
Online Help File
Examples
External Links
 
  Online Help File  
  The Time2HELP help file is available online.  
  Order Time2HELP  
  Order Time2help and pay by credit card, check or bank transfer.  
  Order online from Kagi.  
  Download trial version  
 

Download the 30 day trial version of Time2HELP now.

 
 

 

From Vision to Code - Built by Delphi

 

 
Painless Documentation
for your Source Code
 
    Home   Features  Download   Support   News   Order   

Parameter types for methods

When T2H does a refresh/resync of a UnitDoc file, the parameters are added to the Params attribute in the method/routine element. The special form of parameters used in Params attributes in UnitDoc files are for example:

integer@boolean

for a method/routine taking one integer and one boolean value. The types are concatenated with a '@' as separator.

If a method is overloaded, there will be mulitple occurrences of the method element the UnitDoc file, but the params attributes will have different values. If the parameter types for a method in the source file changes, the UnitDoc file will (after synchronization) be updated with a new occurrence of the method element with the parameter attribute corresponding to the parameter types. The previous version of the method will still be present in the UnitDoc file, but the attribute Exists will be set to false. This indicates that method element doesn't have a corresponding method in the source, and will not be included in the output.

In the example below, the first occurrence of the UnitDoc method element has a corresponding method in the source, the second occurrence is does not have a corresponding method in the source.


<Method Name="MethodOverload" Params="integer">
<Summary></Summary>
<Desc></Desc>
</Method>

<Method Name="MethodOverload" Params="integer@string" Exists="false">
<Summary></Summary>
<Desc></Desc>
</Method>
This page was last updated 2005-08-21 .
Copyright © 1997-2005 by Digital Logikk AS.