Comprehensive HTML Documentation

[james7132]

It would be helpful to have full documentation of the already commented parts of the framework, especially in HTML format, and document the currently undocumented areas.

There exist Doxygen plugins that can automatically generate HTML documentation pages from comments.

Likewise, it can be hosted for free using the repo's Github Pages.

If a gh-pages branch is created, I can go ahead and do this for you.

[vexe]

It will happen eventually. I just don't like to document things I change often cause then I'd have to remember to update my comments. Not a huge fan of comments as they're not compiled, so if there's an erroneous/misleading comment it will slip by. I try to write self-documented code as best as I can.

I was thinking of having one documentation file that covers usage, features, serialization rules, and go into details in certain areas.

Haven't heard of gh-pages before. What exactly am I supposed to do?

[james7132]

Create a branch named "gh-pages". Place a index.html in the root directory of that branch, and Github will host that all static web pages for you.

For example, my DanmakuUnity2D dev kit is hosted at http://james7132.github.io/DanmakuUnity2D/, which I've been using to host the documentation for it.

[colms]

I found this plugin that could make this quite easy: https://youtu.be/1TwXMYUZ-2w

Maybe a script could be made so that every time a new version of VFW is posted, the docs are updated and posted too.

[james7132]

It's also what I've been using and it works beautifully.

I also suggest creating a gh-pages branch, and pushing the generated HTML documentation there.

if done this main repo, it should automatically host it at http://vexe.github.io/vfw/. That way there's no need to pay for a domain name or web hosting for the documentation.

[colms]

Ah. I should've checked which plugin you originally linked to. My mistake for reposting!