Engine Docs

[RonHiler]

The engine docs can be found here:

http://www.rjcyberware.com/Enzyme/EngineDocs

These are updated on a pretty regular basis, so please let me know if you find something that is confusing, wrong, or missing.

[RonHiler]

Okay guys, the current set of docs were uploaded this morning. Let me know if they are not clear enough. I'm especially worried that the MemoryManager::WriteBlock and ::ReadBlock routines are going to seem overwhelming.

[RonHiler]

Well guys, I was going to update the docs this morning (since we now have arrays done and some string functions in since the last update). But when I tried to run the auto-doc program it froze. Something about the operator functions in the string class is giving it fits, even though nothing about those docs are different from other systems with operator overloads in them.

Anyway, I'll track it down and fix it. Plus, I have to make some small modifications to the documenter in any event (have to add the wchar_t as a keyword, and it's not handling constructors documentation right when there is more than one constructor. Minor stuff).

So I'll update the docs as soon as I track down that small problem. Shouldn't take long, I just have to find the time to dig into it.

[RonHiler]

Okay, newest engine docs are up.

[EDIT: RE - nowrap. Nevermind, I got it. The "operator" sections will be much better the next time I upload new docs]

[Pix]

Shouldn't take long.

Always funny, Manny.

[RonHiler]

Newest docs are up. This one includes all the latest string fuctions.

[RonHiler]

I just realized I never uploaded the latest docs for the engine. Since I finished the String class, it should have already gone up. You guys ARE allowed to yell at me if I forget to update the docs after a major subsystem goes in, heh.

As the renderer is mostly internal, there won't be much in the way of new docs for a bit. The only interface functions will be through the GraphicsManager class, and right now that is pretty anemic. But I will keep you guys posted, as always, in the coding section on what is going on.

[RonHiler]

Hey guys,

I just found out, quite by accident, that the engine API docs were not working right under Firefox. This is why you should always test web pages under more than one browser, heh. So instead of working on the renderers this morning, I've been fixing that. Not really what I wanted to be doing, but it's an important system.

I've got it mostly fixed now, except Firefox is not picking up the css file on any page other than the Table of Contents. I'll track that one down right now, so the docs may go down intermittently over the next hour or so as I make changes to the system.

If you guys see any issues with the docs (like for instance, the entire set of links is not working), please let me know. I had no idea they were broken under some browsers. I know not many people are using them right now (obviously, since the engine is not yet out there), but if you just happen to be browsing them and see something strange, don't assume I know about it, let me know.

[Edit: Okay, the pages are now fixed. The only diff between IE and Firefox now is that the latter is not picking up the spacer at the top of the page, so the top logo/bar are jammed right up against the top of the page. I think that's a css problem, though, rather than a page code issue. I'll look at it later on when I go to do the next set of doc updates. Right now I want to get back to the rendering code.]