Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
louagej opened this issue Jan 23, 2024 · 10 comments
Assignees
Labels
bug Something isn't working

Comments

@louagej
Copy link

louagej commented Jan 23, 2024

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

@freddydk
Copy link
Contributor

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?

@louagej
Copy link
Author

louagej commented Jan 23, 2024

Hi Freddy,

this is in the be localisation

@freddydk
Copy link
Contributor

got it - sounds like a bug - will investigate

@freddydk freddydk added bug Something isn't working Under Investigation Issue is under investigation labels Jan 23, 2024
@freddydk
Copy link
Contributor

freddydk commented Feb 11, 2024

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 freddydk removed the Under Investigation Issue is under investigation label Feb 11, 2024
@freddydk freddydk self-assigned this Apr 15, 2024
@freddydk
Copy link
Contributor

freddydk commented Apr 15, 2024

@RothDominic
Copy link

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

@louagej
Copy link
Author

louagej commented Sep 12, 2024

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

@navdotnetreqs
Copy link

navdotnetreqs commented Feb 11, 2025

Not sure if related; "ALDoc - Referenced module not loaded. Name:'Application'"
microsoft/AL#7965

Edit:
Looks that way. I ran "Deploy Reference Documentation" manually after CICD having been run successfully:

invoke C:\Users\runneradmin\AppData\Local\Temp\42178964-975c-492f-b384-a3b0aeba2fc7\extension\bin\win32\aldoc.exe build --output "C:\Users\runneradmin\AppData\Local\Temp\8889ac05-0702-478f-b256-38c0b726f0c8" --loglevel Info --source "D:\a\trades-rough\trades-rough.artifacts\trades-rough-main-Apps-1.0.2.0\TMods_1.0.2.0.app"
warning: Referenced module not loaded. Name:'Application', Version:25.0.0.0, AppId:00000000-0000-0000-0000-000000000000
warning: Referenced module not loaded. Name:'System', Version:1.0.0.0, AppId:8874ed3a-0643-4247-9ced-7a7002f7135d

@navdotnetreqs
Copy link

@freddydk any updates on this? I see bingmaps still has MissingTypeSymbol.

@freddydk
Copy link
Contributor

Haven't had the time to prioritize this yet unfortunately.
Will try to prioritize bug fixes and documentation more over the upcoming period

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

4 participants