HaxeFoundation / HaxeFoundation/haxe

Thread API documentation is missing

Open
#9,706 1 comment 0 reactions 0 assignees View on GitHub
bug documentation
Dominant language
Haxe
Stars
6.9k
Forks
715
Avg merge
2d 2h
Merged PRs (30d)
11

Description

The Thread API documentation [here](https://api.haxe.org/sys/thread/Thread.html) has no text explaining what the functions do. I clicked through to the source code, which *does* seem to have valid "javadoc" comments: [here](https://github.com/HaxeFoundation/haxe/blob/4.1.2/std/sys/thread/Thread.hx).

Other documentation pages show the "javadocs" for each function. If I hadn't clicked through to source I wouldn't have been able to puzzle out how to write Thread code. Something must be going wrong in the doc generation. I don't know if other API docs are affected.

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.