ArcEmu: Documentation, Uml And Whatnot - ArcEmu

Jump to content

Toggle shoutbox Lastest Announcements

dfighter  : (07 December 2014 - 12:06 PM) Arcemu is in hibernation mode, please read
dfighter  : (01 January 2013 - 05:56 PM) Arcemu wishes you all a happy new year!
Hasbro  : (12 September 2012 - 10:01 AM) Please excuse our outage from the web! Our web host had a major malfunction!
dfighter  : (01 September 2012 - 04:05 PM) Since the spam bots just don't want to stop, I've enabled admin verification when registering.
dfighter  : (23 January 2012 - 09:56 PM) Please note that from now on you will need to confirm your email on the wiki in order to edit it!
Hasbro  : (31 December 2011 - 12:50 PM) Happy New Years all!
Navid  : (26 December 2011 - 04:09 AM) Merry Christmas !!!!!! Happy holidays all :)
WAmadeus  : (24 December 2011 - 03:54 PM) Merry Christmas to all!
dfighter  : (24 December 2011 - 11:05 AM) The Arcemu team wishes y'all a Merry Christmukkah!
Hasbro  : (05 October 2011 - 12:53 PM) Looking for web designers for upcoming web related project. If you're interested in designing user interfaces contact me
dfighter  : (02 September 2011 - 03:47 PM) So who here wants vehicles in Arcemu? :P
Hasbro  : (14 August 2011 - 03:25 PM) Join us on irc, grab an irc client and connect to join channel #arcemu /server /join #arcemu
jackpoz  : (03 August 2011 - 05:33 AM) to all Lua Engine (old one) users: please check
Hasbro  : (20 May 2011 - 05:27 PM) Looking for people experienced with CMake configuration and setup! Contact me asap
Hasbro  : (15 May 2011 - 05:03 PM) ArcEmu is recruiting C++ programmers, contact Hasbro if interested.
paroxysm  : (03 May 2011 - 06:26 PM) Updated luabridge gossip example to describe the whole gossip creation process rather than just how to create menu. Gossip tutorial
paroxysm  : (23 April 2011 - 11:35 AM) Lua writers can refer to the Luabridge Tutorials section in the Wiki to learn how to write gossip code correctly.
Hasbro  : (20 April 2011 - 05:22 PM) Thank you for your continuous contribution of bug reports, we are working on them.
Hasbro  : (17 April 2011 - 03:20 AM) Please consider donating to support our bills. Donations can be sent using PayPal to - Thank you for your support.
paroxysm  : (10 April 2011 - 12:43 AM) Refer to the Luabridge Tutorials section in the Wiki to learn the new syntax of luabridge.
Resize Shouts Area

Page 1 of 1
  • You cannot start a new topic
  • You cannot reply to this topic

Documentation, Uml And Whatnot

#1 User is offline   dfighter 

  • Titles are overrated
  • PipPipPipPipPipPipPipPipPipPip
  • Group: Administrator
  • Posts: 5,189
  • Joined: 14-June 08
  • IRC:dfighter
  • Gender:Male
  • Server OS:Linux

Posted 21 September 2010 - 12:17 PM

Hi there!

As you can all see I've started committing UML class diagrams for new classes to both Trunk and my own branch.

These .uml files are basically XML files describing the diagrams.

Class diagrams are simple documentation tools for these classes, they provide a quick way to overview the interface those classes provide.
You can open these committed files with ArgoUML, a nice cross-platform java based UML modeler tool.
Altough it is open source I mirrored it on our website for easy access to anyone who wants to use it (and it's recommended to be used).

Here's a screenshot of ArgoUML showing the diagram for the atomic classes I made:
Posted Image

Why is this all good for us? Because with proper and throughout documentation, we can decrease the learning curve for new possible developers who might join the project,
and we desperately need more (good) developers!

Also if you look into the new classes I commited (AtomicULong, AtomicCounter, AtomicBoolean, AtomicFloat ) you can see in the headers that I commented them quite thoroughly.

This documentation method from now on is both REQUIRED and PREFERRED.

There are at least 3 advantages of this documentation method:
1.) A developer can just take a look at the header and oversee the interface (which is well commented) and can just use the classes without having to read the implementation code.
2.) We can generate complete reference documentation with Doxygen if the code is well commented. ( Going to do that later today )
3.) Most open source projects ( especially here in the "wow scene" ) are terribly or NOT at all documented, this could be one of our comparative advantages that could attract new developers.
4.) Visual Studio parses these comments and Intellisense shows the comments when you browse the context sensitive menu.

Illustration for 4.)
Posted Image
"The demand for free goods is infinite."

Share this topic:

Page 1 of 1
  • You cannot start a new topic
  • You cannot reply to this topic

1 User(s) are reading this topic
0 members, 1 guests, 0 anonymous users