mirror of
https://github.com/4ian/GDevelop.git
synced 2025-10-15 10:19:04 +00:00
Updated docs, added linux script for generating docs
This commit is contained in:
Florian Rival
@@ -14,14 +14,14 @@
|
||||
* First, please refer to these pages to install the required tools and to get help about setting up a basic extension:<br>
|
||||
*
|
||||
* -# \subpage setupDevEnv
|
||||
* -# \subpage overview
|
||||
* -# \subpage writeANewExtension
|
||||
* -# \ref overview
|
||||
* -# \ref writeANewExtension
|
||||
*
|
||||
* You can also read \subpage recommendedToolsAndConventions.
|
||||
*
|
||||
* \section aboutdoc About this documentation
|
||||
*
|
||||
* If you never used GDevelop Core before, take a look at \subpage overview.
|
||||
* If you never used GDevelop Core before, take a look at \ref overview.
|
||||
*
|
||||
* As everything that is developed around GDevelop is based on this library, you should take a look at it quite often: platforms, extensions
|
||||
* and the IDE are intensively using the classes and tools offered by GDCore.
|
||||
@@ -37,7 +37,7 @@
|
||||
*
|
||||
* <b>Windows</b>
|
||||
*
|
||||
* Follow these three step to be able to compile %GDevelop and the extensions:
|
||||
* Follow these three step to be able to compile GDevelop and the extensions:
|
||||
* -# \subpage installWinLibs
|
||||
* -# \subpage installWinCompiler
|
||||
* -# \ref installAndUseCMake
|
||||
@@ -54,11 +54,11 @@
|
||||
/**
|
||||
* \page installWinLibs (Windows) Download and install SFML, wxWidgets and Boost
|
||||
*
|
||||
* %GDevelop uses development versions of SFML, wxWidgets or Boost. So as to prevent incompatibilities between the core of %GDevelop and
|
||||
* the extensions, %GDevelop require the extensions to use the same version of the libraries.
|
||||
* GDevelop uses development versions of SFML, wxWidgets or Boost. So as to prevent incompatibilities between the core of GDevelop and
|
||||
* the extensions, GDevelop require the extensions to use the same version of the libraries.
|
||||
* \section download Download
|
||||
|
||||
* You can download the specific versions of the libraries used by the current version of %GDevelop using these links:<br>
|
||||
* You can download the specific versions of the libraries used by the current version of GDevelop using these links:<br>
|
||||
* - http://www.compilgames.net/code/GameDevelopSDK/SFML.7z
|
||||
* - http://www.compilgames.net/code/GameDevelopSDK/wxwidgets.7z
|
||||
* - http://www.compilgames.net/code/GameDevelopSDK/boost_1_55_0.7z
|
||||
@@ -66,7 +66,7 @@
|
||||
* They are already built for windows, and for an use with the TDM-GCC compiler.
|
||||
*
|
||||
* \section uncompress Uncompress
|
||||
* By default, %GDevelop projects search the libraries in the ExtLibs
|
||||
* By default, GDevelop projects search the libraries in the ExtLibs
|
||||
* (located at the root of the SDK) directory ( ExtLibs/SFML, ExtLibs/wxWidgets... ).<br>
|
||||
* Uncompress the libraries in this directory.
|
||||
*/
|
||||
@@ -74,13 +74,13 @@
|
||||
/**
|
||||
* \page installWinCompiler (Windows) Install TDM-GCC compiler
|
||||
*
|
||||
* %GDevelop is compiled with TDM-GCC under Windows.<br>
|
||||
* So as to prevent incompatibilities between the compiler ( and the standard C++ library provided with ) used by %GDevelop and
|
||||
* the compiler used by the extensions, %GDevelop require the extensions and the platforms to use the same version of TDM-GCC.<br>
|
||||
* GDevelop is compiled with TDM-GCC under Windows.<br>
|
||||
* So as to prevent incompatibilities between the compiler ( and the standard C++ library provided with ) used by GDevelop and
|
||||
* the compiler used by the extensions, GDevelop require the extensions and the platforms to use the same version of TDM-GCC.<br>
|
||||
*
|
||||
* \section installWinCompiler_download Download
|
||||
*
|
||||
* The current version of the compiler used by %GDevelop can be found and downloaded on the website : http://www.compilgames.net
|
||||
* The current version of the compiler used by GDevelop can be found and downloaded on the website : http://www.compilgames.net
|
||||
*
|
||||
* \section installWinCompiler_install Installation
|
||||
*
|
||||
@@ -171,13 +171,13 @@
|
||||
*
|
||||
* \section download Download, (build) and install libraries
|
||||
*
|
||||
* %GDevelop is compiled with gcc under Linux.<br>
|
||||
* So as to prevent incompatibilities between the compiler ( and the standard C++ library provided with ) used by %GDevelop and
|
||||
* the compiler used by the extensions, %GDevelop require the extensions and the platforms to use the same version of gcc.<br>
|
||||
* GDevelop is compiled with gcc under Linux.<br>
|
||||
* So as to prevent incompatibilities between the compiler ( and the standard C++ library provided with ) used by GDevelop and
|
||||
* the compiler used by the extensions, GDevelop require the extensions and the platforms to use the same version of gcc.<br>
|
||||
*
|
||||
* \subsection sfml SFML
|
||||
*
|
||||
* %GDevelop may uses some specific version of SFML library. You can download the version used here: http://www.compilgames.net/code/GameDevelopSDK/SFMLlinux.7z <br>
|
||||
* GDevelop may uses some specific version of SFML library. You can download the version used here: http://www.compilgames.net/code/GameDevelopSDK/SFMLlinux.7z <br>
|
||||
*
|
||||
* The archive contains a precompiled version of SFML, compiled **for Ubuntu**, and only for the version for which GDevelop is distributed officially:
|
||||
* - If you compile GD on **this** version of Ubuntu, just extract the archive inside the folder ExtLibs.
|
||||
@@ -188,11 +188,11 @@
|
||||
*
|
||||
* \subsection boost Boost
|
||||
|
||||
* Boost version used by %GDevelop can be downloaded here: http://www.compilgames.net/code/GameDevelopSDK/boost_1_55_0.7z <br>
|
||||
* Boost version used by GDevelop can be downloaded here: http://www.compilgames.net/code/GameDevelopSDK/boost_1_55_0.7z <br>
|
||||
* Just extract the archive inside the folder ExtLibs (located at the root of the SDK).
|
||||
* \subsection wxWidgets wxWidgets
|
||||
|
||||
* wxWidgets version used by %GDevelop can be downloaded here: https://sourceforge.net/projects/wxwindows/files/3.0.1/wxWidgets-3.0.1.tar.bz2 <br>
|
||||
* wxWidgets version used by GDevelop can be downloaded here: https://sourceforge.net/projects/wxwindows/files/3.0.1/wxWidgets-3.0.1.tar.bz2 <br>
|
||||
* First extract the archive inside the folder ExtLibs.
|
||||
*
|
||||
* Be sure to have GTK+ 3.0 and WebKitGTK development files installed:
|
||||
@@ -374,7 +374,7 @@ sudo apt-get install libfreetype6-dev
|
||||
* }
|
||||
* ~~~~~~~~~~~~~~~~~~~~~
|
||||
*
|
||||
* The platform dynamic library file is often located inside <i>GDevelop directory</i>/*xxx*Platform (*xxx* being replaced by the platform acronym).
|
||||
* The platform dynamic library file is often located inside <i>GDevelop directory</i>/xxxPlatform (*xxx* being replaced by the platform acronym).
|
||||
*
|
||||
* In this folder, the platform can store basically anything it needs. For example, both GDJS and GDCpp are storing a folder called *Runtime* containing
|
||||
* the game engine.
|
||||
@@ -431,7 +431,7 @@ sudo apt-get install libfreetype6-dev
|
||||
*
|
||||
* \section writeANewExtension_installExtension Use the extension with GDevelop
|
||||
*
|
||||
* To make your extension usable with %GDevelop, you have to:
|
||||
* To make your extension usable with GDevelop, you have to:
|
||||
* -# **Copy the files** generated in *Binaries/Output/Release_{OS}* into your *GDevelop folder*.
|
||||
* -# For the C++ platform, copy **all needed include file** (.h files) inside a folder with the name of your extension located into <i>(GDevelop folder)/CppPlatform/Extensions/include</i>.<br>
|
||||
* You can use a *small script* (batch file on Windows) to copy all the needed includes files in a single click.<br>
|
||||
|
||||
@@ -640,7 +640,7 @@ WARN_FORMAT = "$file:$line: $text"
|
||||
# and error messages should be written. If left blank the output is written
|
||||
# to stderr.
|
||||
|
||||
WARN_LOGFILE = D:\Florian\Programmation\GameDevelop2\Core\doc\doxygen.log
|
||||
WARN_LOGFILE =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the input files
|
||||
@@ -651,7 +651,7 @@ WARN_LOGFILE = D:\Florian\Programmation\GameDevelop2\Core\doc\doxygen.
|
||||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
INPUT = "..\GDCore"
|
||||
INPUT = "../GDCore"
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 8.0 KiB |
@@ -4,7 +4,7 @@
|
||||
* \section welcome Welcome
|
||||
* This is the help file for the GDevelop C++ Platform, which contains a reference of all the features provided
|
||||
* by the C++ Platform and explains how to create extensions for this platform.<br>
|
||||
* Creating extensions need some knowledge in C++ language. %GDevelop use mainly SFML, Boost and wxWidgets libraries.
|
||||
* Creating extensions need some knowledge in C++ language. GDevelop use mainly SFML, Boost and wxWidgets libraries.
|
||||
*
|
||||
* ### GDevelop Core documentation
|
||||
* Some classes and features are provided by the *GDevelop Core library*: When you're working with a class in the <code>gd</code>
|
||||
@@ -68,7 +68,7 @@
|
||||
*
|
||||
* \section aboutBoostShared_ptr About Boost shared pointers
|
||||
*
|
||||
* %GDevelop use shared pointers ( boost::shared_ptr ), for scenes or objects for example. <br>
|
||||
* GDevelop use shared pointers ( boost::shared_ptr ), for scenes or objects for example. <br>
|
||||
* Shared pointers are used like raw pointers ( *myPointer to dereference the pointer and get the object, myPointer->myMember to access to a function/member of the object... ).
|
||||
* They doesn't need to be deleted manually: The pointed object is deleted when no more shared pointers are pointing to the object.
|
||||
* Thus, scenes for instance don't have to manually delete the objects they own in their destructors.
|
||||
|
||||
@@ -651,7 +651,7 @@ WARN_LOGFILE =
|
||||
# directories like "/usr/src/myproject". Separate the files or directories
|
||||
# with spaces.
|
||||
|
||||
INPUT = "..\GDCpp"
|
||||
INPUT = "../GDCpp"
|
||||
|
||||
# This tag can be used to specify the character encoding of the source files
|
||||
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 8.0 KiB |
@@ -1,5 +1,5 @@
|
||||
/**
|
||||
* \mainpage %GDevelop JS Platform
|
||||
* \mainpage GDevelop JS Platform
|
||||
* \image html gdlogo.png
|
||||
* \section welcome Welcome
|
||||
* This is the help file for the GDevelop JS Platform, which contains a reference of all the features provided
|
||||
@@ -11,7 +11,7 @@
|
||||
* Note that the documentation of the Javascript game engine of this platform is available [here](../GDJS Runtime Documentation/index.html).
|
||||
*
|
||||
* \section gettingstarted Getting started
|
||||
* Please refer to the getting started guide in the [GDCore documentation](..\GDCore Documentation\index.html).<br>
|
||||
* Please refer to the getting started guide in the [GDCore documentation](../GDCore Documentation/index.html).<br>
|
||||
* You can then read the \subpage OverviewOfGDJS.
|
||||
*/
|
||||
|
||||
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 11 KiB After Width: | Height: | Size: 8.0 KiB |
17
scripts/GenerateAllDocs.sh
Normal file
17
scripts/GenerateAllDocs.sh
Normal file
@@ -0,0 +1,17 @@
|
||||
#Script launching the generation of the documentations of all modules
|
||||
echo Generating all docs...
|
||||
mkdir -p logs
|
||||
cd ..
|
||||
cd Core/docs
|
||||
doxygen > ../../scripts/logs/CoreDoxygenLog.txt 2> ../../scripts/logs/CoreDoxygenWarningLog.txt
|
||||
cd ../..
|
||||
cd GDJS/docs
|
||||
doxygen > ../../scripts/logs/GDJSDoxygenLog.txt 2> ../../scripts/logs/GDJSDoxygenWarningLog.txt
|
||||
cd ../..
|
||||
cd GDCpp/docs
|
||||
doxygen > ../../scripts/logs/GDCppDoxygenLog.txt 2> ../../scripts/logs/GDCppDoxygenWarningLog.txt
|
||||
cd ../..
|
||||
cd GDJS/docs
|
||||
yuidoc ../Runtime > ../../scripts/logs/GDJSYuidDocLog.txt 2> ../../scripts/logs/GDJSYuidDocWarningLog.txt
|
||||
cd ../..
|
||||
cd scripts
|
||||
@@ -3,4 +3,4 @@
|
||||
* **ReleaseProcedure.bat**: this script compiles, generate documentation (see **GenerateAllDocs.bat**) and package GDevelop for Windows in an installer and an archive.
|
||||
* **ReleaseProcedure.sh**: compiles and package GD for Ubuntu (see *Binaries/Packaging*).
|
||||
* **CopyWindowsToLinuxReleaseFiles.sh**: Copy all files in *Binaries/Output/Release_Windows* to *Binaries/Output/Release_Linux*. Call it after any change in *Binaries/Output/Release_Windows*.
|
||||
* **GenerateAllDocs.bat**: Call doxygen and yuidoc to generate all the documentations into *docs* folder.
|
||||
* **GenerateAllDocs.[bat|sh]**: Call doxygen and yuidoc to generate all the documentations into *docs* folder.
|
||||
|
||||
Reference in New Issue
Block a user