Project documentation generation

Question

Project documentation generation

Closed this issue 7 years ago · 5 comments

I was looking for a way to include code in the project documentation without the need to update it so I created a small script that allows you to import files into markdown using #import "path/to/file". I added a pre-commit hook to generate the markdown file and a link to gitprint to create a pdf.

Just thought it might be usefull to you considering the amount of code you will have!

Answer 1 · 2017-04-03T16:39:32.000Z

Thanks. I might add imports for methods.

What are you using for markdown editing?

Answer 2 · 2017-04-03T16:47:02.000Z

Just vscode.

Are you planning to document each method separately then?

Answer 3 · 2017-04-03T16:56:45.000Z

No, but some classes (e.g. networking or utilities) don't make much sense to document all at once as they are used project wide and aren't dependent on anything else.

Answer 4 · 2017-04-03T17:13:10.000Z

That makes sense, shouldn't be to hard to do.

Answer 5 · 2017-04-03T19:19:27.000Z

I added filetypes for highlighting.
https://gist.github.com/tpb1908/2e5b2eb2be50cdc95ed258d1dcad2b00

Functions are now hacked on. They work so long as you make sure to specify the full name, and you don't happen to have any strings containing '{' or '}'.
Doesn't work for abstract methods or interfaces.