He/דוקסיג'ן
From GnuCash
שפות | English | עִברִית |
---|
כללי
לעת עתה דוקסיג'ן הוא הכלי המרכזי שמשמש אותנו לתיעוד קוד המקור (ינואר 2011). התכנה שולפת מקוד המקור הערות (מיוחדות) שהוזנו על ידי המפתחים במהלך הקידוד, להפקת תיעוד הקוד.
- בכול לילה
- דוקסיג'ן מחולל אוטומטית, על בסיס קבוע, להשגת לזמינות מקוונת, לכתובת code.gnucash.org/docs/ לשני הענפים:
- MAINT, למאגר תיקון התקלים המישני הבא, ו־
- MASTER, מאגר השחרור העיקרי הבא.
יצירת תעוד המקור
ניתן להריץ מהעותק המקומי במחשב את הפקודה:
make doc
או במידה והחבליה נבנת באמצעות ninja:
ninja doc
חשוב דורש התקנה של דוקסיג'ן במחשב. אחרת היעד doc לא יהיה זמין. |
הרצת פקודות השורה הללו, יאכלסו את ${BUILDDIR}/libgnucash/doc. בעיות ושגיאות ירשמו ל־ doxygen.log. את קובצי ה־HTML ניתן יהיה למצוא בתת־התקיית ה־html.
קובץ ההתצור יווצר מ־${SOURCEDIR}/libgnucash/doc/doxygen.cfg.in.
רכיבי דוקסיג'ן
- ליצירת הערה בסיגנון C, היא צריכה להתחיל ב־/** או /*!.
- בדרך כלל הערת ההסבר צריכה להופיע לפני ההכרזה. אם ההערה תופיע אחורי ההכרזה, הסמל (תו) הבא צריך להיות
<
, וכתוצאה מכך /**< או /*!<. - מילות מפתח דוקסיג'ן המתחילות ב־
\
או@
. - לתיעוד עצמים כלליים, יש לתעד את הקובץ בו הם מוגדרים:
/*! \file */
- או
/** @file */
שיפור תיעוד המקור
קובץ כותרת עם API ציבורי חייב לכלול את מקטעי דוקסיג'ן הבאים:/**
* @addtogroup <module>
* @{
* @file
* @brief <A brief description>
* @author Copyright (C) <year> <name> <email>
*/