Adding -only-exported, -respect-private, & -source-code-locations:<string> flags to odin doc
#5570
blob1807
started this conversation in
Ideas/Requests
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
Uh oh!
There was an error while loading. Please reload this page.
-
Adding three flags to
odin doc;-source-code-locations:<string>, the same as frombuild&run;-respect-private, don't output any thing marked as private; and-only-exported, only output symbols that have been exported, and their type dependences.None of these flags are to be mutually exclusive with themselves or existing one.
Whilst the last two are really superfluous additions, as both states are already recorded. It would be a QofL addition for documentation and binding generation. When/where don't always need or want everything to be emitted. Will also greatly minimize the file size.
All these flags would make it better for providing a
.odin-docfile along side the binary. Whether for giving users a way to make their own documentation or automating bindings.These would also have the effect of making a
.odin-docact like a language agnostic.h.I've yet to come to a conclusion as to whether that's a good idea or not. Some other opinions on that would be much appreciated.
Beta Was this translation helpful? Give feedback.
All reactions