He/דוקסיג'ן

From GnuCash
Jump to: navigation, search
שפות Deutsch English Español Français עִברִית Português

כללי

דוקסיג'ן הוא המוקד המרכזי לתיעוד קוד המקור לעת עתה (ינואר 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>
 */
כאשר <module> הוא בדרך כלל שם המחיצה.

קישורים

תיעוד API גנוקאש
MAINT
MASTER
דוקסיג'ן
אתר מרשתת
מאגר גיט
עמוד ויקי