זוהי הפקודה rdoc שניתן להפעיל בספק האירוח החינמי של OnWorks באמצעות אחת מתחנות העבודה המקוונות המרובות שלנו, כגון Ubuntu Online, Fedora Online, אמולטור מקוון של Windows או אמולטור מקוון של MAC OS
תָכְנִית:
שֵׁם
rdoc2.3 - הפקת תיעוד מקובצי סקריפט Ruby
תַקצִיר
rdoc2.3 [אפשרויות] [שמות...]
תיאור
קבצים מנותחים, והמידע שהם מכילים נאסף, לפני פלט כלשהו
מיוצר. זה מאפשר לפתור הפניות צולבות בין כל הקבצים. אם שם הוא א
ספרייה, היא עוברת. אם לא צוינו שמות, כל קבצי Ruby בקובץ הנוכחי
ספרייה (ותתי ספריות) מעובדות.
פורמטים זמינים של פלט: chm, html, ri, xml
למידע לאן הולך הפלט, השתמש ב:
rdoc ---help-output
אפשרויות
--מגיש, -A שם עזר[,..]
רשימה מופרדת בפסיק של שיטות מחלקות נוספות שיש להתייחס אליהן
'attr_reader' וחברים. האופציה עשויה לחזור על עצמה. לכל שם אביזר עשוי להיות
'=טקסט' צורף, ובמקרה זה טקסט זה מופיע במקום שבו מופיע r/w/rw
אביזרים רגילים.
--את כל, -a
כלול את כל השיטות (לא רק ציבוריות) בפלט.
--charset, -c ערכה
מציין ערכת תווים של HTML
--לנפות, -D
מציג המון על דברים פנימיים
--תרשים, -d
ליצור דיאגרמות המציגות מודולים ומחלקות. אתה צריך נקודה V1.8.6 ואילך כדי להשתמש
אפשרות --דיאגרמה בצורה נכונה. נקודה זמינה מ
<כתובת אתר:http://www.research.att.com/sw/tools/graphviz/>.
--לכלול, -x דפוס
אין לעבד קבצים או ספריות תואמות דפוס. קבצים שניתנו במפורש על
שורת הפקודה לעולם לא תוחרג.
--סיומת, -E חדש = זקן
התייחס לקבצים המסתיימים ב-.new כאילו הם הסתיימו ב-.old. שימוש ב-'-E cgi=rb' יעשה זאת
לגרום ל-xxx.cgi להיות מנותח כקובץ Ruby
--תיבות קבצים, -F
מחלקות מוכנסות לתיבות המייצגות קבצים, היכן שהמחלקות הללו שוכנות.
כיתות ששותפו בין יותר מקובץ אחד מוצגות עם רשימה של קבצים שמשתפים
אוֹתָם. נמחק בשקט אם --דיאגרמה אינה ניתנת ניסיוני.
--fmt, -f שם הפורמט
הגדר את פורמט הפלט (ראה להלן).
--עֶזרָה, -h
שימוש בהדפסה.
--תפוקת עזרה, -O
להסביר את אפשרויות הפלט השונות.
--פורמט תמונה, -I gif|png|jpg|jpeg
מגדיר פורמט תמונת פלט עבור דיאגרמות. יכול להיות png, gif, jpeg, jpg. אם אפשרות זו
מושמט, נעשה שימוש ב-png. דורש --דיאגרמה.
--לִכלוֹל, -i dir[,dir...]
הגדר (או הוסף ל) את רשימת הספריות שיש לחפש בהן כאשר אתה מספק :include:
בקשות. ניתן להשתמש יותר מפעם אחת.
--מקור-מוטבע, -S
הצג את קוד המקור של השיטה בשורה, במקום דרך קישור קופץ.
--מספרי שורות, -N
כלול מספרי שורות בקוד המקור
--רָאשִׁי, -m שם
השם יהיה העמוד הראשוני שיוצג.
--לְמַזֵג, -M
בעת יצירת פלט ri, מיזוג מחלקות מעובדות למחלקות שתועדו קודם לכן
של שם השם.
--קובץ אחד, -1
לשים את כל הפלט לקובץ אחד.
--אופ, -o dir
הגדר את ספריית הפלט.
--opname, -n שם
הגדר את שם הפלט. אין השפעה על HTML.
--מוּפקָר, -p
כאשר מתעדים קובץ המכיל מודול או מחלקה המוגדרים גם באחר
קבצים, הצג את כל החומר עבור אותו מודול/מחלקה בכל דף קבצים. כברירת מחדל, בלבד
הצג דברים שהוגדרו בקובץ הספציפי הזה.
--שֶׁקֶט, -q
אל תראה התקדמות בזמן שאנו מנתחים.
--רי, -r
צור פלט לשימוש על ידי 'ri'. הקבצים מאוחסנים בספריית '.rdoc'
תחת ספריית הבית שלך אלא אם כן נדחק על ידי פרמטר --op עוקב, אז לא
יש צורך בהרשאות מיוחדות.
--ri-site, -R
צור פלט לשימוש על ידי 'ri'. הקבצים מאוחסנים בספרייה ברחבי האתר,
מה שהופך אותם לנגישים לאחרים, ולכן יש צורך בהרשאות מיוחדות.
--ri-system, -Y
צור פלט לשימוש על ידי 'ri'. הקבצים מאוחסנים בספרייה ברמת המערכת,
מה שהופך אותם לנגישים לאחרים, ולכן יש צורך בהרשאות מיוחדות. אפשרות זו היא
מיועד לשימוש במהלך התקנות רובי.
--show-hash, -H
שם של הטופס #name בהערה הוא היפר-קישור אפשרי לשיטת מופע
שֵׁם. כאשר מוצג, ה-'#' מוסר אלא אם צוין אפשרות זו.
--סִגְנוֹן, -s סגנונות-כתובת אתר
מציין את כתובת האתר של גיליון סגנונות נפרד.
--רוחב כרטיסייה, -w n
הגדר את רוחב תווי הטאב (ברירת מחדל 8).
--תבנית, -T שם התבנית
הגדר את התבנית המשמשת בעת יצירת פלט.
--כותרת, -t טֶקסט
הגדר טקסט ככותרת עבור הפלט.
--גִרְסָה, -v
להציג את הגרסה של RDoc.
--webcvs, -W כתובת אתר
ציין כתובת URL לקישור לממשק אינטרנט ל-CVS. אם כתובת האתר מכילה א
'%s', שם הקובץ יצורף אליו.
יולי 2014 RDOC2.3(1)
השתמש ב-rdoc באינטרנט באמצעות שירותי onworks.net
