cxref - מקוון בענן

תָכְנִית:

שֵׁם

cxref - כלי C Cross References & Documenting.

תַקצִיר

cxref שם הקובץ [ ... שם קובץ] [-Oשם הדירוג] [-נשם בסיס] [-רשם בסיס] [-כל-התגובות]
[-אין תגובה] [-מילה במילה-הערות] [-חסום-תגובות]
[-xref[-all][-file][-func][-var][-type]] [-warn[-all][-comment][-xref]]
[-index[-all][-file][-func][-var][-type]] [-גלם] [-שרף גומי] [-html[-src]] [-rtf] [-sgml]
[-אנישם הדירוג] [-דלְהַגדִיר] [-Uלְהַגדִיר] [-CPP cpp_program] [-- cpp_args ... cpp_args]

cxref שם הקובץ [ ... שם קובץ] -לִמְחוֹק [-Oשם הדירוג] [-נשם בסיס] [-רשם בסיס]

תיאור

תוכנית שיכולה ליצור באופן אוטומטי תיעוד והפניות צולבות עבור C
תכנית.

הקלט הוא כל תוכנית C עם הערות מתאימות והפלט הוא LaTeX, HTML, RTF או
קבצי SGML.

אפשרויות

שם הקובץ
שם הקובץ לתיעוד, ניתן לתעד כל מספר קבצים בו-זמנית.

-לִמְחוֹק
יש למחוק את הקבצים הנקובים בספריית הפלט ואת הערכים שלהם
יש להסיר את מסד הנתונים ההצלבה וקובצי הפלט הראשיים.

-שם אודיר
שם הספרייה לשימוש עבור קבצי הפלט לטקס ומיקום ה-
קבצי הפניה צולבים שנוצרים.

-Nbasename
השם שישמש עבור החלק הראשון של הפלט וקובצי הפניות מוצלבות במקום זאת
של cxref, סיומות הקובץ נשארות זהות.

