rawsp33d/gdext-v

Doc comment registration

Open

#3 opened on Apr 22, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)V (1 fork)auto 404
documentationenhancementhelp wanted

Repository metrics

Stars
 (15 stars)
PR merge metrics
 (PR metrics pending)

Description

Doc comments should be registered with Godot for our V classes.

In V we don't have easy access to doc comments, but we can import the parser and use it for now. Long-term, as discussed here it seems in the cards to add doc comments like Rust has (///) to V.

Contributor guide

Research direction
Explore how to parse doc comments in V using the built in parser, then register them for V classes in the GDExtension bindings. Refer to the Discord discussion for long term plans.
Tech stack
None
Domain
documentationtooling
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
V languageGodot basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60