forums.ps2dev.org Forum Index forums.ps2dev.org
Homebrew PS2, PSP & PS3 Development Discussions
 
 FAQFAQ   SearchSearch   MemberlistMemberlist   UsergroupsUsergroups   RegisterRegister 
 ProfileProfile   Log in to check your private messagesLog in to check your private messages   Log inLog in 

HOW TO: Generate PSPSDK documentacion

 
Post new topic   Reply to topic    forums.ps2dev.org Forum Index -> PSP Development
View previous topic :: View next topic  
Author Message
waterazu



Joined: 22 Feb 2007
Posts: 1
PostPosted: Thu Feb 22, 2007 3:03 am    Post subject: HOW TO: Generate PSPSDK documentacion Reply with quote
1.- DOWNLOAD DOXYGEN

Do it from http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc

Like author wrote, "It is a GNU documentation generator for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors) and to some extent PHP, C#, and D"

2.- DOXYGEN INSTALLATION

Basically it consist on decompressing the downloaded file

3.- ENVIROMENT VARIABLE

To use DoxyGen where you like, be sure to include doxygen on the PATH
You can do it temporarily on a Windows cmd session like this:

Code:
set PATH=%PATH%;<InstallationDoxygenDir>/doxygen.exe


4.- PREPARE doxygen.cfg

doxygen.cfg is your doxygen configuration file (obvious waterAZU :)). I recommend use the template from

http://svn.ps2dev.org/filedetails.php?repname=psp&path=%2Ftrunk%2Fpspsdk%2Fdoxygen.cfg&sc=1
(if you can't get the file from the link, try searching on Google this "pspsdk doxygen.cfg" and follow a valid link to get the file, better from a official site like snv.ps2dev.org)

Next, you need to substitute the next values:
Code:
PROJECT_NAME = $(PROJECT)-$(VERSION)
OUTPUT_DIRECTORY = $(DOCDIR)
INPUT = $(SRCDIR)

and use appropriate values, for example:
Code:
PROJECT_NAME = PSPSDK-1.0
OUTPUT_DIRECTORY = c:\pspsdk\doc\
INPUT = c:\pspsdk\src


You can customize this file more, as you desire.

5.- Open a Windows cmd windows: Start->Execute->cmd and:
5.1.- cd <yourPspSdkDir>/doc
5.2.- doxygen.exe doxygen.cfg

In the OUTPUT_DIRECTORY you will see 2 folders: html and latex. In HTML look for index.hmlt and open it.

ˇˇˇˇYOUR PRETTY PSPSDK DOC IS READY!!!!

Hope it helps
Back to top
View user's profile Send private message
jimparis



Joined: 10 Jun 2005
Posts: 1179
Location: Boston
PostPosted: Thu Feb 22, 2007 4:13 am    Post subject: Reply with quote
Thanks waterazu. If anyone is interested, I also have the pspsdk docs available online at http://psp.jim.sh/pspsdk-doc/. They are updated regularly.
Back to top
View user's profile Send private message
Cy-4AH



Joined: 31 Jan 2007
Posts: 44
Location: Belarus
PostPosted: Thu Feb 22, 2007 6:52 pm    Post subject: Reply with quote
I'd like to add, that psptoolchain generate pspsdk documentation if you have doxygen.
Back to top
View user's profile Send private message
gbj1



Joined: 08 Feb 2007
Posts: 45
PostPosted: Thu Feb 22, 2007 7:42 pm    Post subject: Reply with quote
Thanks for the guide,waterazu.

If doxygen is installed, just
Code:
make doxygen-doc
and you'll get a doc set ready to install.
_________________
guo.bojun@gmail.com
Back to top
View user's profile Send private message
Display posts from previous:   
Post new topic   Reply to topic    forums.ps2dev.org Forum Index -> PSP Development All times are GMT + 10 Hours
Page 1 of 1

 
Jump to:  
You cannot post new topics in this forum
You cannot reply to topics in this forum
You cannot edit your posts in this forum
You cannot delete your posts in this forum
You cannot vote in polls in this forum


Powered by phpBB © 2001, 2005 phpBB Group