API Documents Page

API Documents Page

This project has been updated to version v0.1.3-beta, and the API documentation has been synchronized accordingly. Some APIs are temporarily not included in the documentation and will be updated gradually.

❗ Note:

Since this project has not yet completed all the features to be perfected or implemented, the APIs of some main modules are temporarily not included in the documentation. The APIs of other modules have been basically perfected and will be updated gradually until all functions are completed.

About How to Compile Doxygen Documentation

💡 Tips:

Currently, the API documentation of this project only supports three languages: English (en), Simplified Chinese (zh_SC), and Traditional Chinese (zh_TC). Contributors or users are welcome to submit PRs to add documentation in other languages.

Step 1: Install Doxygen

Since the API documentation of this project is generated using Doxygen, you need to install the Doxygen tool first.

For Linux systems, you can directly use the following commands to install Doxygen:

Debian/Ubuntu:

sudo apt install doxygen -y

Fedora/Redhat/RockyLinux/AlmaLinux:

sudo dnf install doxygen -y

Arch Linux/Manjaro/EndeavourOS:

sudo pacman -Syu
sudo pacman -S doxygen

After successful installation, you can try entering the doxygen -v command in the terminal to check if the installation was successful. If successfully installed, it will display Doxygen version information similar to the following.

1.14.0 (cbe58f6237b2238c9af7f51c6b7afb8bbf52c866)

Step 2: Compile Doxygen Documentation

In the root directory of this project, execute the following command to compile the Doxygen documentation. Note that after entering the docs directory, you need to select the corresponding language folder (such as zh_SC (Simplified Chinese) or zh_TC (Traditional Chinese), etc.).

Here we assume compiling English documentation. If you need to compile documentation in other languages, simply replace en with the corresponding language folder.

cd /path/to/MyEngine
git checkout master
cd docs/en
doxygen Doxyfile

Step 3: View Documentation

After compilation is complete, you can find the generated HTML documentation in the docs/en/html directory. Simply open the index.html file to view it in the browser. The same applies to selecting other language folders.

About How to Add Documentation in Other Languages

💡 Tips:

If you want to add documentation in other languages for this project, contributors or users are welcome to submit PRs.

If you encounter any issues while adding documentation, please feel free to contact us.

1. Create a corresponding language folder in the docs directory (e.g., French folder fr, etc.).
2. In this folder, copy all files from the templates folder (including Doxyfile).
3. Edit the Doxyfile file and modify the following content:

   PROJECT_BRIEF          = "MyEngine API Manuel de développement"
   OUTPUT_LANGUAGE        = French
   

4. Edit all .dox files in the dox folder and translate them into the corresponding language. (Note: Currently all .dox files are Simplified Chinese documentation, you need to translate them into the corresponding language as needed.)
5. After completing the translation, execute the doxygen Doxyfile command in your language folder to compile the documentation for preview.