RDoc

RDOC αποτελείται από δύο κύρια μέρη.

Ένα είναι RDOC , ένα βοηθητικό πρόγραμμα για τη δημιουργία εγγράφων HTML. Το δεύτερο είναι ri , ένα εργαλείο για τη δημιουργία τεκμηρίωσης για το Ruby διεπαφή γραμμής εντολών.

Για να μπορέσετε να χρησιμοποιήσετε σωστά RDOC, ο κύριος του έργου πρέπει να αλλάξει ο τρόπος που προσθέτει σχόλια στον πηγαίο κώδικα του.

RDOC χρησιμοποιεί ένα σχόλιο κωδικό δομή συγκεκριμένη πηγή, ώστε να μπορούν εύκολα να εξαχθούν και να βοηθήσει καταλαμβάνουν το χώρο τεκμηρίωσης.

δομή σχόλιο RDOC είναι εξαιρετικά επιτυχής, που χρησιμοποιείται από πολλές παρόμοιες γεννήτριες έγγραφα που δημιουργήθηκαν για άλλες γλώσσες προγραμματισμού

Τι είναι καινούργιο σε αυτή την έκδοση:.

• RDOC μπορεί πλέον να παράγει αρχεία μετάφρασης για χρήση με gettext.

Τι είναι καινούργιο στην έκδοση 4.2.0:

• RDOC μπορεί πλέον να παράγει αρχεία μετάφρασης για χρήση με gettext .

Τι είναι καινούργιο στην έκδοση 4.1.0:.

• Η βελτίωση της προσβασιμότητας της εξόδου HTML
• Το βλέμμα του RDOC έχει ενημερωθεί.

Τι είναι καινούργιο στην έκδοση 4.0.0:.

• Προστέθηκε Markdown ως υποστηριζόμενη μορφή
• ri μπορεί να δείξει τώρα σελίδες (README, κλπ.).
• Αφαιρέθηκε παγκόσμια κατάσταση από RDOC. RDOC :: Κατάστημα κατέχει το δέντρο τεκμηρίωση και συνδέει τον οδηγό με τα προγράμματα ανάλυσης και της γεννήτριας.

Τι είναι καινούργιο στην έκδοση 3.12:

• Μικρά βελτιώσεις:
• εγγράφου Προστέθηκε DEVELOPERS το οποίο περιέχει μια γενική εικόνα για το πώς λειτουργεί RDOC και πώς μπορείτε να προσθέσετε νέα χαρακτηριστικά στο RDOC.
• Βελτιωμένη τίτλο για έξοδο HTML για να συμπεριλάβει --title στο στοιχείο τίτλο.
• RDOC --pipe καταλαβαίνει τώρα --markup.
• RDOC υποστηρίζει τώρα IRC καθεστώς υπερ-συνδέσεις.
• Διορθώσεις σφαλμάτων:
• Σταθερή τίτλο στην έξοδο HTML για τις σελίδες.
• Σταθερή parsing των μη δαντελωτές heredoc.
• Σταθερή parsing του% w [] και άλλα% λεκτικές.
• Σταθερή αντικατάσταση βέλος στην έξοδο HTML munging τον χειριστή διαστημόπλοιο.
• Πλήρη τμήματα με ERB που ταιριάζουν με τον κώδικα Ruby λευκή λίστα δεν είναι πλέον σύνταξη-τονίζεται.

Οι
• καταλήξεις Γραμμή για τα παράθυρα ομαλοποιηθεί αμέσως μετά την ανάγνωση με binmode.
• RDOC καλύτερα κατανοεί οδηγίες για σχόλια. οδηγίες σχόλιο μπορεί τώρα να βρεθεί σε οποιοδήποτε σημείο σχόλια πολλαπλών γραμμών.
• Περιποιημένα συνδέσεις με μεθόδους δείξτε την ετικέτα και πάλι.
• RDOC :: Parser :: C μπορούν τώρα να βρουν σχόλια ακριβώς πάνω rb_define_class_under.
• Στην RDOC, backspace και ANSI διαμορφωτές, ετικέτες και σημειώσεις, χωρίς σώματα εμφανίζονται τώρα.
• Στην RDOC, backspace και ANSI διαμορφωτές, κενό ανάμεσα ετικέτα ή σημείωση και του παχέος εντέρου είναι πλέον αφαιρεθεί.

Τι είναι καινούργιο στην έκδοση 3.11:

• Διορθώσεις σφαλμάτων:
• Αποφύγετε την ανάλυση των αρχείων TAGS περιλαμβάνονται στο πολύτιμους λίθους.

