Merge pull request #21 from HeatXD/docs

Docs

Author: HeatXD

.github/workflows/deploy.yml

@@ -6,6 +6,7 @@ permissions:
   contents: write
   packages: write
   deployments: write
+  pages: write
 jobs:
   build:
     strategy:
@@ -59,7 +60,6 @@ jobs:
       - name: Build
         run: cmake --build build --config Release
 
-      # Debugging step: Print out directory contents (after build)
       - name: List output directory contents
         run: |
           if [ -d "out" ];then
@@ -70,10 +70,8 @@ jobs:
       
       - name: Prepare files for packaging
         run: |
-          # Create the directory structure for the package
           mkdir -p package/Release/${{ matrix.platform }}/lib
           
-          # Only copy binaries if the output directory exists
           if [ -d "out" ]; then
             cp -r out/* package/Release/${{ matrix.platform }}/lib/ || true
           else
@@ -113,7 +111,6 @@ jobs:
 
       - name: Create OS-specific packages
         run: |
-          # Group by OS platform
           for os_platform in windows linux macos; do
             mkdir -p "GekkoNet-${os_platform}"
             mkdir -p "GekkoNet-${os_platform}/${os_platform}/include"
@@ -136,3 +133,41 @@ jobs:
           draft: false
           prerelease: false
           files: GekkoNet-*-Release.tar.gz
+
+  generate_docs:
+    needs: create_release
+    runs-on: ubuntu-latest
+    if: ${{ success() }}
+    permissions:
+      contents: write
+      pages: write
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install Doxygen
+        run: sudo apt-get update && sudo apt-get install -y doxygen graphviz
+
+      - name: Configure CMake for Documentation
+        run: |
+          cmake -B build \
+          -DBUILD_DOCS=ON \
+          -DCMAKE_BUILD_TYPE=Release \
+          GekkoLib
+
+      - name: Generate Documentation
+        run: cmake --build build --target docs
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+
+      - name: Upload Documentation
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: 'build/docs/html'
+
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}

GekkoLib/CMakeLists.txt

@@ -10,6 +10,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED True)
 
 # Option to build both shared and static libraries
 option(BUILD_SHARED_LIBS "Build using shared libraries" OFF)
+option(BUILD_DOCS "Build documentation" OFF)
 
 if(MSVC)
     # Visual Studio specific flags
@@ -28,7 +29,6 @@ option(NO_ASIO_BUILD "Exclude ASIO from the build" OFF)
 
 # Include directories for your project headers
 include_directories(${PROJECT_SOURCE_DIR}/include)
-
 # Include directories for third-party header-only libraries
 include_directories(${PROJECT_SOURCE_DIR}/thirdparty)
 include_directories(${PROJECT_SOURCE_DIR}/thirdparty/asio)
@@ -49,7 +49,6 @@ set(SRC_FILES
 # Shared libraries
 set(CMAKE_RUNTIME_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/out)
 set(CMAKE_LIBRARY_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/out)
-
 # Static libraries
 set(CMAKE_ARCHIVE_OUTPUT_DIRECTORY ${PROJECT_SOURCE_DIR}/out)
 
@@ -58,11 +57,9 @@ add_library(GekkoNet ${SRC_FILES})
 
 # Set the output names conditionally based on used options
 set(TARGET_SUFFIX "")
-
 if(NOT BUILD_SHARED_LIBS)
     set(TARGET_SUFFIX "${TARGET_SUFFIX}_STATIC")
 endif()
-
 if(NO_ASIO_BUILD)
     set(TARGET_SUFFIX "${TARGET_SUFFIX}_NO_ASIO")
 endif()
@@ -79,4 +76,57 @@ endif()
 
 if(NO_ASIO_BUILD)
     target_compile_definitions(GekkoNet PRIVATE GEKKONET_NO_ASIO)
+endif()
+
+# Documentation configuration
+if(BUILD_DOCS)
+    find_package(Doxygen
+                REQUIRED dot
+                OPTIONAL_COMPONENTS mscgen dia)
+
+    # Get all header files
+    file(GLOB_RECURSE HEADER_FILES
+        ${PROJECT_SOURCE_DIR}/include/*.h
+    )
+
+    # Combine sources and headers for documentation
+    set(DOXYGEN_INPUT_FILES
+        ${SRC_FILES}
+        ${HEADER_FILES}
+        ${PROJECT_SOURCE_DIR}/README.md
+    )
+
+    # Configure Doxygen settings
+    set(DOXYGEN_PROJECT_NAME "GekkoNet")
+    set(DOXYGEN_PROJECT_VERSION ${PROJECT_VERSION})
+    set(DOXYGEN_PROJECT_BRIEF "C/C++ Peer to Peer Game Networking SDK")
+    set(DOXYGEN_OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs)
+    set(DOXYGEN_GENERATE_HTML YES)
+    set(DOXYGEN_GENERATE_TREEVIEW YES)
+    set(DOXYGEN_EXTRACT_ALL YES)
+    set(DOXYGEN_EXTRACT_PRIVATE YES)
+    set(DOXYGEN_EXTRACT_STATIC YES)
+    set(DOXYGEN_RECURSIVE YES)
+    set(DOXYGEN_SOURCE_BROWSER YES)
+    set(DOXYGEN_GENERATE_LATEX NO)
+    set(DOXYGEN_USE_MDFILE_AS_MAINPAGE "README.md")
+    set(DOXYGEN_COLLABORATION_GRAPH YES)
+    set(DOXYGEN_CLASS_GRAPH YES)
+    set(DOXYGEN_CALL_GRAPH YES)
+    set(DOXYGEN_CALLER_GRAPH YES)
+    set(DOXYGEN_HIDE_UNDOC_RELATIONS NO)
+    
+    # Add custom settings for networking library
+    set(DOXYGEN_BUILTIN_STL_SUPPORT YES)
+    set(DOXYGEN_EXTRACT_LOCAL_CLASSES YES)
+    set(DOXYGEN_SHOW_INCLUDE_FILES YES)
+    set(DOXYGEN_GENERATE_TODOLIST YES)
+    set(DOXYGEN_WARNINGS YES)
+    set(DOXYGEN_WARN_IF_UNDOCUMENTED YES)
+    
+    # Generate documentation
+    doxygen_add_docs(docs
+        ${DOXYGEN_INPUT_FILES}
+        COMMENT "Generating API documentation with Doxygen"
+    )
 endif()