گروه فنی مهندسی آرکام

فرایند نصب و پیکربندی DoxyGen جهت استفاده در پروژه های uVision

1.         نصب نرم‌افزارهای DoxyGen و GraphViz

http://www.stack.nl/~dimitri/doxygen/download.html

http://www.graphviz.org/Download_windows.php

2.         باز کردن نرم‌افزار uVision

3.         انتخاب گزینه Customize Tools Menu، از منوی Tools

4.         افزودن یک مدخل (Entry) جدید با عنوان DoxyGen: Make Template

5.         انجام تظیمات زیر برای مدخل ایجاد شده

Command: C:\Program Files\doxyGen\bin\DoxyGen.exe

Initial Folder:

Arguments: -g @P.doxy

6.          افزودن (Add) یک مدخل جدید دیگر با عنوان DoxyGen: Generate Documentation

7.         انجام تظیمات زیر برای مدخل ایجاد شده

Command: C:\Program Files\doxyGen\bin\DoxyGen.exe

Initial Folder:

Arguments: @P.doxy

طریقه‌ی استفاده

1.         باز کردن پروژه‌ی µVision مورد نظر جهت تولید مستندات آن

2.         انتخاب گزینه DoxyGen: Make Template از منوی Tools، جهت ایجاد فایل پیکربندی (Configuration Template) و ذخیره آن (projectname.doxy) داخل پوشه‌ی (Folder) پروژه

3.         افزودن فایل projectname.doxy به ساختار درختی کدهای برنامه (Source-Tree) و باز کردن آن جهت ویرایش

4.         انجام ویرایش ‌های زیر

OPTIMIZE_OUTPUT_FOR_C = YES

WARN_FORMAT = "$file($line): $text"

5.         انتخاب گزینه DoxyGen: Make Documentation از منوی Tools، جهت تولید مستندات پروژه براساس توضیحات (Comment) نوشته شده در کدهای پروژه