Comments (3)
For built-in types, there's only so many: _enter_tree, _exit_tree, _input, _physics_process, _process, _ready, _unhandled_input, and _unhandled_key_input. I imagine we can maintain a dictionary for those.
Though virtual VS private is the other niggle. I'd really prefer not having double underscores. I'm already not a fan of how one looks, heh. That said, an API reference will point out functions that are public facing. Simply not adding a docstring to a function should make it essentially-private as far as a documentation generator is concerned.
Then we differentiate a virtual and private function (or a virtual private function) by the mere fact that it is or isn't documented.
from gdscript-docs-maker.
For builtins yes, I already have the list actually.
Simply not adding a docstring to a function should make it essentially-private as far as a documentation generator is concerned.
It's too easy to forget a docstring, or to document a function that shouldn't be. We shouldn't rely on us not making mistakes for the tool to work as expected.
It's a pity we don't have a virtual keyword, but at least a virtual function is one that should just pass
, it shouldn't define any behavior, so I guess we can rely on that, and count the leading underscore as private otherwise.
from gdscript-docs-maker.
Though with typed GDScript and virutla functions that return a value, we can't just pass - if the virtual function returns something, Godot will error out.
func _do_check() -> int: #illegal
pass
So it's not something that can be relied upon, unless we make the base virtual function not have a return type until it's overriden in an extended class. We could explicitly tag a function as virtual in the docstring?
from gdscript-docs-maker.
Related Issues (20)
- Add ability to ignore any property based on metadata
- It doesn't work as it should HOT 2
- build_re_pattern is missing
- Script did not work, lots of errors HOT 1
- Can't get it to work without modifying ReferenceCollectorCLI.gd HOT 3
- Support godot <3.1 HOT 7
- Support for nested lists in markdown HOT 1
- Links to Extensions which are core Godot classes, should link to the official documentation HOT 1
- const documentation is not being produced consitently.
- index is being generated blank HOT 3
- Broken `pip install gdscript_docs_maker`? HOT 1
- generate_reference not filtering directories. HOT 1
- generate-reference.bat fails when folder paths contains whitespaces HOT 4
- Display errors of scripts in terminal
- Replicate folder structure option for generate-ref script
- Support for license boilerplate text HOT 5
- Exclude warning ignore comments HOT 2
- Running gdscript_docs_maker.__main__ on reference.json
- KeyError: 'name' while generating markdown files HOT 4
- Dockerfile: The file /game/reference.json was not found HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from gdscript-docs-maker.