Dyon API

for Dyon

At the top level of the project, there is usually a "DYON-API.md" file.

This "DYON-API.md" file is used to explain the API for the project.

Here you will find links and resources to learn how a project works.

About Dyon library API

Dyon API is usually put under the "src" folder in a project.

For example, in this project, there is a src/lib.dyon file:

• Link to "lib.dyon"

These links should be to the upstream repository, so people can easily find out the latest version and compare it with their local copy.

Doc comments use /// and external functions have no function body { ... }.

For example:

/// Prints out variable to standard output, adding newline character.
fn println(var: any) { ... }

These files are often used for an overview, so try keep them short. However, remember to put a blank line between functions for readability.

By convention, it is a good practice to keep doc comments short. If you need extensive documentation, then link to more information.

A library might provide a Dyon API without implementing it as Rust code. Sometimes, implementation is backend-specific and implemented as an example. If this is the case, then there should be a notice about this here, with a list of functions that must be implemented. Make sure to include a link to the upstream example code.

Functions that must be implemented:

• <namespace>::<function_name>

At the bottom of each "DYON-API.md" file, there should be the following declaration:

Dyon API policy

This document follows the official Dyon API policy.