New API documentation - Githubissues

goblinengine / goblin

Goblin Engine custom build of Godot

https://goblinengine.github.io

MIT License

12 stars 2 forks source link

New API documentation #4

Open me2beats opened 2 years ago

me2beats commented 2 years ago

I think it would be useful to have documentation for new methods. (by "new" I mean methods that are not in vanila Godot)

Allso I think it would be great to

mark new API methods and classes with some color or icon
be able to see/display only new classes/methods in Search Help

me2beats commented 2 years ago

UPD: I can see some classes are documented already

filipworksdev commented 2 years ago

Some parts are already documented.

I think other ones that are not documented are the core ones such as remove_children() which removes all children of a Node, new_add() which creates and adds a Node into the scene, instance_add() which creates and adds a sub Scene into the Scene, and probably more.

I am also holding off a bit on documenting those in case I remove or change them . Core is much harder to maintain than modules.

filipworksdev commented 2 years ago

Created a missing documentation tracker issue. If you happen to keep using Goblin and find anyth documentation still missing that is not in the tracker please let me know so I can add it to tracker to fix it up