Developersland

Teknoloji ve Yazılım Blogu

  • Yazıtipi boyutunu arttır
  • Varsayılan yazıtipi boyutu
  • Yazıtipi boyutunu azaltır

Doxygen dökümantasyon sistemi

Visual studio 2010 ortamında oluşturulan projelerde Doxygen dökümantasyon sisteminin kullanımı

Birinci adım-Kurulum:
İlk olarak Win32 binary dosyaları www.stack.nl\~dimitri/doxygen/download.html#latestsrc
adresinden indirilir. Doxygen konfigürasyonu için default.doxygen ya da herhangibir isimde bir dosya oluşturulur. Yapılan proje için oluşturulan conf dosyası aşağıda verilmiştir. Dosya oluşturulduktan sonra VS2010 ortamına Doxygen in Tool olarak eklenmesi ve kullanılması adımı kaldı. Bunun için de VS2010 menüsüdeki Tools bölümüne geçilir External Tools kısmından Add diyerek yeni bir tool eklenir. Doxygen için gerekli ayarlamalar alttaki resimde gösterilmiştir:



doxygen

Command bölümü doxygen exesinin olduğu yeri gösterir. Arguments kısmı konfigürasyon
dosyasının konumunu belirtmek içindir. Doxygen çalıştırıldıktan sonra oluşan loglar output
kısmında görülebilir.(Use output window) Doxygenin oluşturduğu dökümantasyonu görüntülemek için ikinci bir tool oluşturulur.


 View DoxyDoc isimli bu tool için gerekli ayarlar alttaki resimde verilmiştir:

 
doxygen

Doxygen dökümanlarının gösterilmesi için bir browser gerekmektedir. Mozilla ya da IE
bunun için kullanılabilir. Dökümantasyonun görüntüleneceği output index.html olmaktadır.
Konfigürasyon dosyasında yapılacak seçimlere göre rtf ve daha birçok formatta dökümantasyon
alınabilir. Gerekli seçimler yapıldıktan sonra kofigürasyon dosyası .sln uzantılı vs2010 solution
dosyasının bulunduğu klasör konumuna kopyalanır. Sln çalıştırıldıktan sonra Tools bölümünden
DoxyGen çalıştırılır. İşlem tamamlandıktan sonra View DoxyDoc ile index.html çalıştırılır.

Konfigürasyon dosyasında yapılan değişiklikler:
*PROJECT_NAME bölümüne dökümantasyonu yapılacak ismi yazılır. Varsa
PROJECT_NUMBER bölümüne versiyonu yazılır.
*JavaDoc dökümanyasyon stili kullanılacaksa ;
JAVADOC_AUTOBRIEF = YES olarak değiştirilir. Böylece yazılan commentler sınıfların html sayfalarında görülebilir.

*Projede herhangi bir dll (kütüphane) export etme durumu varsa doxygen dökümanlarında export edilen sınıfların ismi gözükmeyecektir. Bundan kurtulmak için default.doxygen dosyasında bulunan

# Configuration options related to the preprocessor bölümü altındaki keywordler aşağıdaki
gibi değiştirlir:

ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED = {Tanımlanan macronun-kütüphanenin adı(ABC_LIB gibi)} \
Library_EXPORT (ABC_EXPORT gibi)
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES

Yapılan değişikliklerden sonra doxygen kullanılabilir.

default.doxygen dosyasına bakmak için tıklayınız.


 

Yorum ekle


Güvenlik kodu
Yenile