SDL Man-page Generation?


#1

Hey, I’m new to the community but in the past several weeks I take time to study SDL2, and have worked on SDL2’s man page (not complete yet) by hands (for learning purpose firstly mirroring documentations from official one online).

I just want to ask 2 questions

  • there a way to generate man page from SDL2 source?
  • whether SDL 2 source include comments which has format applicable to be generated via any doc tools?

Thank you!


#2
  • there a way to generate man page from SDL2 source?

No.

  • whether SDL 2 source include comments which has format applicable
    to be generated via any doc tools?

Yes, doxygen. Doxygen can also generate XML which is very suitable for
being processed further, e.g. by Python. I use this approach to
auto-generate Go language bindings with comments. You can see the
result here:

If you are looking for a worthwhile project involving documentation,
updating the Wiki is probably the #1 item.

MSB


#3

Thank you so much for quick reply. Interesting to know the workflow for Go binding as well.
I will continue to finish that man page (of course as part of learning process).


#4

Update back:
I finished this project, check it out at https://github.com/haxpor/sdl2-manpage