IDE - HELP-Comment, to set the displayed Help-Text in Editor

[PureLust]

So far, the whole Declaration of a Procedure or Macro will be displayed as Help-Text at the Bottom of the IDE.

Would it be possible to define this Help-Text, maybe by a following Comment with a Keyword (like the TODO or FIXIT Keywords)?

Example:
Procedure.s hBox(Expand, Align=#PB_Default, Spacing=#PB_Default, XmlParam$="") actually generates the Help Text:

hBox(Expand, Align=#PB_Default, Spacing=#PB_Default, XmlParam$="") which is not very clear to read.

A Help-Text in the usual PB-Format would be much easier to read:

hBox(Expand [, Align [, Spacing [, XmlParam$]]]) - generates a String with a <hbox...>-Tag in XML-Format


Maybe it could be implemented like this:

Procedure.s hBox(Expand=#PB_Default, Align=#PB_Default, Spacing=#PB_Default, XmlParam$="") ; HELP: hBox(Expand [, Align [, Spacing [, XmlParam$]]]) - generates a String with a <hbox...>-Tag in XML-Format

[Sicro]

A workaround to realize this now, was found by the thread creator, when he wrote his "DynamicDialogs" module.

He certainly will not mind if I also make known here.

Example:

Code: Select all

DeclareModule test
  CompilerIf #False
    ; Dummy declarations
    Declare bla(a.s, [b.s, c.s])
    Declare bla(a.s, [b.s, [c.s]])
  CompilerElse
    Declare bla(a.s, b.s = "", c.s = "")
    Declare bla2(a.s, b.s = "", c.s = "")
  CompilerEndIf
EndDeclareModule

Module test
  Procedure bla(a.s, b.s = "", c.s = "")
    ; ...  
  EndProcedure

  Procedure bla2(a.s, b.s = "", c.s = "")
    ; ...  
  EndProcedure
EndModule

Now if you typing

Code: Select all

test::bla(

in the editor, this info text appears below in the status bar:

Code: Select all

bla(a.s, [b.s, c.s])

Now if you typing

Code: Select all

test::bla2(

in the editor, this info text appears below in the status bar:

Code: Select all

bla2(a.s, [b.s, [c.s]])