ASDoc

[hydroper]

The following command can be added to run aasdoc given different IDE configurations. If the following command runs in a project containing an asconfig.json, commonly used in Visual Studio Code, it reads sources from there.

apm doc

asconfig.json behavior

• Here is what an asconfig.json configured library looks like; read compilerOptions["include-sources"] and push all sources recursively from there.
• Here is what an asconfig.json configured application looks like; read compilerOptions["source-path"] and push all sources from that folder recursively.

ASDoc is then called with --doc-sources+=.

Online API References

There are two ways of auto publishing API references so that the public can access it to get an idea of what a library looks like before depending on it:

• Use a Docker container to run apm doc and host the result somewhere in the internet
• If there are no insecure build scripts involved, run apm doc without a Docker container and host the result somewhere in the internet