Doxygen’le Tanışma

API hazırlamam gereken bir projede çalışırken, API’nın nasıl kullanılacağını anlatan bir de doküman hazırlamam gerekiyordu.
Keşke bunu otomatik olarak oluşturmanın bir yolu olsaydı diye düşünürken, doxygen yardımıma yetişti.

Doxygen koddaki yorum satırlarını derli toplu dokümanlara çevirmeyi sağlayan bir yazılım aracı.
Kendi sitesinde nasıl kullanılacağı ile ilgili sayısız örnek mevcut.

Ben de kendi tecrübemi burada paylaşmak istedim.

Bir c++ projesi ele alalım.
İlk hali şöyle olsun:
https://gitlab.com/birolcapa/doxygen-usage/tags/V1.0

index.chm’e baktığımda beni yönlendirecek, bu proje ile ilgili bilgi verecek hiçbir sayfa göremiyorum.
Böyle bir sayfa ekleyelim:
https://gitlab.com/birolcapa/doxygen-usage/tags/V1.1

Daire bilgi sayfasını biraz daha geliştirelim:
https://gitlab.com/birolcapa/doxygen-usage/tags/V1.2

Biraz da daire sınıfının nasıl kullanılabileceğine dair örnekler verelim:
https://gitlab.com/birolcapa/doxygen-usage/tags/V1.3

Örnek nasıl eklenir sorusunun en güzel cevabı:
https://gitlab.com/birolcapa/doxygen-usage/compare/V1.2…V1.3

Daha fazla yorum biçiminin ve örneğin yer aldığı son sürüm ise şöyle olsun:
https://gitlab.com/birolcapa/doxygen-usage/tags/V1.4