Documentation for the standard library

[antoyo]

Hi.
Is there any documentation for the standard library?
Thanks.

[andrewrk]

Hi antoyo

Here's the roadmap to get documentation for the standard library:

• pointer reform (Pointer Reform #770)
• copy elision (result location mechanism (previously: well defined copy eliding semantics) #287)
• coroutine rewrite (coroutine semantics are unsound. proposal to fix them #1363)
• self hosted compiler (self-hosted compiler: ship it! #89)
• auto generated docs (generate html documentation for a library #21)
• improve std lib documentation with doc comments (this issue)

[markfirmware]

Without doc comments, will the doc processor still produce a structured presentation of struct’s, functions, etc? I think that would be helpful in the short term.

[andrewrk]

Without doc comments, will the doc processor still produce a structured presentation of struct’s, functions, etc?

Yes absolutely and it will additionally show the inferred error sets, so you can see all the ways it is possible for a function to fail. There's a lot of helpful information a documentation generator can show even with no doc comments.

[andrewrk]

This is now done. See #21 (comment) for the remaining issues.