Difference between revisions of "He/דוקסיג'ן"
From GnuCash
(fix language box) |
(→כללי: style) |
||
| Line 13: | Line 13: | ||
==כללי== | ==כללי== | ||
| − | [https://he.wikipedia.org/wiki/Doxygen דוקסיג'ן] הוא | + | לעת עתה [https://he.wikipedia.org/wiki/Doxygen דוקסיג'ן] הוא הכלי המרכזי בו אנו עושים שימוש לתיעוד קוד המקור (ינואר 2011). |
| − | + | להפקת תיעוד הקוד, התכנה שולפת מקוד המקור הערות (מיוחדות), שהוזנו על ידי המפתחים . | |
;כול לילה: מחולל אוטומטית לזמינות מקוונת על בסיס קבוע בכתובת {{BuildServer}}/docs/ לשני הענפים: | ;כול לילה: מחולל אוטומטית לזמינות מקוונת על בסיס קבוע בכתובת {{BuildServer}}/docs/ לשני הענפים: | ||
| − | :[{{BuildURL}}/docs/MAINT/ MAINT], תקון תקלים מישני הבא, | + | :[{{BuildURL}}/docs/MAINT/MAINT], תקון תקלים מישני הבא, ו־ |
| − | :[{{BuildURL}}/docs/MASTER/ MASTER], השחרור העיקרי הבא. | + | :[{{BuildURL}}/docs/MASTER/MASTER], השחרור העיקרי הבא. |
==יצירת תעוד המקור== | ==יצירת תעוד המקור== | ||
Revision as of 16:36, 5 August 2021
| שפות | Deutsch | English | Español | Français | עִברִית | Português |
|---|
כללי
לעת עתה דוקסיג'ן הוא הכלי המרכזי בו אנו עושים שימוש לתיעוד קוד המקור (ינואר 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 */
שיפור תיעוד המקור
קובץ כותרת עם API ציבורי חייב לכלול את מקטעי דוקסיג'ן הבאים:/**
* @addtogroup <module>
* @{
* @file
* @brief <A brief description>
* @author Copyright (C) <year> <name> <email>
*/
