World Wind Forums

Go Back   World Wind Forums > WorldWind .Net Development > Developers' Corner

Developers' Corner General World Wind development.

Reply
 
Thread Tools Display Modes
Old 03-28-2007, 10:01 PM   #1
ghchinoy
Junior Member
 
Join Date: Jan 2006
Location: Colorado, USA
Posts: 18
Default source code documentation party!

I'm forever trying to get into the code to mess around, but I'd like some documentation to help me along so I don't have to bother the forums or the irc channel, so I'd like to propose a source-code documentation party!

Going through the source, if people could document the public methods, it'd not only help noobs like myself, but also help with producing automated MSDN docs (sandcastle, etc).

What do people think?
ghchinoy is offline   Reply With Quote
Old 03-28-2007, 11:03 PM   #2
withak
What?
 
withak's Avatar
 
Join Date: Apr 2005
Location: San Francisco, California
Posts: 2,464
Default

It might be helpful to run one of the automatic doc tools on the source first to see what is missing (or what is missing the most). Then those of us who have already untangled something that is undocumented can try to fill in the blanks.
withak is offline   Reply With Quote
Old 03-29-2007, 03:52 AM   #3
solo_lxy
Junior Member
 
Join Date: Mar 2007
Posts: 1
Default

That is a good idea,i think!
solo_lxy is offline   Reply With Quote
Old 04-10-2007, 07:44 PM   #4
ghchinoy
Junior Member
 
Join Date: Jan 2006
Location: Colorado, USA
Posts: 18
Default

Quote:
Originally Posted by withak View Post
It might be helpful to run one of the automatic doc tools on the source first to see what is missing (or what is missing the most). Then those of us who have already untangled something that is undocumented can try to fill in the blanks.
first pass run of doxygen on the current svn revision (3763) is available. more to come as i get orcas/sandcastle up.

- h
ghchinoy is offline   Reply With Quote
Old 04-10-2007, 07:54 PM   #5
withak
What?
 
withak's Avatar
 
Join Date: Apr 2005
Location: San Francisco, California
Posts: 2,464
Default

So does "Summary description of X" count as documentation?
withak is offline   Reply With Quote
Old 04-10-2007, 08:18 PM   #6
ghchinoy
Junior Member
 
Join Date: Jan 2006
Location: Colorado, USA
Posts: 18
Default

Quote:
Originally Posted by withak View Post
So does "Summary description of X" count as documentation?
welcome to the party, my friend
ghchinoy is offline   Reply With Quote
Old 04-12-2007, 05:16 AM   #7
5of0
Dabbling Geek
 
5of0's Avatar
 
Join Date: Jan 2005
Location: Washington State, USA
Posts: 1,624
Default

/me is willing to elaborate on any installer doc needed, I've got a pretty good understanding of it now
__________________
Note: The above statement is probably an educated guess, derived from much forum reading, IRC chatting, general curiosity, etc. Use at your own risk.
Before asking, check the FAQ or search, and Ask a good question.

Having problems? Make sure you have Managed DirectX and .NET Framework.
Then check the Video Card Compatibility List


5of0 is offline   Reply With Quote
Old 08-04-2007, 02:35 AM   #8
care
Junior Member
 
Join Date: Jul 2007
Posts: 10
Default How to join in??

Quote:
Originally Posted by ghchinoy View Post
I'm forever trying to get into the code to mess around, but I'd like some documentation to help me along so I don't have to bother the forums or the irc channel, so I'd like to propose a source-code documentation party!

Going through the source, if people could document the public methods, it'd not only help noobs like myself, but also help with producing automated MSDN docs (sandcastle, etc).

What do people think?
Who organise the party??
If the party exist, how can I join in??
care is offline   Reply With Quote
Old 10-21-2008, 10:10 AM   #9
huch85@126.com
Junior Member
 
Join Date: Oct 2008
Posts: 1
Default

Good idea,but i need first a good understanding of the source code.
huch85@126.com is offline   Reply With Quote
Reply


Currently Active Users Viewing This Thread: 1 (0 members and 1 guests)
 
Thread Tools
Display Modes

Posting Rules
You may post new threads
You may post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off
Forum Jump

Similar Threads
Thread Thread Starter Forum Replies Last Post
World Wind Source Code Documentation Janine Developers' Corner 2 01-07-2009 06:05 PM
Source Code Documentation Unregistered Developers' Corner 10 08-03-2007 08:51 AM
Source code Unregistered Developers' Corner 3 11-20-2006 05:54 PM
source code documentation murrai Developers' Corner 1 03-14-2005 01:07 PM
Can't connect to servers hroo772 Technical Support 11 02-12-2005 02:19 AM


All times are GMT +1. The time now is 04:33 PM.


Powered by vBulletin® Version 3.7.1
Copyright ©2000 - 2010, Jelsoft Enterprises Ltd.