AL-Go icon indicating copy to clipboard operation
AL-Go copied to clipboard

Deploy Reference Documentation (ALDoc) action missing symbols and xml documentation not showing

Open louagej opened this issue 1 year ago • 10 comments

I added ALDoc to my settings.json file (with beas supported country):

image

The CI/CD action deployed the generated documentation:

image

But the static site does not have all information I expected:

  1. MissingTypeSymbol

The symbols for the parameter of a function isn't found

This is my procedure in AL:

    procedure SetStatementNoWithYearPrefix(var CODAStatement: Record "CODA Statement")

And this is the output on the generated Docs:

image

  1. AL XML Documentation does not show

This is the doccumentation in AL:

    /// <summary>
    /// Set Statement No. With Year Prefix.
    /// Banks reset Statement No. every year. To prevent duplicate Statement No. in BC, we need to add year prefix to Statement No.
    /// </summary>
    /// <param name="CODAStatement">VAR Record "CODA Statement".</param>

And this is the output on the generated Docs:

image

louagej avatar Jan 23 '24 08:01 louagej

And the "CODA Statement" record - is that in the same app? or in a dependent app? Is in in a app from the same repository or a different repo?

freddydk avatar Jan 23 '24 09:01 freddydk

Hi Freddy,

this is in the be localisation

louagej avatar Jan 23 '24 09:01 louagej

got it - sounds like a bug - will investigate

freddydk avatar Jan 23 '24 09:01 freddydk

I can definitely repro this, this is a bug. We will have to populate the a cache folder with referenced apps and hand that over to aldoc. Will work on a fix asap

freddydk avatar Feb 11 '24 10:02 freddydk

This reproes for symbols in any base app: https://microsoft.github.io/bcsamples-bingmaps.pte/reference/bingmaps.pte/Codeunit/BingMaps-Geocode.html

freddydk avatar Apr 15 '24 05:04 freddydk

If we add the parameter -c (packagecache) where the value is the path to the alpackages, the MissingTypeSymbols-Issue is gone.

Current call in AL-Go: image

How we get it working in powershell: image

RothDominic avatar Sep 11 '24 10:09 RothDominic

I don't think we can currently control this -c parameter with setup in our project.

louagej avatar Sep 12 '24 06:09 louagej