DOxygen Manual

[Marcus]

I think that a DOxygen manual would really be nice. I would actually like it more than the wiki.

 

For those who don't know anything about DOxygen, see the following links:

 

DOxygen Official Site

 

DOxygen Wikipedia

 

It appears that there is also a way to make Lua syntax work with DOxygen:

 

DOxygen Lua

 

What makes DOxygen so nice, is we could generate HTML, PDF, CHM, and more. A CHM file that has an index and search functionality would be great for offline documentation.

[L B]

I hate the Doxygen syntax. I think the Wiki is the best source we have, although manually generated.

I'll plug the Wiki in my headers, so you'll have in-IDE support, which will be great. Dang, I wish I had some free time!

[Marcus]

The problem with the wiki is that it is out of date. I found several functions that were just flat out wrong. We need quality documentation or no documentation. Obviously, we would all prefer the former.

[carlb]

one of the problem you have is there two engine 2.28 and 2.3

which both how have diffrent syntax this is why some of wiki is wrong

 

the other problem with using DOxygen is making sure how you do you code has the information in it for it to work

i try using that in the past it killed how i program and increased my time so much to the point of hating to program

 

all i can say what we got is good but its a full time job keeping stuff like wiki up todate and Josh i think at the moment does not have the time for tthat but i could be wrong lol

[Marcus]

all i can say what we got is good but its a full time job keeping stuff like wiki up todate and Josh i think at the moment does not have the time for tthat but i could be wrong lol

 

Documentation should always be the top priority. That was one of the biggest complaints with Torque and GarbageGames paid for it.

[carlb]

I can say it easy to say that and harder to do

 

yes it should be a priority but some time you just want to program and get on with it

and not to worry about the doc till the end. but you are right it should be a priotry

which is why in a team there one man that does just that, when the other are getting on.

[wh1sp3r]

i don'T care about documentation, because LE is so easy, commands are intuitive !

 

yes, there should be proper documentation, but It's not a top priority.

[Rick]

Wh1sp3r you only think this way because you've been using LE for some time now and get how it works. When new people come on they have a hard time with it. Documentation is important. There is enough of it out there but some is outdated.

[wh1sp3r]

i agree Rick, of course

[AggrorJorn]

Documentation should always be the top priority. That was one of the biggest complaints with Torque and GarbageGames paid for it.

Totally agree on that.

 

But there is going to be an official documentation site for Leadwerks 2.3 soon. First of there is the Pages section which contains already some usefull information.

[L B]

Wh1sp3r you only think this way because you've been using LE for some time now and get how it works. When new people come on they have a hard time with it. Documentation is important. There is enough of it out there but some is outdated.

I'm sorry, but I started writing headers for another language after 1 week of using LE. I think the commands simply cannot be simpler.

And since it's the 10th of feb, I'm done with a lot of work, so I'll be able to plug in docs in my C# headers. I honestly think C# is the easiest way to start with Leadwerks. There is no need for compilation or any extensive knowledge, as the language is really straightforward. No scripts either, so you don't have to worry a lot about making a whole game exposed in a script. Last, you can even use the headers in VB if you feel like it, which is probably the most newbish language.

[Josh]

As mentioned, official documentation will come to be on the site, in addition to the wiki.