ForNeVeR / ForNeVeR/Cesium

Cesium should support XML documentation

Open
#1,000 0 comments 0 reactions 0 assignees View on GitHub
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

Open the contributing 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.