0

Include function parameter name

Karthick

17 March 2009 06:30

None

Follow

Hi

I ran Document X on an existing source code. I want the parameter type to be available for the functions in the chm file. What I receive as the output is

Definition
Public Function Add( _
   ByRef st As IStorable _
) As Boolean

Parameters
st

I would like to have the parameter type of the "st" also available as part of the documentation. Similarly for member variables also, the data type is not displayed. I need to click on the variable name to find the data type.

Is there a configuration which can be used to enable this. Otherwise what code should write to get this functionality in DocumentX

Regards
V Karthick.

 

• Facebook
• Twitter
• LinkedIn

4 comments

• 0
  
  Permanently deleted user 17 March 2009 07:13

  A couple of questions to help us understand the problem better - 1. what kind of item are you documenting (e.g. ActiveX type Library, .Net Assemby)? 2. Where is the IStorable type defined?

• 0
  
  Karthick 17 March 2009 07:26

  I am documenting a Visual Basic 6.0 application source code.
  The IStorable type is defined in a separate support dll file. Referenced in the project.

• 0
  
  Permanently deleted user 17 March 2009 07:38

  Is the component referenced by your source code project included in the same documentation project? I believe that it would need to be in order for Document! X to be able to provide a link to that documentation.

• 0
  
  Karthick 17 March 2009 08:52

  This is not specific to a library, Consider the following documentation output from Document X (which has 2 Single data type parameters and a boolean parameter)

  Definition

  Public Sub Load( _
     Optional ByVal Left As Single, _
     Optional ByVal Top As Single, _
     Optional ByVal Wide As Boolean _
  ) 

  
  

  Parameters

  Left
  Top
  Wide
  

  The output that I want is

  Definition

  Public Sub Load( _
     Optional ByVal Left As Single, _
     Optional ByVal Top As Single, _
     Optional ByVal Wide As Boolean _
  ) 

   

  Parameters

  Left    Single
  Top    Single
  Wide  Single
  

  Similarly, for the member variable data types also.