Documentation generator for C++
theangryepicbanana (1601)

This is a program that generates doc comments for C++ code! I originally made this for my CS class since we have to include documentation for functions we make. It's not 100% perfect, but it definitely helps save a lot of time.

Also if you're wondering, I made this program in Raku (aka Perl 6).

1) Paste your C++ code into in.txt.
2) Run the program.
3) Copy the code in out.txt (which is the output).

If you have any suggestions (minus cleaning up my code because I know it's ugly/messy), just let me know down in the comments.

Update 1:

  • Compound numeric types are now supported.

Update 2:

  • Templates are now supported.
  • Destructors are now supported.
  • Operator overloads are now supported.
  • Fixed a bug.
You are viewing a single comment. View All
StudentFires (327)

@theangryepicbanana Well, they're functions anyways. I'm always explicit in their return types using -> type, so that could be documented. But this documenter needs to really understand the C++ that it's documenting. It was funny seeing your documenter say "return type {signed}" because I left off the int, as it is automatically an int.

But hey you seem to know quite a few coding/scripting languages, you don't happen to know Bash by any chance, do you?