-שם שם
כאשר קבצי המקור נמצאים ביותר מספריה אחת, הגדר את שם הכתובת לשם של
ספריית השורש של עץ המקור (השתמש בנתיב יחסי אם קל יותר, למשל `-R../ ..').
זה יריץ את cxref מאותה ספריית שורש ו-'-Odirname' חייב להיות
ביחס לאותו ספרייה.

-כל ההערות
במקרה שאתה חושב שההערות הקיימות עשויות לעבוד, (ראה למעלה לתיאור
של הערות מיוחדות). [סַכָּנָה! אפשרות זו יכולה להניב תוצאות מוזרות.]

-אין תגובה
מתעלם מכל ההערות, שימושי אם אתה רק רוצה את ההפניות הצולבות ולא את
תיעוד.

-הערות-מילה
כאשר ההערות שיש לך בקוד מעוצבות בסגנון קבוע מראש
שאתה רוצה לשמור על הפלט, אפשרות זו תאלץ אותם לא להיות
פורמט מחדש. [שים לב, זה להערות קבצים ופונקציות בלבד.]

-חסום-הערות
כאשר ההערות בתוכנית מעוצבות בסגנון `בלוק' (עם מוביל
תו '*' בכל שורה), אפשרות זו תסיר את התו הזה מה-
תְפוּקָה. [עובד עבור `*', `+', `|' יחיד או `:' בכל שורה.]

-xref הפק מידע הצלבה (ראה להלן).
-הכל כל הפניות צולבות.
-קובץ הפניות מוצלבות לקבצים.
-func הפניות צולבות לפונקציות.
-var הפניות צולבות למשתנים.
-סוג הפניות צולבות עבור טיפוסים.

-לְהַזהִיר הפק אזהרות, יש לשרשר את האפשרויות יחד:
-הכל כל האזהרות.
-הערה הזהר מפני הערות חסרות.
-xref אזהרה מפני הפניות צולבות חסרות.

-אינדקס הפק אינדקס הפניות צולב, יש לשרשר את האפשרויות יחד:
-כל כל האינדקסים.
-קובץ אינדקס של קבצים.
-func אינדקס של פונקציות.
-var אינדקס של משתנים.
-סוג אינדקס סוגים.

-גלם הפק צורה גולמית של פלט, לא ממש שימושי למעט עם -warn.

-שרף גומי הפק קובץ LaTeX לתיעוד כל אחד מקבצי המקור וגם קובץ נוסף
הכולל כל אחד מהקבצים הללו.

-html הפק קובץ HTML 4.01 לתיעוד כל אחד מקובצי המקור וקובץ ראשי אליו
עיין בכל אחד מהקבצים הללו.

-html-src
הפק את פלט ה-HTML וגרסת HTML של קובץ המקור עם קישורים לתוכו.

-rtf הפק קובץ טקסט עשיר (RTF) כדי לתעד את קובץ המקור.

-sgml הפק קובץ SGML כדי לתעד את קובץ המקור. (באמצעות LinuxDoc DTD).

-Idirname
אפשרות GCC לציון הנתיב עבור קבצי כלול.

-הגדר
אפשרות GCC להגדרת סמל טרום-מעבד.

-לא מגדיר
אפשרות GCC לביטול הגדרה של סמל טרום-מעבד.

-CPP התוכנית
שם התוכנית לשימוש במקום ברירת המחדל של זמן ההידור. התכנית
חייב להיות מסוגל לבצע את כל הפעולות ש'gcc -E -C -dD' עושה כדי לעבוד. אם
התוכנית לוקחת טיעונים אז כל העניין צריך להיות במרכאות כדי שזה יהיה
מתפרש כארגומנט יחיד ל-cxref.

--גדול מ ... גדול מ
ניתן להציב ארגומנטים נוספים שיועברו למעבד המקדים לאחר ה---'
מפריד.

C מהדר תחליף cxref-cc
כדי לפשט את השימוש ב-cxref בקוד מקור קיים, יש כעת סקריפט מעטפת שיעשה זאת
קרא למהדר C ולאחר מכן קרא ל-cxref כדי לעבד את קובץ המקור. זה אומר שזה
יכול לשמש כתחליף ל-CC ב-Makefiles וכדומה.

שימוש: cxref-cc [אפשרויות CC רגילות]

שם קובץ המקור חולץ מרשימת האפשרויות וכן '-D*',
`-I*', `-U*' מסמנים וכאשר מהדר C יוצא בהצלחה ייקרא cxref. ה
שם המהדר C לשימוש נשלט על ידי משתנה הסביבה CXREFCC, או אם
זה לא מוגדר אז משתנה הסביבה CC, או אם נכשל זה רק gcc.

שימוש בסקריפט זה דורש שימוש בקובץ תצורה `.cxref' כדי להכיל את האפשרויות
מכיוון שאין איפה לשים את האפשרויות בשורת הפקודה עבור מהדר C.

זה רק יצליב ויתעד את קבצי המקור C מכיוון שהם היחידים
אלה שהולקטו, אבל זה יוודא שהם מוצלבים עם ה-
אפשרויות נכונות וכו'.

Cxref תְצוּרָה שלח
ניתן להכניס ארגומנטים אלה של שורת הפקודה גם לקובץ בשם `.cxref' במקום ב-
שורת הפקודה. כאשר cxref מופעל, הארגומנטים לתוכנית מתפרשים ב-
בהזמנה הבאה.

(1) אלה בשורת הפקודה. (2) אלה בקובץ `.cxref' בספרייה הנוכחית.
(3) אלה בקובץ `.cxref' בשורש עץ המקור שצוין על ידי `-R'.

המשמעות היא שבעץ מקור מרובה ספריות, לכל תת-ספרייה יכולה להיות '.cxref'
קובץ המכיל רק את השורה `-R..' או מתאים. הספרייה הראשית יכולה לכלול א
קובץ `.cxref' המכיל את שאר האפשרויות. זה מסיר לחלוטין את הצורך
לאפשרויות כלשהן בשורת הפקודה מלבד שמות קבצי המקור.

הפורמט של קובץ `.cxref' הוא כל מספר של שורות, שכל אחת מהן מכילה אחת
ארגומנט שורת הפקודה (שווה ערך לאחד מה-argv). האפשרויות היחידות שלא יכולות להיות
בשימוש הם שמות קבצי המקור עצמם ואפשרות `-delete'. קווים ריקים הם
התעלמו ושורות המתחילות ב-'#' הן הערות.

תָכְנִית תיעוד תגובות
התיעוד לתוכנית מופק מהערות בקוד שהן
בפורמט מתאים. ההפניה ההצלבה מגיעה מהקוד עצמו ודורשת לא
עבודה נוספת.

ההערות המיוחדות הן `/**** ****/' (עבור קובץ) ו-`/*++++ ++++*/' (עבור נתונים
אובייקט) ניתן להשתמש בכל מספר של `*' או `+' בתוך ההערה הסטנדרטית `/*' ו-`*/'
מתוחמים בהערות, מתעלמים מהם.

אם שורת הערה מתחילה ברווח לבן ואחריה `+html+' אז שאר ה-
שורה נכללת רק בפלט HTML, ואינה מעובדת כך שהיא יכולה לכלול HTML
סימון, `-html-' פירושו ששאר השורה נכללת בכל פרט ל-HTML
תְפוּקָה. אותו דבר חל גם על פורמטי הפלט האחרים, ניתן להשתמש ב-`+none+' עבור שורות
לא להופיע בשום פלט. החריג לכך הוא שהפלט הגולמי אינו עושה שום דבר
בודק ויוציא את כל השורות.

בכל מצב שבו הערה באה אחרי `,', `;' או `)' מופרדים רק על ידי רווחים ו
לשוניות, ההערה נדחפת לפני סימני הפיסוק כדי להחיל על האובייקט שם.

התוכנית מיושמת באמצעות מנתח דקדוק מלא ANSI C עם כמה הרחבות GCC,
זה אומר שהסגנון של הקוד לא חשוב, רק התוכן וההערות.

לַחֲצוֹת הפניה
ההפניה הצולבת מתבצעת עבור הפריטים הבאים

קבצים
הקבצים שבהם נכלל הקובץ הנוכחי
(גם כאשר נכלל באמצעות קבצים אחרים).

#כולל
קבצים הכלולים בקובץ הנוכחי.
קבצים הכלולים בקבצים אלה וכו'.

משתנים
מיקום ההגדרה של משתנים חיצוניים.
הקבצים שיש להם נראות של משתנים גלובליים.
הקבצים / הפונקציות המשתמשות במשתנה.

פונקציות
הקובץ שבו נוצר אב טיפוס של הפונקציה.
הפונקציות שהפונקציה קוראת להן.
הפונקציות שקוראות לפונקציה.
הקבצים והפונקציות המתייחסות לפונקציה.
המשתנים המשמשים בפונקציה.

כל אחד מהפריטים הללו מוצלב בפלט.

ההפניה ההצלבה משתמשת בקבצים `cxref.variable', `cxref.function', `cxref.include' ו-
`cxref.typedef' בספריית הפלט. אלה רשימה מלאה של הפונקציה ו
שימוש משתנה בתוכנית ויכול לשמש ליצירת היררכיית קריאת פונקציה או
דיאגרמת שימוש משתנה למשל. יש צורך בשני מעברי cxref של כל קובץ, הראשון
לבנות את קבצי ההפניה ההצלבה ואת השני להשתמש בהם.

(שמות הקבצים שונים אם נעשה שימוש באפשרות '-N').

LaTeX תְפוּקָה
פלט ברירת המחדל של LaTeX הוא קובץ עבור כל אחד מקבצי המקור עם קובץ אחד נוסף
`cxref.tex' הכולל כל אחד מהקבצים האחרים. זה כדי לאפשר קובץ makefile רק
עדכן את הקבצים שהשתנו (למרות שההפניות עשויות לחייב את כל הקבצים
נבדק שוב). כאשר הקובץ cxref.tex נכתב, המשתמש יכול לשנות אותו,
כל קבצים חדשים שנוספו מתווספים בסוף קטע קוד המקור, שאר הקבצים
הקובץ ללא שינוי.

האינדקס נכתב לקובץ בשם `cxref.apdx.tex' ו-cxref.tex מתעדכן להתייחסות
אליו.

כמו כן נכתבו שלושה קבצים בסגנון LaTeX `page.sty', `fonts.sty' ו-`cxref.sty'.
אלה מגדירים את הדף להשתמש בשוליים קטנים יותר ובגופנים קטנים יותר כדי לאפשר יותר להופיע בו
עמוד וגם להגדיר את הפקודות החדשות לקביעת הקלדה של הפלט cxref.

(שמות הקבצים `cxref.tex' ו-`cxref.apdx.tex' שונים אם האפשרות `-N' היא
בשימוש.)

HTML תְפוּקָה
פלט ה-HTML המוגדר כברירת מחדל הוא קובץ עבור כל אחד מקובצי המקור עם קובץ אחד נוסף
`cxref.html' הכולל כל אחד מהקבצים האחרים. זה כדי לאפשר קובץ makefile רק
עדכן את הקבצים שהשתנו (למרות שההפניות עשויות לחייב את כל הקבצים
נבדק שוב). כאשר הקובץ cxref.html נכתב, המשתמש יכול לשנות אותו,
כל קבצים חדשים שנוספו מתווספים בסוף לפני תוכן העניינים, השאר
של הקובץ ללא שינוי.

האינדקס נכתב לקובץ בשם `cxref.apdx.html' ו-cxref.html מתעדכן להתייחסות
אליו.

(שמות הקבצים `cxref.html' ו-`cxref.apdx.html' שונים אם האפשרות `-N' היא
בשימוש.)

פלט ה-HTML משתמש בתקן HTML 4.01 וכל הדפים מאומתים כהלכה.

RTF תְפוּקָה
פורמט טקסט עשיר הוא פורמט תיאור עמוד ברמה נמוכה למדי שהומצא על ידי מיקרוסופט. זה
אינו תקן מוגדר היטב וקל להבנה כמו שאר הפורמטים, אבל הוא כן
פופולרי להחלפת מסמכים.

יש קובץ פלט בודד לכל אחד מקבצי המקור וקובץ אינדקס.

SGML תְפוּקָה
מכיוון ש-SGML היא מטא-שפה, יש צורך להגדיר את רכיבי הפריסה וכן
לספק את המידע. הפלט cxref משתמש בפורמט מסמך LinuxDoc והוא
מיועד לשימוש עם תוכניות SGMLtools (http://www.sgmltools.org/).

יש קובץ פלט בודד לכל אחד מקבצי המקור וקובץ אינדקס.

השתמש ב-cxref באינטרנט באמצעות שירותי onworks.net