Euphy

Source Documentation

Recommended Posts

Topic: http://www.eathena.ws/board/index.php?showtopic=228775

Raw: http://svn.xp-dev.com/svn/tecnocronus_scripts/docs/EN/source_documentation.txt

I stumbled upon this a while back. What do you think? Is this worth revising and adding into the SVN?

Edit: Cleaned up the file. It needs more technical terminology and some restructuring; if anyone with good knowledge of C would like to take over, go ahead.

source_doc.txt

  • Upvote 5

Share this post


Link to post
Share on other sites

Topic: http://www.eathena.w...howtopic=228775

Raw: http://svn.xp-dev.co...cumentation.txt

I stumbled upon this a while back. What do you think? Is this worth revising and adding into the SVN?

I think it's relevant enough because if you think about it, it's similar to script_commands in our documentation folder teaching some attributes ( a lot I must say) regarding scripting. Although this doesn't necessarily give a whole in-depth and a lot of functions about source, I think it's still good for people to understand the structuring of the source.

  • Upvote 2

Share this post


Link to post
Share on other sites

I think it would be a nice addition, at least give newer people a gentle push into making sorce mods. But I don't think it needs to be quite as long as the script_command.txt

  • Upvote 1

Share this post


Link to post
Share on other sites

Maybe the first half of that file can go in the SVN (or on the wiki?), but the 2nd half (descriptions of each source function), I think it'd be better to keep those in comments above each function.

  • Upvote 1

Share this post


Link to post
Share on other sites

I agree with Brian. I would add it to the wiki and put the reasonable descriptions inside the code above the function. Maybe even in a format so that the programming environment can parse and show the function/structure description(if we decide to do it that way, we should decide on a environment or find a tool like cmake for comments inside the source code, if that is even possible).

  • Upvote 1

Share this post


Link to post
Share on other sites

About comments above functions... Doxygen? :)

  • Upvote 2

Share this post


Link to post
Share on other sites

yes doxygen but we need to reparse each function and add a comment on what it's purpose.

also texte are nice but I'd really love some UML schema, modele and sequence, especially sequence since we more or less know the modele already.
That would be a huge plus in our organisation to know where to put this or this handle..

  • Upvote 2

Share this post


Link to post
Share on other sites

+1 to this, i've been long playing with the emulator for years but din't bother on source (except porting/ patching diffs on my copy) coz of my lack of knowledge on source since i don't really understand the functions on it and been long wanting to know and have knowledge about it but i can't find any documentations on source editing, i really am glad when i saw this topic, this would help the community gain knowledge and encourage us on source editing. thanks for opening this topic master Euphy... more devs to come ^_^

Share this post


Link to post
Share on other sites

lol that`s the documentation I started in 2009 I guess, I can help too.

 

I was "ouside RO world" a long time, but now I`m coming back, I need study the source codes again, I don`t know what changed wich the Renewal yet.

  • Upvote 2

Share this post


Link to post
Share on other sites

=) hi TechnoChronus, well we liked your doc but it was quite incomplete and more script_src oriented, so we,ve been working on it.

I should be added on repo soon enough but you could review it and maybe add some :

http://rathena.org/board/pastebin/v4exv6yzd6/

 

NB : This is not a final version

  • Upvote 1

Share this post


Link to post
Share on other sites

yes, I was reading this doc, it`s more complete. We need to completely document the source code. I`ll be working in a new documentation, merging these two docs, and adding more content.

  • Upvote 1

Share this post


Link to post
Share on other sites

yes, I was reading this doc, it`s more complete. We need to completely document the source code. I`ll be working in a new documentation, merging these two docs, and adding more content.

 

=) hi TechnoChronus, well we liked your doc but it was quite incomplete and more script_src oriented, so we,ve been working on it.

I should be added on repo soon enough but you could review it and maybe add some :

http://rathena.org/board/pastebin/v4exv6yzd6/

 

NB : This is not a final version

 

This would be of great help to future developers who want to dig in more to rA source. Thank you very much for the hardwork.. Cheers! /no1

Share this post


Link to post
Share on other sites

Added the first draft of this in 1d77a9f. Thanks to everyone that was involved.

@TecnoCronus: when you're finished with your changes, please submit a pull request!

  • Upvote 1

Share this post


Link to post
Share on other sites