Doxygen-agent — Developer Documentation Generator
=================================================

``doxygen-agent`` provides Codex instructions for generating **developer
documentation** (Doxygen) for Vertex-CFD. Its files are located under
``ai-agent/doxygen-agent``.

Agent files
-----------

.. code-block:: text

   ai-agent/doxygen-agent/
   |-- README.md
   |-- AGENTS.md
   |-- SKILLS.md

* ``AGENTS.md`` defines the repository instructions and documentation standards.
* ``SKILLS.md`` defines the Doxygen documentation workflow.

Prerequisite
------------

Install the Codex CLI and sign in with your ChatGPT account or OpenAI API key.

Generate developer documentation
--------------------------------

Run Codex from the Vertex-CFD repository root so it can access the agent
instructions and source tree.

Interactive
~~~~~~~~~~~

.. code-block:: bash

   cd /path/to/vertex-cfd
   codex

Then enter a prompt such as:

   Read ``ai-agent/doxygen-agent/AGENTS.md`` and
   ``ai-agent/doxygen-agent/SKILLS.md``, then generate Doxygen documentation
   for all files in ``<folder path>``.

Non-interactive
~~~~~~~~~~~~~~~

.. code-block:: bash

   cd /path/to/vertex-cfd
   codex exec "Read ai-agent/doxygen-agent/AGENTS.md and ai-agent/doxygen-agent/SKILLS.md, then generate Doxygen documentation for all files in <folder path>."

Notes
-----

* ``<folder path>`` is relative to the Vertex-CFD repository root unless an
  absolute path is provided.
* Review the generated changes before committing them.
* For **user documentation** (Sphinx), use the bundled ``sphinx-agent`` instead.