As a developer you always need to read the documentation to assist you in your work or get the AI model to learn from.

For our aviation SDK, we have a sub domain that hosts all the required information and documentation covering all the API’s and handy development notes. This is effectively a website and is generated automatically by reading the source code, looking at the structure and reading the comments that we have placed at the top of each method, class or struct. This is also generated automatically in a pipeline in Azure DevOps using a tool called DocFX; click the link to find out more.

You can find this website at Aviation Business Objects where the front page is an overview of the SDK and there are two links at the top menu bar that lead through to Articles and the API documentation.

When looking at the API documentation, is is grouped by Namespace on the left where you can expand by clicking on the plus (+) symbol.

This will then expose the finer details of the API giving you all the details like Constructors, Fields, Properties, Methods, etc.

This is a brief overview of how we create the documentation. If you’d like to learn more or have any questions, please feel free to get in touch.