PDA

View Full Version : VDF Spy in Studio 12.1 compatible format



Marco
25-Feb-2008, 06:14 PM
Hi Guys,

I just converted Michael Kurz's VDFSpy workspace located on
www.vdf-guidance.com (vdf 5) to Studio 12.1 compatible code.

I did not test the application itself yet, but the studio likes it now.

Have fun.

ps, this is just a temp placeholder for this code. Please check
www.vdf-guidance.com for the latest version.

Offcourse many thanks to Michael Kurz for this package!!!

Kind regards,
Marco

Nils G. Svedmyr
3-Mar-2008, 06:41 PM
Hi,

I'm having problems getting VDF Spy to work correctly. Has anybody else seen
what is described below?

For no appearant reason it skips some procedures and functions and does not
document them at all. And yes, there are comments added immediately above
the procedure/function declarations.

There is no Public/Private words involved that would explain it.

It's a lovely tool, but if you cannot trust it to document all
properties/procedures and functions its kind of meaningless...

Any ideas?

Best regards,
Nils G. Svedmyr
RDC Tool International

"Marco Kuipers" <marco.kuipers@nci.com.au> skrev i meddelandet
news:PPCDiQAeIHA.4596@dacmail.dataaccess.com...
> Hi Guys,
>
> I just converted Michael Kurz's VDFSpy workspace located on
> www.vdf-guidance.com (vdf 5) to Studio 12.1 compatible code.
>
> I did not test the application itself yet, but the studio likes it now.
>
> Have fun.
>
> ps, this is just a temp placeholder for this code. Please check
> www.vdf-guidance.com for the latest version.
>
> Offcourse many thanks to Michael Kurz for this package!!!
>
> Kind regards,
> Marco
>

Larry Heiges
4-Mar-2008, 01:31 PM
Nils,

>
>For no appearant reason it skips some procedures and functions and does not
>document them at all. And yes, there are comments added immediately above
>the procedure/function declarations.
>
I had the same problem. Seems it requires a comment before the method
to be included in the lists. I was going to look into this, but since
I only needed to look at one short com that wasn't documented, I just
added a // line before each.


Larry Heiges
App-2-Win Systems, Inc.
LookFeel for Windows
lheiges at app-2-win.com

LFW11.1

Application design and implementation.
Support and consultation services.

Nils G. Svedmyr
4-Mar-2008, 04:17 PM
Hi Larry,

The weird part is that in my case I do have comments before the messages,
but in some cases they will just not show up in the .htm document.

Consider the following code:

{ Visibility=Public MethodType=Property }
// To set an icon of a particular header item.
// Syntax:
// Set HeaderIcon item iColumn to RO_ButtonNormal
// Params:
// iIcon is the icon number from the ImageList
Procedure Set HeaderIcon Integer iIcon
Set ComIcon to iIcon
End_Procedure // Set HeaderIcon

{ Visibility=Public MethodType=Property }
// Syntax:
// Get HeaderIcon to Integer (in Enum_List)
// The returned integer is the icon number from the ImageList
Function HeaderIcon Returns Integer
Integer iIconNumber
Get ComIcon to iIconNumber
Function_Return iIconNumber
End_Procedure // HeaderIcon

Register_Procedure ComToolTip

{ Visibility=Public MethodType=Property }
// Set the tooltip of a particular header item.
// Syntax:
// Set HeaderToolTip to "tooltip text"
Procedure Set HeaderToolTip String sToolTip
If (not(IsComObjectCreated(Self))) Procedure_Return
Set ComToolTip to sToolTip
End_Procedure // Set HeaderToolTip

{ Visibility=Public MethodType=Property }
// Get the tooltip of a particular header item.
// Syntax:
// Get HeaderToolTip to String
Function HeaderToolTip Returns String
String sToolTip
If (not(IsComObjectCreated(Self))) Function_Return ""
Set ComToolTip to sToolTip
Function_Return sToolTip
End_Function // HeaderToolTip

....more procedures and functions (that will be included in the .htm
document).

This will happen:

The two HeaderIcon messages will be included into the .htm document.
However, the two HeaderToolTip messages will not!

At least I cannot see any appearant reason why the HeaderIcon messages are
left out. And, no the 'Register_Procedure ComToolTip' line has nothing todo
with it (I have other lines like that were it works just fine.)

