Source code documentation

[TomDavidson]

I have generated the L2JServer class documentation from the source code so I thought I'd share it all with you. I have it automatically updating when I do a rebuild form the source so it should stay relatively up to date.

API docs

If we were to follow some coding standards and include mandatory doc-block style comments at the top of each class and method it would make this much more useful. They don't take much time to write when you create or change a method so it's well worth it for the time you save trying to figure out how a functions works.

[Flashy]

great Job!

tihis helps many new "coder", to learn something about the l2j sturcture..

[JIV]

amazing work, THX!

[shinomidefuego]

thnk!!! great job

[ThePhoenixBird]

Excellent work!

This thread deserve a sticky!

[jurchiks]

Generating with javadoc doesn't really require much of anything...
It is nice of course, but the problem is that l2j code documentation is terrible. There are only few classes that have complete and proper javadoc-style comments, most either have no documentation at all, except @author and, possibly, @version, or have very poor documentation.
Also it would be very hard to write the proper docs for all of them as reading through all those classes/methods just makes you see how badly written l2j actually is. I tried once, and I couldn't stop myself from rewriting most of what I read (I didn't read much though, it's just that much of a thorn in the eye).

[TomDavidson]

No, it wasn't that tricky to get javadoc working on th source, it's now part of my build script. In fact I posted it here because I was so surprised that nobody had done it before. It's quite sparse in some places about what a function actually does though it's much easier to skim to find the function you want than the source.

My suggestion of adopting some commenting standards was to help improve this automatically generated docs to the point where it can be really useful to newcomers as well as people more familiar with the source.

I'll try and keep it up to date by rebuilding fairly frequently.

[Forsaiken]

i could never really do smth with this docs in l2j since eclipse is showing the comments atomatically.
Also i belive that code that was hard to write should be hard to read

[jurchiks]

Surely it wasn't THAT hard to write...

[siulx]

any advice from where should I start to understand how the server works ?

My goal its to make a console application, and put it to talk with the server.

[delix]

I have generated the L2JServer class documentation from the source code so I thought I'd share it all with you. I have it automatically updating when I do a rebuild form the source so it should stay relatively up to date.

API docs

If we were to follow some coding standards and include mandatory doc-block style comments at the top of each class and method it would make this much more useful. They don't take much time to write when you create or change a method so it's well worth it for the time you save trying to figure out how a functions works.

This is really Great job TomDavidson !!!
Especially for novices like me
Just keep doing in this way!

any advice from where should I start to understand how the server works ?
My goal its to make a console application, and put it to talk with the server.

I'm interesting in this too. Let us know where and what we need to start with?
Thx.

[Aardvaark]

Link Broken

[Sirpaypi]

Please re-upload.

[TomDavidson]

Apologies for the broken link, my L2 server died and it was hosted there.

I've rebuild them to pre-Hi5 and talking to people to get them up on here with the rest of the documentation. In the mean time I've uploaded them here: http://www.davidson.me.uk/dev/l2jserver/ and changed the link in my sig.