Use gdnative-doc for documentation #107
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This adds a dependency on gdnative-doc to generate the documentation from the Rust code.
The actual content of the documentation (previously in
addons/dijkstra-map/DOCUMENTATION.md
, now inaddons/dijkstra-map/doc/index.md
andaddons/dijkstra-map/doc/DijkstraMap.md
) was slightly changed:Methods for constructing and modifying the graph
-Methods for recalculating the DijkstraMap
-etc...). To counter this, I tried to add more class-level explanation.Overall I think it looks very good, and I hope this will make for good and maintainable documentation 😁
P.S.: Maybe this will require some explanation so that contributors know they need to modify
lib.rs
to affect the documentation...