RDoc

RDoc מורכב משני חלקים עיקריים.

אחד הוא rdoc , כלי להפקת תיעוד HTML. השני הוא רי , כלי ליצירה בתיעוד של ממשק שורת פקודה רובי.

כדי להיות מסוגל להשתמש כראוי RDoc, היזם חייב לשנות את הדרך שבה הוא מוסיף הערות קוד המקור שלו.

RDoc משתמש במבנה הערות קוד ספציפי מקור, כדי שיוכלו בקלות להיות חילוץ לעזור לאכלס את האתר תיעוד.

מבנה הערתו של RDoc הוא מוצלח מאוד, בשימוש על ידי גנרטורים תיעוד דומים רבים שנוצרו עבור שפות תכנות אחרות

מה חדש במהדורה זו:.

• RDoc יכולים כעת לייצר קבצי התרגום לשימוש עם gettext.

מה חדש בגירסה 4.2.0:

• RDoc יכולים כעת לייצר קבצי התרגום לשימוש עם gettext .

מה חדש בגירסה 4.1.0:.

• נגישות משופרת של פלט HTML
• המבט של RDoc עודכן.

מה חדש בגירסה 4.0.0:.

• Markdown נוסף כפורמט נתמך
• רי כעת ניתן להציג דפים (README, וכו.).
• המדינה העולמית יוסר RDoc. RDoc :: חנות מחזיקה את עץ התיעוד ומחבר את הנהג אל המנתחים גנרטור.

מה חדש בגירסה 3.12:

• שיפורים קלים:
• מסמך נוסף מפתחים אשר מכיל סקירה של אופן הפעולה RDoc ואיך להוסיף תכונות חדשות כדי RDoc.
• הכותרת משופרת עבור פלט HTML לכלול --title בתוך אלמנט הכותרת.
• rdoc --pipe מבינה כעת --markup.
• RDoc תומך כעת IRC-ערכת קישורים.
• תיקוני באגים:
• קבוע כותרת על פלט HTML לדפים.
• קבוע ניתוח של הלא מסוכסך HEREDOC.
• קבוע ניתוח של% w [] ו literals% אחרים.
• החלפת חץ קבועה בתפוקת HTML munging המפעיל החללי.
• חלקי מילה במילה עם ERB תואמים לבן קוד רובים כבר לא תחביר הדגיש.
• קצות קו על חלונות מנורמל מייד לאחר קריאה עם binmode.
• RDoc טוב יותר מבין הנחיות להערות. הנחיות הערה כעת ניתן למצוא בכל מקום הערות קו רב.
• קישורים מסודרים לשיטות להראות את התווית שוב.
• RDoc :: :: C מנתח יכול עכשיו למצוא הערות ישירות מעל rb_define_class_under.
• rdoc, backspace ו formatters ANSI, תוויות והערות ללא גופים כעת מוצגים.
• rdoc, backspace ו formatters ANSI, רווחים בין התווית או פתק ואת המעי הגס הוא פשט עכשיו.

מה חדש בגירסה 3.11:

• תיקוני באגים:
• הימנע ניתוח של קבצי תגיות נכללו אבני חן.

מה חדש בגירסה 3.9.2:

• באג לתקן:
• התיר TIDYLINK ביטוי סדיר לאפשר לכל התוכן בקטע קישור כמו: & # x3c; tt & # x3e; {foo} [rdoc-נ"צ: SomeClass] & # x3c; / tt & # x3e;
• כותרות פלט HTML הם כתרים ב & # x3c; tt & # x3e; & # x3c; h6 & # x3e; & # x3c; / tt & # x3e; שוב.

מה חדש בגירסה 3.9.1:

• תיקוני באגים:
• תקן RDoc :: Markup מנתח עבור נגיחה ואחריו אסימון שאינו טקסט.
• תקן RDoc :: Markup :: ToHtmlCrossref # gen_url עבור הלא - & # x3c; tt & # x3e; rdoc-נ"צ & # x3c; / tt & # x3e; קישורים.
• כתובת אתר של דוח תיקון באג שקריסת rdoc.

מה חדש בגירסה 3.8:

• שיפורים קלים:
• RDoc :: :: C מנתח יכול עכשיו לגלות שיטות על ENV ו ARGF.
• RDoc :: מנתח :: C עכשיו יודע על rb_cSocket ו rb_mDL.
• תיקוני באגים:
• עדכון אובייקט בחנות נתונים רי עם נתונים חדשים עכשיו תסיר שיטות, כולל, קבועים וכינויים.

מה חדש בגירסה 3.7:

• שיפורים קלים:
• הוראה חדשה: קטגוריה: המאפשר שיטות להיות מקובצים למקטעים יותר נקייה. ראה RDoc :: Markup לפרטים.
• מסמך ממדרגה עבור RDoc :: מנתח :: C תומך כעת Foo :: const וכן const.
• פלט שיטת רי הוא כעת רשימה מופרדים בפסיקים כאשר מוצג באופן אינטראקטיבי.
• RDoc :: ClassModule # למזג עכשיו מעדיף את המידע של הוויכוח על מקלט של (זה עכשיו מתנהג כמו חשיש # למזג! במקום מיזוג # Hash לאחור!).
• RDoc :: Markup # להמיר עכשיו יסכים RDoc :: למשל מסמך :: Markup
• RDoc מחזיקה כיום את הקוד ליצירת RDoc ונתונים רי כאשר אבני חן להתקין
• נוסף RDoc :: RDoc :: לאפס
• נוסף RDoc :: CodeObject # file_name
• תיקוני באגים:
• RI כבר לא מתרסק כאשר מנסים להשלים מישור
• RDoc :: מנתח :: רובי כבר לא אוכלים תוכן כאשר = להתחיל / = בלוקים תיעוד סוף מלוות פריט documentable. גליון 41 # על ידי MFN.
• RDoc :: Markup :: מעצב ו subclasses החברה לאפשר סימון + אופציונלי + פרמטר להוספת סימון מותאם אישית. הדוגמה RDoc :: Markup :: מעצב החברה יעבוד.
• RDoc :: :: C מנתח יכול כעת להבחין בין שיטות בכיתה ושיטות למשל מסמך-השיטה.
• RDoc עכשיו מקודד שמות קבצים בקידוד הפלט.
• יצירת הקובץ רי על כינויי השיטה כבר לא משכפל את הכיתה #full_name