API Reference

Welcome to the Olympe Engine API Reference documentation. This section contains automatically generated documentation from the C++ source code.

📚 Documentation Sections

Core Systems

• ECS Components - All component definitions
• ECS Systems - System implementations
• Game Engine - Core engine class
• World - World management

AI System

• Behavior Trees - AI behavior tree implementation
• AI Components - AI-specific components
• AI Systems - AI processing systems

Prefab & Blueprint System

• Prefab Factory - Entity creation from prefabs
• Prefab Scanner - Blueprint file parser
• Component Definition - Component schema

Input System

• Input Manager - Input handling
• Input Device - Device management

Rendering & Camera

• Camera System - Camera management
• Rendering - Rendering pipeline

Utilities

• Vector - Math vector class
• System Utils - Utility functions

🔍 Browse Full API

For complete API documentation with all classes, functions, and file listings:

→ Browse Full Doxygen Documentation

📖 Quick Links

• Class Index
• Class Hierarchy
• File List
• Namespace List

🛠️ For Developers

This API documentation is automatically generated from source code comments using Doxygen. To update:

1. Add Doxygen comments to your code:

   /**
    * @brief Brief description of the class
    * 
    * Detailed description of what this class does
    * and how it should be used.
    */
   class MyComponent {
       /**
        * @brief Description of member
        */
       float myValue;
       
       /**
        * @brief Description of method
        * @param param1 Description of parameter
        * @return Description of return value
        */
       bool MyMethod(int param1);
   };

2. Commit changes - documentation updates automatically via GitHub Actions

📝 Documentation Standards

Follow these conventions when documenting code:

• Use @brief for short descriptions
• Use @param for parameters
• Use @return for return values
• Use @see for cross-references
• Use @warning for important notes
• Use @example for code examples

For more information, see the Contributing Guide.