Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Enable Doxygen in wazuh-agent repository #558

Open
6 tasks
TomasTurina opened this issue Jan 29, 2025 · 0 comments
Open
6 tasks

Enable Doxygen in wazuh-agent repository #558

TomasTurina opened this issue Jan 29, 2025 · 0 comments
Assignees
@jr0me
Labels
level/task Task issue module/agent type/enhancement Enhancement issue

Comments

@TomasTurina
Copy link
Member

Description

Currently, the wazuh-agent repository uses the Doxygen format to document code. However, documentation is not being generated yet, so there is no validation that the code is well documented.

Tasks

  • Create a configuration file for Doxygen.
  • Run Doxygen. Fix the run failures if necessary.
  • Validate that all the code is well documented.
    • Apply the necessary changes.
  • Create a workflow to be able to run this task.
    • Use the existing .github/actions/doxygen/action.yml action file.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jr0me jr0me

Labels
level/task Task issue module/agent type/enhancement Enhancement issue
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@TomasTurina @jr0me