Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Build overview of missing functions, constants, and structs #10

Open
timo opened this issue Oct 5, 2018 · 4 comments
Open

Build overview of missing functions, constants, and structs #10

timo opened this issue Oct 5, 2018 · 4 comments
Labels
enhancement hacktoberfest good issue to start contributing, or contribute only one or two help wanted

Comments

@timo
Copy link
Owner

timo commented Oct 5, 2018

It'd be cool to do this in an automated way. Either pull functions from the sdl wiki, or pull it from sdl's hg repository (both on libsdl.net)

http://wiki.libsdl.org/CategoryAPI — this has all the symbols in it, i.e. functions, constants, structs. Would be necessary to differentiate them by type, but it could be a good starting point.
http://wiki.libsdl.org/APIByCategory — this is the page i use most often to figure stuff out, for example when i want to build an example or program, rather than just to add to the bindings
https://hg.libsdl.org/SDL/file/default — this lets you browse the files of SDL's mercurial ("hg") repo

@timo timo added enhancement help wanted hacktoberfest good issue to start contributing, or contribute only one or two labels Oct 5, 2018
@azawawi
Copy link
Contributor

azawawi commented Oct 6, 2018

First attempt is at https://github.com/azawawi/scripts/blob/master/read-sdl2-doc.p6. Greedy match is a todo so far. 😢 I also tried C::Parser but that did not work well. I am thinking to use this script to insert SDL2 documentation as pod6 and to compare and generate missing stuff.

@timo What do you think?

@timo
Copy link
Owner Author

timo commented Oct 6, 2018

i only glanced the output briefly so far, but it looks cool already. do you know if what gptrixie uses also gives us comments and such?

@azawawi
Copy link
Contributor

azawawi commented Oct 6, 2018

No idea really but looks like it does not support that.
https://github.com/Skarsnik/gptrixie/blob/master/lib/GPT/FileGenerator.pm6

@timo
Copy link
Owner Author

timo commented Oct 6, 2018

could castxml perhaps output comments? i don't really understand the structure of gptrixie's code 😕

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement hacktoberfest good issue to start contributing, or contribute only one or two help wanted
Projects
None yet
Development

No branches or pull requests

2 participants