Doxyfying the Python code?

This is the location for all mods to collaborate. Anyone making or planning their own mod should post help requests, screen shots and news here.

Moderators: tillias, Omega, Mod Contributor

Doxyfying the Python code?

Postby Sindwiller » Tue Oct 14, 2008 7:04 am

Has anybody tried to document the code using Doxygen? I ran over it and I noticed a lot of stuff that I can't figure out or doesn't make sense. At least 80% of the code is undocumented, so neither has a doc strings or comments, there is basically no folder structure at all (seriously...) and even with the existing documentation I can't get to run a simple script to spawn a bunch of enemies in a system! - so a Doxygen documentation might just be the best way to start.

Discuss. :P
User avatar
Sindwiller
Merchant
Merchant
 
Posts: 32
Topics: 3
Joined: Sun Aug 10, 2008 3:31 pm
Location: Zürich, Switzerland

Share On:

Share on Facebook Facebook Share on Twitter Twitter Share on Digg Digg

Re: Doxyfying the Python code?

Postby loki1950 » Tue Oct 14, 2008 7:42 am

About time :wink: yes we really do need to nail down the API for all the Python scripts data side.

Enjoy the Choice :)
my box::HP Envy i5-6400 @2Q70GHzx4 8 Gb ram/1 Tb(Win10 64)/3 Tb Mint 19.2/GTX745 4Gb acer S243HL K222HQL
Q8200/Asus P5QDLX/8 Gb ram/WD 2Tb 2-500 G HD/GF GT640 2Gb Mint 17.3 64 bit Win 10 32 bit acer and Lenovo ideapad 320-15ARB Win 10/Mint 19.2
User avatar
loki1950
The Shepherd
 
Posts: 5753
Topics: 52
Joined: Fri May 13, 2005 1:37 pm
Location: Ottawa


Re: Doxyfying the Python code?

Postby Fendorin » Tue Oct 14, 2008 11:55 am

Sindwiller!!! i Support you it's nice work you begun you will help us a lot

nice to heard a good working's bell
User avatar
Fendorin
Elite Venturer
Elite Venturer
 
Posts: 725
Topics: 57
Joined: Mon Feb 26, 2007 11:01 am
Location: France, Paris

Re: Doxyfying the Python code?

Postby Sindwiller » Tue Oct 14, 2008 4:31 pm

Whoooow... hold your horses people :| I'm not really capable of doing that - especially alone, as I have only minimal programming knowledge (I know some Python though) and my brain just isn't suited for that kind of stuff :P I'd really like to help, but it's not going to happen that fast :P I'd probably need some clues and help and stuff :)
User avatar
Sindwiller
Merchant
Merchant
 
Posts: 32
Topics: 3
Joined: Sun Aug 10, 2008 3:31 pm
Location: Zürich, Switzerland

Re: Doxyfying the Python code?

Postby chuck_starchaser » Wed Oct 15, 2008 6:55 pm

Just take it one file at a time :D
Seriously; you'd be a star if you did this. A while ago I tried to add a sub-menu to the main menu in PU for a multi-player screen.
Should be piece of cake, right? Spent several days on it and never got it to work.

EDIT:
Here's a link to keep handy: C++ functions available to Python.
User avatar
chuck_starchaser
Elite
Elite
 
Posts: 8014
Topics: 195
Joined: Thu Sep 04, 2003 9:03 pm
Location: Montreal

Re: Doxyfying the Python code?

Postby legine » Sun Feb 08, 2009 3:40 pm

Well I dont think Documentation will do the trick.
I think some parts are write like Spagetti. You find a lot of (import) references in the beginning, some classes in the same file, some free, global code in between. and then When time was short some ugly code like:
Code: Select all
if compare(a, b) then do()
(and do ofcourse is imortet have fun searching...)

just clean up the code and there will be only a view things needing documentation.

Sorry for blabber but it makes me upset how some code just looks like. It is very hard to understand.(That does not mean I think the work is bad.)


My 2 cents.
legine
Bounty Hunter
Bounty Hunter
 
Posts: 139
Topics: 19
Joined: Mon Sep 27, 2004 1:40 am
Location: Germany

Re: Doxyfying the Python code?

Postby Sindwiller » Wed Feb 11, 2009 4:17 am

Well, the point is, nobody knows how large parts of the code work, anyway...
User avatar
Sindwiller
Merchant
Merchant
 
Posts: 32
Topics: 3
Joined: Sun Aug 10, 2008 3:31 pm
Location: Zürich, Switzerland

Re: Doxyfying the Python code?

Postby legine » Fri Feb 20, 2009 7:13 pm

Sindwiller wrote:Well, the point is, nobody knows how large parts of the code work, anyway...

*sing*Noobody knows, the trouble I've seen... *sing*
Hmmm at least I am not alone :)

I think we should think more on APIs we need and want and then write that down. After, we write wrapper classes with the new API, and then start to replace existing code to call the new wrapper class instead, and in last step replace the wrapper class with a real class, write a bit of wiki, then take the next api piece.

With a good plan we can put people with different codeing experience to work. ahhh dono. Too much spagetti^^
legine
Bounty Hunter
Bounty Hunter
 
Posts: 139
Topics: 19
Joined: Mon Sep 27, 2004 1:40 am
Location: Germany

Re: Doxyfying the Python code?

Postby ace123 » Mon Feb 23, 2009 3:53 am

If you run into some python function that makes no sense, or if you need an API for something that you can't figure out how to do, maybe we need a place on the wiki or forums that you can ask those.

I haven't been visiting the forums more than about once a week lately--but feel free to email me at patrick.horn at gmail.com if you have a question
ace123
Lead Network Developer
Lead Network Developer
 
Posts: 2560
Topics: 32
Joined: Sun Jan 12, 2003 2:13 am
Location: Palo Alto CA



Return to General Modding

Who is online

Users browsing this forum: No registered users and 2 guests

cron