How to get generated Json documentation shown by IntelliSense in VS Code, when typing or reviewing the code?

[DO-SPI]

Hello everyone,

I am currently playing a little with the OpenEdge ABL extension for the VS Code and I cannot get Json documentation shown by IntelliSense in VS Code, when typing or reviewing the code. The Json documentation is generated using PCT tools and I can see my custom comments in the generated Json file. However, when I hover over a method in VS Code only the method signature is shown - no custom comments.
The corresponding buildPath configuration in openedge-project.json looks like this:

{
            "path": "src",
            "type": "source",
            "build": "rcode",
            "documentation": "build/JsonDocumentation.json"
        },

The methods I try to get information about are defined in the classes under src folder.
Did anybody get this feature working? On the last PUG challenge conference in Valencia there was a workshop devoted to the OpenEdge ABL extension for VS Code, where we tried similar scenario with documentation for a Progress PL library - it worked then. My assumption was that the Json documentation can be provided and shown, including custom comments, for all kinds of compiled code. Does it only work with PL libraries? I am looking forward to getting any information and/or explanation to this topic.

Kind regards,
Dmitry

[gquerret]

You do not need to specify documentation attribute for source entries, comments are extracted automatically (if you use the right format). The documentation attribute can be used for propath entries. Json file must be generated with JsonDocumentation task.

[DO-SPI]

Thank you for the explanation Gilles. Then, my problem is that we do not use the "right format" for our custom comments. I did use JsonDocumentation for generation of the Json file and I figured out that, if I set the style attribute to "consultingwerk", my custom comments are parsed into the generated file. My assumption was that this way I could use our current formatting for comments and get the comments shown by IntelliSense. Is it possible to achive? Our comments have the following format:

/*------------------------------------------------------------------------------
     Purpose: get order with contained order positions
     Notes: 
     @param orderReference reference number
     @param OrderDS dataset
    ------------------------------------------------------------------------------*/

[gquerret]

Looks like the comment style can't be changed from VS Code. Option will be added.

[DO-SPI]

Thanks Gilles, I will be looking forward to trying the new option.

[gquerret]

You can clone this sample project and open it in VS Code. Class rssw.SimpleObject has some documentation that should be visible in method calls.

[DO-SPI]

In the sample project it works as you describe. Unfortunately, our comments are not in Javadoc format, as mentioned in the post above.