API documentation

Learn about how to make sure APIs are documented

All public APIs MUST be documented regardless of what language and use-case.

C# XML Comments

All C# files MUST be documented using XML documentation comments.

For inheritance in documentation, you can use the <inheritdoc/> element.


All JavaScript files MUST be documented using JSDoc.

Last modified December 23, 2020: Change dolittle.io to docsy theme (3a7aed3)