Official documentation

[gordonramp]

Aggror will probably be hired to write most of this, if he wants to.

 

Good call, go for it Aggror.

[paramecij]

My issues with the current documentation are: (in order of importance)

 

1. lack of descriptions and/or examples in some places
2. not up-to-date
3. more guidelines for creation & optimization (octree, LOD, vegetation, shaders... )
4. it should be included in the SDK for offline access !!!!
5. even more guidelines, facts, numbers and info ( so one doesn't have to search the forums to find that the current and future versions of engine use newton 2.20 for example  )
.
.
.
99. the design

 

So I'm happy that the documentation is getting some attention (hopefully some of my issues will be addressed) plus it looks better which is always good

[Josh]

This is what I was describing.

 

C documentation:

http://leadwerks.com/werkspace/index.php?/page/databases/docs?record=1〈=c

 

C++ documentation:

http://leadwerks.com/werkspace/index.php?/page/databases/docs?record=1〈=cpp

 

Lua documentation:

http://leadwerks.com/werkspace/index.php?/page/databases/docs?record=1〈=lua

 

 

I'd like to have icons that clearly show what language you are looking at but I am having trouble finding a C icon.

[Cornell Cook]

Ahh no good pics of Cheeseburgers to go along with the C is for Cat. ^.^

[Pancakes]

lol who posted that pic of a cat? Annika or Josh?

 

wellz anyways...make sure you actually have examples Josh that's super important for people like me I think Arrrrrgh ^^

 

Oh but if Aggror's the one doing it there will be no problems the examples will be excellent

[Josh]

If C# syntax were included, would it need to look any different from regular C? Is there any compelling reason to add a dropdown box for C# syntax?

[Canardia]

C# has nothing to do with C or C++, it's a completely different language. It's more like Visual Basic.NET actually, although it has some elements from C++, mostly then when it's not using any libraries. But when you use system libraries, you can't tell always if it's VB.NET or C#.

Well, it's a mix of C, C++, VB.NET, but not compatible with any of them directly.

[Guest Red Ocktober]

lookin' good...

 

but...

 

i still don't see no BlitzMAX drop down...

 

and yes... C# is not c++ by any means...

 

 

--Mike

[Josh]

I know but if you know the C syntax, you know the BMX and C# syntax, right? Is there any significant way they are different?

[Rick]

From my understanding the C# implementation of LE is slightly different than anything else. It would be more like LEO, but I think it's even different than that.

[Canardia]

I think it's not even possible in C# to do procedural programming, since everything needs to be in a class. So it's also a bit like the Eiffel programming language. Of course you could put all LE commands into one huge class, but that might cause also problems if a class is too big, and it doesn't really bring any benefit either. So I think the C# headers should be like the LEO headers, since everyone who uses C# wants to use OOP too.

[ZioRed]

AAAAAAAAArgh.. procedural programming, what a bad thing to me

 

Luckily it doesn't exist in C#, it's full OOP and use namespaces and classes. The usage syntax and function names and namespace and almost all the code from C# wrapper is completely different from any other language here, both C/C++ and LEO (some similarity here) and BMax and Lua.

 

It needs its own placeholder in the dropdown list if you wish to support it, I can help in writing the C# syntax documentation and examples. I'm also planning to add summary comments in the wrapper itself for all the functions and constructors so that we can use something like Doxygen to automatically create CHM and HTML help files.

[Xaron]

Actually I would love to see some kind of offline documentation as I'm traveling frequently and the wiki is not very useful in that case. Yes I just could mirror it from time to time but that is not very optimal.

[AggrorJorn]

What Xaron suggests is not a bad idea. This has been requested before. Josh is there a way to download the 3 documentation databases to the desktop with a possibility to sync?

[Canardia]

If it was a Domino database, you could just make a local replica of it. But I think it's made with MySQL, so it's bit more difficult.

[Joh]

I have a suggestion could you let it downloadable?

[AggrorJorn]

Which database does the forum use?

[Rick]

I'm a fan of this structure, but it might be more useful for 3.0 if it ends up being object oriented.

 

http://www.truevision3d.com/tvdna/

[AggrorJorn]

@ Rick, On one hand you are right. A simple low graphical cost system like truevision has benefits. It takes lesser space, quicker navigation, better overview.

However in the world of today where visuals are becoming more important. personally I am okay with this but there will be many people who will complain that this style is to 'old looking'. Ofcourse many programs still use this kind of help system.

 

If this documentation style can be mixed with easily swapping of several languages and a little more(slightly improved)graphics. Plus, I think this style is easier for offline documentation.

[Josh]

I like the treeview too for command reference, but it's impossible for frames to work right without filling up the entire page. I wanted to make a treeview table of contents on the left, and the page contents on the right, and have it embedded within the page template, but apparently that is impossible.

[TylerH]

I could definitely dedicate some time to proper C# documentation, both for the straight C# API, as well as for the full wrapper that now exists.

[Josh]

Can you type what C# syntax documentation would look like for PositionEntity(), in this thread? That's what I am getting at.

[TylerH]

Yes, I will in a minute. I am away at a university so I have to TeamView into my developer PC.

[ZioRed]

Can you type what C# syntax documentation would look like for PositionEntity(), in this thread? That's what I am getting at.

 

OOP syntax:

Entity myEntity = new Entity();
myEntity.Position = new Vector3(1.5f, 2f, 4.5f);
myEntity.GlobalPosition = new Vector3(1.5f, 2f, 4.5f);

 

Core API syntax:

Core.PositionEntity(IntPtr entity, float[] position, int global);

[macklebee]

OOP syntax:

Entity myEntity = new Entity();
myEntity.Position = new Vector3(1.5f, 2f, 4.5f);

 

how do you differ between global and local coordinates?