Generate Documentation Overview

Generate Documentation Overview

This module allows you to create a complete, markdown-based API documentation for a project or workspace. Markdown is a human-readable format that can be converted to HMTL or many other formats using external tools.

Generated files are internally navigable, there is a table of contents for objects and for methods/events inside the objects.

Features

  • Single documentation creation from Codeunit/Interface viewer
  • Complete documentation creation for opened workspace
    • One big markdown file is created
    • A folder with one Markdown/object structure is also created

Output Formats

text

Layout

text

Generate Documentation for a single Object

text

Generate Documentation for a folder or complete workspace

text

See Also

CLI and DevOps integration

    • Related Articles

    • Dashboard Overview

      AL Home screen is automatically loading after opening a VS Code folder / workspace. It is designed to function as a starting dashboard for usual developer/consultant activities. AL Studio can process the complete workspace information whether it be ...

    • Codeunit Overview

      This window provides a general overview of any codeunit, interface of control add-in object. Methods and Event publishers/subscribers are displayed on two columns next to each other. Features Search for method/event name Show Properties Show source ...

    • Translation Overview

      This screen provides a matrix-like summary of all available XLF translations found in the workspace. Left columns represent data from generated XLF files, translations are dynamically displayed as additional columns. Features View translations as ...

    • Control Add-in Viewer Overview

      This window provides a general overview of any codeunit, interface of control add-in object. Methods and Event publishers/subscribers are displayed on two columns next to each other. Features Search for method/event name Show Properties Show source ...

    • Get Started

      AL Studio is a set of visual tools for editing, navigating or documenting AL Objects without complex running environments. It is built with a holistic approach that aims to provide users with better understanding of their whole workspace. Product ...