Jump to content


Opening and using .doxyfile


1 reply to this topic

#1 sujay

    Member

  • Members
  • PipPip
  • 30 posts

Posted 07 May 2012 - 05:26 PM

Hello Guys,
I currently downloaded the source code for gameplay game engine .
There is a .doxy file along with the code.
I am not able to open it or use it.
I tried even on Internet.
It says .doxy is a documentation system.
Could anyone help me open it and use it please..

#2 TheNut

    Senior Member

  • Moderators
  • 1696 posts
  • LocationThornhill, ON

Posted 07 May 2012 - 06:16 PM

That is a Doxygen configuration file. You will need to download and install Doxygen for your OS and compile the help files. Once installed, you just have to add Doxygen to your Path system environment variable (in Windows) and run "doxygen" from the command line where the doxy file is located. Depending on the configuraiton options, it may create HTML, CHM, or RTF documents. It can also take a while to compile the API documents if there's a lot of source code involved.

Keep in mind this will only generate an API document (similar to JavaDocs). It's only as good as the comments they put in the source code. It's in no way the same quality as a Wiki page or dedicated online help. They have a gameplay-docs folder with some pdf files in there. You would probably be better off reading those first.
http://www.nutty.ca - Being a nut has its advantages.





1 user(s) are reading this topic

0 members, 1 guests, 0 anonymous users