Libs & functions description

Ask anything your want about Megadrive/Genesis programming.

Moderator: BigEvilCorporation

Post Reply
Apocalypse
Newbie
Posts: 5
Joined: Mon Sep 07, 2015 2:09 am

Libs & functions description

Post by Apocalypse » Mon Sep 14, 2015 2:37 am

Hi all,
I'm new on the forum so sorry for my naïve question: where can I find a description of all libraries and functions included in Stef's SGDK.
I know I can open each .h file but it isn't a very efficient way of working.
If such a document doesn't exist I'm keen to do one (hoping it will help me knowing all libs by rote).

Also I didn't find a presentation topic on the forum.
Last edited by Apocalypse on Tue Sep 15, 2015 2:36 am, edited 1 time in total.

KanedaFr
Administrateur
Posts: 1139
Joined: Tue Aug 29, 2006 10:56 am
Contact:

Re: Libs & functions description

Post by KanedaFr » Mon Sep 14, 2015 8:59 pm

Hi ;)

Stef will answer but at some point, he added doxygen tags...
I don't know if he created a doc or not ....perhaps you should call doxygen on sgdk

djcouchycouch
Very interested
Posts: 710
Joined: Sat Feb 18, 2012 2:44 am

Re: Libs & functions description

Post by djcouchycouch » Mon Sep 14, 2015 11:34 pm

Apocalypse wrote:Pascal's sdk.
Pascal's SDK? Not Stef's SGDK?

Apocalypse
Newbie
Posts: 5
Joined: Mon Sep 07, 2015 2:09 am

Re: Libs & functions description

Post by Apocalypse » Tue Sep 15, 2015 2:34 am

djcouchycouch wrote:
Apocalypse wrote:Pascal's sdk.
Pascal's SDK? Not Stef's SGDK?
My mistake... I'm a bit lost, you're right it's Stef's SGDK (first message modified).

Stef
Very interested
Posts: 3131
Joined: Thu Nov 30, 2006 9:46 pm
Location: France - Sevres
Contact:

Re: Libs & functions description

Post by Stef » Tue Sep 15, 2015 10:19 am

You should find a doc folder in SGDK containing doxygen documentation generated in HTML format. So you can browse it while you are writing code ;-)
There is a wiki on the github repository website but it really needs an update...

Apocalypse
Newbie
Posts: 5
Joined: Mon Sep 07, 2015 2:09 am

Re: Libs & functions description

Post by Apocalypse » Tue Sep 15, 2015 9:48 pm

Hi Stef,
I've downloaded the Stef Dev Kit 0.4 on SpritesMind Tools web page but no documentation is included.
I found the full SGDK here http://stephane-d.github.io/SGDK/
I'm all good to code now!
Thanks.

Stef
Very interested
Posts: 3131
Joined: Thu Nov 30, 2006 9:46 pm
Location: France - Sevres
Contact:

Re: Libs & functions description

Post by Stef » Wed Sep 16, 2015 12:39 pm

Wow SGDK 0.4, it's a quite old version ! I probably added documentation later :p

Post Reply