Cesium should support XML documentation
Open
area:compiler
area:parser
kind:feature
status:help-wanted
- Dominant language
- C#
- Stars
- 451
- Forks
- 49
- Avg merge
- 13h 59m
- Merged PRs (30d)
- 6
Description
Cesium types and functions should allow documentation in `///` style, similar to C# or F#.
E.g.
```
///
/// The full value is mantissa / (10 ^ places)
///
typedef struct Decimal {
uint8_t places;
uint32_t mantissaLength;
uint8_t *mantissa;
} Decimal;
```
This should generate the `Assembly.xml` documentation file containing the doc for the type `Decimal`.
Contributor guide
Research direction
Start by tracing how Cesium parses `///` comments and emits the `Assembly.xml` documentation file. Use the Decimal example as the expected input and verify that the generated file contains documentation for the Decimal type, including the summary text.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- c, csharp
- Domain
- compilers
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100