Have you seen this? Or, after have run the CodeSpy have you checked that
_all_ your messages with comments actually are included into your .htm
document?

Best regards,
Nils G. Svedmyr


"Larry Heiges" <lheiges@app-2-win.com> skrev i meddelandet
news:385rs3h2t5qofc46juf2kci4p9rutd4nu5@4ax.com...
> Nils,
>
>>
>>For no appearant reason it skips some procedures and functions and does
>>not
>>document them at all. And yes, there are comments added immediately above
>>the procedure/function declarations.
>>
> I had the same problem. Seems it requires a comment before the method
> to be included in the lists. I was going to look into this, but since
> I only needed to look at one short com that wasn't documented, I just
> added a // line before each.
>
>
> Larry Heiges
> App-2-Win Systems, Inc.
> LookFeel for Windows
> lheiges at app-2-win.com
>
> LFW11.1
>
> Application design and implementation.
> Support and consultation services.

Larry Heiges
4-Mar-2008, 10:46 PM
>
>The weird part is that in my case I do have comments before the messages,
>but in some cases they will just not show up in the .htm document.
>
>Consider the following code:
>
> { Visibility=Public MethodType=Property }
> // To set an icon of a particular header item.
> // Syntax:
> // Set HeaderIcon item iColumn to RO_ButtonNormal
> // Params:
> // iIcon is the icon number from the ImageList
> Procedure Set HeaderIcon Integer iIcon
> Set ComIcon to iIcon
> End_Procedure // Set HeaderIcon
>
> { Visibility=Public MethodType=Property }
> // Syntax:
> // Get HeaderIcon to Integer (in Enum_List)
> // The returned integer is the icon number from the ImageList
> Function HeaderIcon Returns Integer
> Integer iIconNumber
> Get ComIcon to iIconNumber
> Function_Return iIconNumber
> End_Procedure // HeaderIcon
>


> Register_Procedure ComToolTip
Is this the problem? Maybe this is stopping the parsing or getting it
out of sync for awhile.


>
> { Visibility=Public MethodType=Property }
> // Set the tooltip of a particular header item.
> // Syntax:
> // Set HeaderToolTip to "tooltip text"
> Procedure Set HeaderToolTip String sToolTip
> If (not(IsComObjectCreated(Self))) Procedure_Return
> Set ComToolTip to sToolTip
> End_Procedure // Set HeaderToolTip
>
> { Visibility=Public MethodType=Property }
> // Get the tooltip of a particular header item.
> // Syntax:
> // Get HeaderToolTip to String
> Function HeaderToolTip Returns String
> String sToolTip
> If (not(IsComObjectCreated(Self))) Function_Return ""
> Set ComToolTip to sToolTip
> Function_Return sToolTip
> End_Function // HeaderToolTip
>
>...more procedures and functions (that will be included in the .htm
>document).
>
>This will happen:
>
>The two HeaderIcon messages will be included into the .htm document.
>However, the two HeaderToolTip messages will not!
>
>At least I cannot see any appearant reason why the HeaderIcon messages are
>left out. And, no the 'Register_Procedure ComToolTip' line has nothing todo
>with it (I have other lines like that were it works just fine.)
>
>Have you seen this? Or, after have run the CodeSpy have you checked that
>_all_ your messages with comments actually are included into your .htm
>document?

Just looked and all seemed to be there. It is a com with no
documentation unless you buy the book... so the initial runs with Spy
just returned the objects.

>
>Best regards,
>Nils G. Svedmyr
>
>
>"Larry Heiges" <lheiges@app-2-win.com> skrev i meddelandet
>news:385rs3h2t5qofc46juf2kci4p9rutd4nu5@4ax.com...
>> Nils,
>>
>>>
>>>For no appearant reason it skips some procedures and functions and does
>>>not
>>>document them at all. And yes, there are comments added immediately above
>>>the procedure/function declarations.
>>>
>> I had the same problem. Seems it requires a comment before the method
>> to be included in the lists. I was going to look into this, but since
>> I only needed to look at one short com that wasn't documented, I just
>> added a // line before each.
>>
>>
>> Larry Heiges
>> App-2-Win Systems, Inc.
>> LookFeel for Windows
>> lheiges at app-2-win.com
>>
>> LFW11.1
>>
>> Application design and implementation.
>> Support and consultation services.
>

Larry Heiges
App-2-Win Systems, Inc.
LookFeel for Windows
lheiges at app-2-win.com

