Skip to content
This repository has been archived by the owner on Feb 20, 2024. It is now read-only.

Export documentation as XML file #65

Open
sirhc101 opened this issue Jun 18, 2021 · 0 comments
Open

Export documentation as XML file #65

sirhc101 opened this issue Jun 18, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@sirhc101
Copy link
Collaborator

To provide procedure and object documentations even for AL projects using showMyCode = false it's helpful to ship the documentation as part of the application artifacts. Therfor we plan to add a new action Export XML documentation. This documentation file will include all accessable procedures and objects.

Additionally AL XML documentation extension will look for XML documentation artifacts and parse them to provide information in VS Code, even when Source Code is not accessable. The files must be places in .alxmldoc folder inside project folder. Like with .alpackages you will be able to change the path in settings.json.

To simplify the usage and shipment for XML documentation we will release a DevOps pipeline task alongside the new AL XML Documentation version, to be able to create XML documentation artifacts while Build process and include them into artifacts.

@sirhc101 sirhc101 added the enhancement New feature or request label Jun 18, 2021
@sirhc101 sirhc101 added this to the v1.2.0 milestone Jun 18, 2021
@sirhc101 sirhc101 self-assigned this Jun 18, 2021
@365businessdev 365businessdev modified the milestones: v1.2.0, v2.0.0 Oct 19, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants