דוקסיג'ן

From GnuCash
Jump to: navigation, search
שפות אנגלית גרמנית ספרדית עִברִית פורטוגזית צרפתית

כללי

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

Nightlies
This is done and put online on a regular basis at code.gnucash.org/docs/ for both branches :
MAINT, the next minor bugfix and
MASTER, the next major release.

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

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

make doc

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

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

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

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

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

  • ליצירת הערכה בסיגנון C, היא צריכה להתחיל ב- /** או /*!.
  • בדרך כלל הערת ההסבר צריכה להופיע לפני ההכרזה. אם ההערה תופיע מאחורי הכרזת חבר, הסמל הבא צריך להיות <, וכתוצאה מכך /**< או /*!<.
  • מלות מפתח דוקסיג'ן המתחילות ב- \ או @.
  • To document global objects, you must document the file in which they are defined:
     /*! \file */
    
או
 /** @file */

Improving the Source Documentation

A header file of a public API should have the following Doxygen section:
/**
 * @addtogroup <module>
 * @{
 * @file
 * @brief <A brief description>
 * @author Copyright (C) <year> <name> <email>
 */
where <module> is usually the name of the directory.

קישורים

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