Τι είναι καινούργιο στην έκδοση 3.9.2:

• Διόρθωση σφάλματος:
• Λασκαρισμένοι TIDYLINK regexp να επιτρέψει οποιοδήποτε περιεχόμενο στην ενότητα σύνδεσμο όπως: & # X3C? Tt & # x3e? {Foo} [RDOC-ref: SomeClass] & # X3C? / Tt & # x3e?
• Στις κλάσεις εξόδου HTML είναι καλυμμένες σε & # X3C? Tt & # x3e? & # X3C? Η6 & # x3e? & # X3C? / Tt & # x3e? και πάλι.

Τι είναι καινούργιο στην έκδοση 3.9.1:

• Διορθώσεις σφαλμάτων:
• Fix RDOC :: Markup αναλυτή για μια κεφαλίδα που ακολουθείται από μια συμβολική μη-κειμένου.
• Fix RDOC :: Markup :: ToHtmlCrossref # gen_url για μη - & # X3C? Tt & # x3e? RDOC-διαιτητή & # X3C? / Tt & # x3e? συνδέσεις.
• αναφορά σφάλματος Fix URL όταν κολλάει RDOC.

Τι είναι καινούργιο στην έκδοση 3.8:

• Μικρά βελτιώσεις:
• RDOC :: Parser :: C τώρα να ανακαλύψουν μεθόδους για ENV και ατξΡ-.
• RDOC :: Parser :: C ξέρει τώρα για rb_cSocket και rb_mDL.
• Διορθώσεις σφαλμάτων:
• Ενημέρωση αντικειμένου σε μια ri αποθήκευσης δεδομένων με τα νέα δεδομένα που τώρα καταργεί τις μεθόδους, περιλαμβάνει, σταθερές και ψευδώνυμα.

Τι είναι καινούργιο στην έκδοση 3.7:

• Μικρά βελτιώσεις:
• Νέα οδηγία: Κατηγορία: που επιτρέπει μεθόδους που πρέπει να ομαδοποιούνται σε ενότητες πιο καθαρό τρόπο. Δείτε RDOC :: Markup για λεπτομέρειες.
• Έγγραφο-class για RDOC :: Parser :: C υποστηρίζει τώρα Foo :: CONST καθώς CONST.
• μέθοδος ri εξόδου είναι τώρα μια λίστα διαχωρισμένη με κόμματα, όταν εμφανίζονται διαδραστικά.
• RDOC :: ClassModule # συγχωνεύσει τώρα προτιμά τις πληροφορίες του επιχειρήματος πάνω του δέκτη (συμπεριφέρεται τώρα σαν Hash # συγχωνεύσει! Αντί προς τα πίσω Hash # συγχώνευση!).
• RDOC :: Markup # μετατρέψετε τώρα δέχεται ένα RDOC :: Markup :: παράδειγμα εγγράφου
• RDOC κατέχει πλέον τον κώδικα για τη δημιουργία RDOC και ri δεδομένα όταν εγκαταστήσετε πετράδια
• Προστέθηκε RDOC :: RDOC :: επαναφορά
• Προστέθηκε RDOC :: CodeObject # όλνκα_αξρείνπ
• Διορθώσεις σφαλμάτων:
• Ρόουντ Άιλαντ Δεν υπάρχει πλέον διακόπτεται όταν προσπαθεί να ολοκληρώσει ένα απλό
• RDOC :: Parser :: Ruby δεν είναι πλέον τρώει περιεχόμενο, όταν = αρχίζουν τα μπλοκ / = τέλος τεκμηρίωση που ακολουθείται από μια τεκμηριωμένες στοιχείο. Τεύχος # 41 από ΜΕΚ.
• RDOC :: Markup :: Μορφοποιητής και υποκατηγορίες επιτρέπουν τώρα ένα προαιρετικό + σήμανσης + παράμετρος για την προσθήκη έθιμο σήμανσης. Το παράδειγμα στο RDOC :: Markup :: Μορφοποιητής θα λειτουργήσει τώρα.
• RDOC :: Parser :: C μπορεί τώρα να γίνει διάκριση μεταξύ των μεθόδων τάξη και χάριν μεθόδους στο έγγραφο-μέθοδο.
• RDOC κωδικοποιεί τώρα τα ονόματα των αρχείων στην κωδικοποίηση εξόδου.
• παραγωγής ψηφιακών δεδομένων ri για τη μέθοδο ψευδώνυμα πλέον αναπαράγει την τάξη σε #full_name