HOW TO: Generate PSPSDK documentacion

[waterazu]

1.- DOWNLOAD DOXYGEN

Do it from http://www.stack.nl/~dimitri/doxygen/do ... #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: Select all

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?r ... n.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: Select all

PROJECT_NAME = $(PROJECT)-$(VERSION)
OUTPUT_DIRECTORY = $(DOCDIR)
INPUT = $(SRCDIR)

and use appropriate values, for example:

Code: Select all

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

[jimparis]

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.

[Cy-4AH]

I'd like to add, that psptoolchain generate pspsdk documentation if you have doxygen.

[gbj1]

Thanks for the guide,waterazu.

If doxygen is installed, just

Code: Select all

make doxygen-doc 

and you'll get a doc set ready to install.