DDoc documentation in code

[Jebbs]

Not only will this let the code be very well documented(which is something I've wanted to do for a while), but it also allows us to build stand alone documentation symilar to how SFML uses Doxygen for its documentation.

I'll probably wait until after the new C code base is finished before jumping into this, and will try to work on this at the same time as #20.

[nikibobi]

I think that after the code is documented it is a good idea to use bootDoc and use gh-pages for hosting the generated site(#26). The owner made a demo for phobos

[Jebbs]

Great idea!

It looks like bootDoc has some trouble with linking to the right page with some of the links though. (Links in the tree work, links on pages are broken).

Can't DDoc export directly to html though?

[nikibobi]

I had an idea about the documentation. So after the code separation( #4 ) is done and start working on the docs, you could add a README.md file to each 'module' folder. So 5 different .md files for system,window,graphics,audio and network. And each file will contain documentation for that module. And Github automatically displays any README files that are in the current directory(not just the one in the root dir). That way the documentation will be in a easily-accessable place(no need for gh-pages branch or any website, just markdown).

The only problem is that I don't know if DDoc or bootDoc or Doxygen have a markdown export option(I will try to search for it now).

[Jebbs]

Maybe something like this would work, but for something like the graphics module, that's a lot of documentation for a single file. I really like how SFML's documentation is on that website, so I'd like to do something similar if possible.

Very similar to how Dgame's doc is set up.

[Jebbs]

@pataroose, have you done any more DDoc stuff?

I'm not expecting you to have, I was just making a list of easy issues that I could bang out over the weekend and this was one of them. I wanted to make sure I didn't do any work that you might have already done.

[patrickjm]

I'm afraid not, it seems I don't quite have the time for it that I did before. i'm sorry about that.

[Jebbs]

No worries!

Like I said, I just wanted to make sure I wasn't duplicating work.

[Jebbs]

It might be a little bit inconsistent, since two people worked on it, but there now exists DDoc documentation for each module.

I still need to add some more to the ones I worked on, but at least something exists.

[Jebbs]

Gonna close this as documentation for each module is largely complete.

It needs a few things still, but I can save that for 2.2 updates.