Add Doxygen support

[Copilot]

The repository lacked a Doxyfile and the update-docs.yml workflow, causing the Doxygen action to always fail with error: Doxyfile not found and no input file specified!. The workflow was also a broken copy from ebpf-for-windows, referencing that repo's gh-pages branch.

Description

• Doxyfile — New Doxygen configuration targeting this project:

  • Documents public headers under include/
  • OPTIMIZE_OUTPUT_FOR_C = YES for C-style header parsing
  • PREDEFINED = __doxygen + EBPF_HELPER macro expansion so helper function declarations are parsed correctly
  • HTML-only output to docs/html; LaTeX/RTF/man disabled

• .github/workflows/update-docs.yml — New workflow replacing the broken one:

  • Triggers on push to main
  • Installs doxygen, checks out repo, clones gh-pages branch of microsoft/ntosebpfext (not ebpf-for-windows)
  • Runs doxygen, commits, and pushes updated HTML docs to gh-pages

Testing

No automated tests apply — this is a documentation generation pipeline change. Validated locally that doxygen Doxyfile completes successfully (exit 0) and generates HTML output from the include/ headers.

Documentation

This change introduces Doxygen-generated API documentation for the public headers (ebpf_ntos_hooks.h, ebpf_netevent_hooks.h, and the associated GUID headers), publishable to GitHub Pages at https://microsoft.github.io/ntosebpfext/.

Installation

No installer impact.

Original prompt

---

This section details on the original issue you should resolve

<issue_title>Add Doxygen support</issue_title>
<issue_description>The Doxygen Action is invalid and has never succeeded as there is no Doxyfile defined for this project, as evidenced by the action error:

Run doxygen
error: Doxyfile not found and no input file specified!

It seems this was copied from the ebpf-for-windows repository as there are direct references to it:

    - name: Clone docs
      run: |
        git config --global user.email 'ebpf-for-windows@users.noreply.github.com'
        git config --global user.name 'Github Action'
        git clone --branch gh-pages https://github.com/microsoft/ebpf-for-windows.git docs/html

    - name: Update docs
      run: |
        doxygen
        cd docs/html
        git add .
        if [ -n "$(git status --porcelain)" ]; then
        git commit -s -m "Updated documentation"
        git remote set-url origin https://x-access-token:${{ secrets.GITHUB_TOKEN }}@github.com/microsoft/ebpf-for-windows.git
        git push
        fi

Doxygen support should be added such that the action succeeds.</issue_description>

Comments on the Issue (you are @copilot in this section)

@shankarseal Doxygen should be supported for this repo and a doxyfile should be introduced. @shankarseal @abeltrano - can you please update the issue? @abeltrano @shankarseal Updated to reflect Doxygen support should be added.

• Fixes Add Doxygen support #287

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Copilot]

Pull request overview

Adds a Doxygen configuration and a GitHub Actions workflow so this repo can generate API documentation from the public headers under include/ and publish the resulting HTML to the gh-pages branch (GitHub Pages), addressing prior workflow failures due to a missing Doxyfile / incorrect repo references.

Changes:

• Introduces a new Doxyfile configured for C-style header parsing and HTML-only output under docs/html.
• Adds/updates .github/workflows/update-docs.yml to install Doxygen, generate docs, and push updates to gh-pages.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.

File	Description
Doxyfile	New Doxygen configuration targeting include/ and generating HTML output under docs/html.
.github/workflows/update-docs.yml	New/updated workflow to run Doxygen on main pushes and publish generated HTML to gh-pages.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.