LFW11.1

Application design and implementation.
Support and consultation services.

Nils G. Svedmyr
5-Mar-2008, 01:28 AM
Hi Larry,

RE:
> Register_Procedure ComToolTip
> Is this the problem? Maybe this is stopping the parsing or getting it
> out of sync for awhile.

As said in my original posting:

> And, no the 'Register_Procedure ComToolTip' line has nothing todo
> with it (I have other lines like that were it works just fine.)

And yes, CodeSpy seems to work just fine with COM objects auto generated
code. But haven't you tried it on some of your own classes? That would tell
a whole lot more...

Best regards,
Nils G. Svedmyr
RDC Tools International

wila
5-Mar-2008, 03:44 AM
Interesting, I now know that i should looked closer at the source Nils
provided here as it has the problem embedded.

Look at this function:

Function HeaderIcon Returns Integer
Integer iIconNumber
Get ComIcon to iIconNumber
Function_Return iIconNumber
End_Procedure // HeaderIcon

Yip.... maybe the DataFlex compiler doesn't puke on End_Procedure but
VDF Spy just keeps on reading until the first End_Function it encounters...

Change this into End_Function and you'll find your missing methods.
--
Wil

Nils G. Svedmyr wrote:
> Hi Larry,
>
> RE:
>> Register_Procedure ComToolTip
>> Is this the problem? Maybe this is stopping the parsing or getting it
>> out of sync for awhile.
>
> As said in my original posting:
>
>> And, no the 'Register_Procedure ComToolTip' line has nothing todo
>> with it (I have other lines like that were it works just fine.)
>
> And yes, CodeSpy seems to work just fine with COM objects auto generated
> code. But haven't you tried it on some of your own classes? That would tell
> a whole lot more...
>
> Best regards,
> Nils G. Svedmyr
> RDC Tools International
>
>

wila
5-Mar-2008, 03:47 AM
Larry Heiges wrote:
> Nils,
>
>> For no appearant reason it skips some procedures and functions and does not
>> document them at all. And yes, there are comments added immediately above
>> the procedure/function declarations.
>>
> I had the same problem. Seems it requires a comment before the method
> to be included in the lists. I was going to look into this, but since
> I only needed to look at one short com that wasn't documented, I just
> added a // line before each.
[wil] Ah, i have a vague recollection of this as well. It's not the most
obvious bug.

If i understand you correctly then:

// This comment is not processed
Procedure FooBar

//
// But this comment is processed
Procedure FooBar

There's probably a bit more of this type of good to know "features" in
there.
--
Wil

Nils G. Svedmyr
5-Mar-2008, 06:19 AM
Wil,

Well done. That was certainly the culprit.

Cheers,
Nils G.

"Wil van Antwerpen" <info@antwise.com> skrev i meddelandet
news:47CE5D59.6070606@antwise.com...
> Interesting, I now know that i should looked closer at the source Nils
> provided here as it has the problem embedded.
>
> Look at this function:
>
> Function HeaderIcon Returns Integer
> Integer iIconNumber
> Get ComIcon to iIconNumber
> Function_Return iIconNumber
> End_Procedure // HeaderIcon
>
> Yip.... maybe the DataFlex compiler doesn't puke on End_Procedure but VDF
> Spy just keeps on reading until the first End_Function it encounters...
>
> Change this into End_Function and you'll find your missing methods.
> --
> Wil
>
> Nils G. Svedmyr wrote:
>> Hi Larry,
>>
>> RE:
>>> Register_Procedure ComToolTip
>>> Is this the problem? Maybe this is stopping the parsing or getting it
>>> out of sync for awhile.
>>
>> As said in my original posting:
>>
>>> And, no the 'Register_Procedure ComToolTip' line has nothing todo
>>> with it (I have other lines like that were it works just fine.)
>>
>> And yes, CodeSpy seems to work just fine with COM objects auto generated
>> code. But haven't you tried it on some of your own classes? That would
>> tell a whole lot more...
>>
>> Best regards,
>> Nils G. Svedmyr
>> RDC Tools International
>>

Michael Fenton
5-Mar-2008, 12:11 PM
I think you will see the explanation in FMAC. End_Function is replaced
by End_Procedure by default, and End_Procedure can call a compiler error
of Missing End_Object.
Logical ??


