godotengine / godotengine/godot-docs

Show API documentation for inherited classes inline

Open
#1,877 3 comments 3 reactions 0 assignees View on GitHub
area:class reference content:website discussion enhancement
Dominant language
reStructuredText
Stars
5.7k
Forks
3.8k
Avg merge
1d 20h
Merged PRs (30d)
25

Description

I find using the API Documentation hard, because when looking at a class' methods and attributes, it is not easy to view the inherited ones. When I click on an inherited class, it takes me to the parent class. So I lose continuity in trying to figure out which properties/methods to use. It is really hard to follow when jumping around pages.

In either case a class' methods/properties represent everything all the way up to Object.

The correct way to do API documentation is to provide the ability to expand a parent class summary methods and properties, inside the current page. Not navigate you away from the page.

In some respects, it is similar to the Godot Editor, that shows the inheritance properties and signals.

So, given that, does the C code have the ability to autogenerate GDScript API docs which shows all methods/properties that the class responds to?

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.