Difference between revisions of "He/דוקסיג'ן"

כללי

לעת עתה דוקסיג'ן הוא הכלי המרכזי בו אנו עושים שימוש לתיעוד קוד המקור (ינואר 2011). להפקת תיעוד הקוד, התכנה שולפת מקוד המקור הערות (מיוחדות), שהוזנו על ידי המפתחים .

כול לילה

מחולל אוטומטית לזמינות מקוונת על בסיס קבוע בכתובת code.gnucash.org/docs/ לשני הענפים:

[1], תקון תקלים מישני הבא, ו־

[2], השחרור העיקרי הבא.

יצירת תעוד המקור

ניתן להריץ מהעותק המקומי במחשב את הפקודה:

make doc

או במידה והחבליה נבנת באמצעות ninja:

ninja doc

חשוב דורש התקנה של דוקסיג'ן במחשב. אחרת היעד doc לא יהיה זמין.

הרצת פקודות השורה הללו, יאכלסו את ${BUILDDIR}/libgnucash/doc. בעיות ושגיאות ירשמו ל- doxygen.log. את קובצי ה- HTML ניתן יהיה למצוא בתת-התקייתב- html.

קובץ ההתצור יווצר מ- ${SOURCEDIR}/libgnucash/doc/doxygen.cfg.in.

רכיבי דוקסיג'ן

• ליצירת הערכה בסיגנון C, היא צריכה להתחיל ב- /** או /*!.
• בדרך כלל הערת ההסבר צריכה להופיע לפני ההכרזה. אם ההערה תופיע אחורי ההכרזה, הסמל (תו) הבא צריך להיות <, וכתוצאה מכך /**< או /*!<.
• מילות מפתח דוקסיג'ן המתחילות ב- \ או @.
• לתיעוד אובייקטים כליליים, יש לתעד את הקובץ בו הם מוגדרים:

 /*! \file */

או

 /** @file */

שיפור תיעוד המקור

/**
 * @addtogroup <module>
 * @{
 * @file
 * @brief <A brief description>
 * @author Copyright (C) <year> <name> <email>
 */

קישורים

תיעוד API גנוקאש

MAINT

MASTER

דוקסיג'ן

אתר מרשתת

מאגר גיט

עמוד ויקי