Wil van Antwerpen wrote:
> Larry Heiges wrote:
>> Nils,
>>
>>> For no appearant reason it skips some procedures and functions and
>>> does not document them at all. And yes, there are comments added
>>> immediately above the procedure/function declarations.
>>>
>> I had the same problem. Seems it requires a comment before the method
>> to be included in the lists. I was going to look into this, but since
>> I only needed to look at one short com that wasn't documented, I just
>> added a // line before each.
> [wil] Ah, i have a vague recollection of this as well. It's not the most
> obvious bug.
>
> If i understand you correctly then:
>
> // This comment is not processed
> Procedure FooBar
>
> //
> // But this comment is processed
> Procedure FooBar
>
> There's probably a bit more of this type of good to know "features" in
> there.
> --
> Wil

Larry Heiges
5-Mar-2008, 06:34 PM
On Wed, 05 Mar 2008 09:47:48 +0100, Wil van Antwerpen
<info@antwise.com> wrote:

>Larry Heiges wrote:
>> Nils,
>>
>>> For no appearant reason it skips some procedures and functions and does not
>>> document them at all. And yes, there are comments added immediately above
>>> the procedure/function declarations.
>>>
>> I had the same problem. Seems it requires a comment before the method
>> to be included in the lists. I was going to look into this, but since
>> I only needed to look at one short com that wasn't documented, I just
>> added a // line before each.
>[wil] Ah, i have a vague recollection of this as well. It's not the most
>obvious bug.
>
>If i understand you correctly then:
>
>// This comment is not processed
>Procedure FooBar
>
>//
>// But this comment is processed
>Procedure FooBar
>

Actually it was:

Procedure FooBar
not processed

//
Procedure FooBar
processed





Larry Heiges
App-2-Win Systems, Inc.
LookFeel for Windows
lheiges at app-2-win.com

LFW11.1

Application design and implementation.
Support and consultation services.

wila
6-Mar-2008, 02:46 AM
Thanks Larry,
You are absolutely correct. I've added both issues as known issues to
the project's page at vdf-guidance.
--
Wil

Larry Heiges wrote:
> On Wed, 05 Mar 2008 09:47:48 +0100, Wil van Antwerpen
> <info@antwise.com> wrote:
>
>> Larry Heiges wrote:
>>> Nils,
>>>
>>>> For no appearant reason it skips some procedures and functions and does not
>>>> document them at all. And yes, there are comments added immediately above
>>>> the procedure/function declarations.
>>>>
>>> I had the same problem. Seems it requires a comment before the method
>>> to be included in the lists. I was going to look into this, but since
>>> I only needed to look at one short com that wasn't documented, I just
>>> added a // line before each.
>> [wil] Ah, i have a vague recollection of this as well. It's not the most
>> obvious bug.
>>
>> If i understand you correctly then:
>>
>> // This comment is not processed
>> Procedure FooBar
>>
>> //
>> // But this comment is processed
>> Procedure FooBar
>>
>
> Actually it was:
>
> Procedure FooBar
> not processed
>
> //
> Procedure FooBar
> processed
>
>
>
>
>
> Larry Heiges
> App-2-Win Systems, Inc.
> LookFeel for Windows
> lheiges at app-2-win.com
>
> LFW11.1
>
> Application design and implementation.
> Support and consultation services.

Nils G. Svedmyr
10-Mar-2008, 09:06 AM
Hi All,

There is an update of CodeSpy availble at www.VDF-Guidance.com

Several enhancements has been implemented. Among those is one that allows
you to select the style sheet to be used when generating source code
documentation in html format.

It is fully compatible with the 12.1 Studio.

Have fun!

Best regards,
Nils G. Svedmyr
RDC Tools International

wila
14-Mar-2008, 12:44 PM
And another update in the project as the parser had a strange default
setting. It contains a bit of code to limit the parser and it was
limited to parse only 1000 lines (ouch!)

So I just uploaded a patched version that sets the limit to 10000 lines.
Thanks to Nils for reporting the issue.
--
Wil

Nils G. Svedmyr wrote:
> Hi All,
>
> There is an update of CodeSpy availble at www.VDF-Guidance.com
>
> Several enhancements has been implemented. Among those is one that allows
> you to select the style sheet to be used when generating source code
> documentation in html format.
>
> It is fully compatible with the 12.1 Studio.
>
> Have fun!
>
> Best regards,
> Nils G. Svedmyr
> RDC Tools International
>
>