Setup doxygen

[TetsuOtter]

ドキュメントを生成するツールであるDoxygenを導入してみました。 mainブランチへのpushをトリガーにGitHub Actionsで自動的に生成され、https://tr-42.github.io/minishell/index.html から閲覧可能になります。

Doxygen向けにコメントを書けば、もちろんページにも反映されます。 積極的にコメントを書いて頂けるとコード理解の補助になるので良いのですが、もちろん強制はしませんし、私自身も面倒なので気が向いたやつにだけやるつもりです。 (ぜひ全部に書いてほしい！ とのことであれば、頑張って書いていきます。)

表示例

[TetsuOtter]

@paphio-kitsuki

なるほど！了解しました！ 使い道がいまいち分からないのですが、とりあえずいつも通りの方法でコメントを書けば良いのでしょうか？

いつもの方法でも問題ないです! ただ、通常の記法だとdoxygenが読み取ってくれないので、ドキュメントに反映させるにはdoxygen用の記法でコメントを書く必要があります。

参考: https://www.mathkuro.com/c-cpp/doxygen/#toc2