RDoc

RDoc si compone di due parti principali.

Una è rdoc , un programma di utilità per la generazione di documentazione HTML. Il secondo è ri , uno strumento per la creazione di documentazione per l'interfaccia a riga di comando Ruby.

Per poter utilizzare correttamente RDoc, lo sviluppatore deve cambiare il modo in cui lui aggiunge commenti al suo codice sorgente.

RDoc utilizza una fonte specifica commenti del codice struttura, in modo che possano essere facilmente estratto e aiutare popolano il sito della documentazione.

Struttura commento di RDoc è di grande successo, utilizzato da molti generatori di documentazione simili creati per altri linguaggi di programmazione

Cosa c'è di nuovo in questa versione:.

• RDoc in grado di produrre file di traduzione da utilizzare con gettext.

Cosa c'è di nuovo nella versione 4.2.0:

• RDoc in grado di produrre file di traduzione da utilizzare con gettext .

Cosa c'è di nuovo nella versione 4.1.0:.

• Migliorata l'accessibilità di output HTML
• Il look di RDoc è stato aggiornato.

Cosa c'è di nuovo nella versione 4.0.0:.

• Aggiunto Markdown come un formato supportato
• ri può ora mostrare pagine (README, ecc.).
• Rimosso stato globale da RDoc. RDoc :: Conservare tiene l'albero di documentazione e collega il guidatore al parser e generatore.

Cosa c'è di nuovo nella versione 3.12:

• Miglioramenti minori:
• documento Aggiunto SVILUPPATORI che contiene una panoramica di come opere rdoc e come aggiungere nuove funzionalità per RDoc.
• titolo migliorata per l'output HTML da includere --title nell'elemento titolo.
• rdoc --pipe ora capisce --markup.
• RDoc ora supporta IRC-schema di collegamenti ipertestuali.
• Correzioni di bug:
• titolo fisso su output HTML per le pagine.
• l'analisi fisso di heredoc senza rientro.
• l'analisi fisso di% w [] e altri letterali%.
• sostituzione freccia fissa in output HTML munging l'operatore navicella spaziale.
• sezioni Verbatim con ERB che corrispondono al codice rubino whitelist non sono più la sintassi evidenziata.
• terminazioni di linea su finestre sono normalizzati subito dopo la lettura con binmode.
• RDoc meglio comprendere le direttive per i commenti. direttive commento ora possono essere trovati ovunque nei commenti multilinea.
• link ordinate ai metodi mostrano ancora una volta l'etichetta.
• RDoc :: Parser :: C possono ora i commenti direttamente sopra rb_define_class_under.
• In rdoc, backspace e formattatori ansi, le etichette e le note senza corpi sono ora visualizzati.
• In rdoc, backspace e formattatori ansi, spazi bianchi tra etichetta o nota e il colon è ormai spogliato.

Cosa c'è di nuovo nella versione 3.11:

• Correzioni di bug:
• Evitare l'analisi dei file tag inclusi in gemme.

Cosa c'è di nuovo nella versione 3.9.2:

• Bug fix:
• allentato TIDYLINK espressione regolare per consentire qualsiasi contenuto nella sezione link come: & # x3c; TT & # X3e; {foo} [rdoc-ref: SomeClass] & # x3c; / tt & # X3e;
• Ai sensi delle voci di output HTML sono limitato a & # x3c; TT & # X3e; & # x3c; h6 & # X3e; & # x3c; / tt & # X3e; di nuovo.

Cosa c'è di nuovo nella versione 3.9.1:

• Correzioni di bug:
• Fix RDoc :: Parser Markup un colpo di testa, seguito da un token non di testo.
• Fix RDoc :: :: Markup ToHtmlCrossref # gen_url per i non - & # x3c; TT & # X3e; rdoc-ref & # x3c; / tt & # X3e; collegamenti.
• Fix bug report URL quando si blocca rdoc.

Cosa c'è di nuovo nella versione 3.8:

• Miglioramenti minori:
• RDoc :: Parser :: C può ora scoprire i metodi di ENV e ARGF.
• RDoc :: Parser :: C ora conosce rb_cSocket e rb_mDL.
• Correzioni di bug:
• Aggiornamento oggetto in un archivio dati ri con i nuovi dati ora rimuove metodi, include, costanti e gli alias.

Cosa c'è di nuovo nella versione 3.7:

• Miglioramenti minori:
• Nuova direttiva: Categoria: che permette di metodi per essere raggruppate in sezioni in modo più pulito. Vedere RDoc :: Markup per i dettagli.
• Documento di classe per RDoc :: Parser :: C supporta ora Foo :: CONST così come CONST.
• Metodo di uscita ri ora è un elenco separato da virgole quando visualizzato in modo interattivo.
• RDoc :: ClassModule # fondono ora preferisce le informazioni della tesi sopra del ricevitore (che ora si comporta come Hash # fondono! Invece di un ritroso Hash # merge!).
• RDoc :: Markup # convertono ora accetta un RDoc :: :: Markup esempio documento
• RDoc ora possiede il codice per la generazione di RDoc e dati RI quando gemme install
• Aggiunto RDoc :: :: RDoc ripristinare
• Aggiunto RDoc :: CodeObject # nome_file
• Correzioni di bug:
• ri non si blocca più quando si cerca di completare una pianura
• RDoc :: Parser :: Rubino non mangia contenuto quando cominciano = blocchi / = documentazione finale sono seguiti da un elemento documentabile. Issue # 41 da MFN.
• RDoc :: :: Markup Formatter e sottoclassi consentono ora un + markup opzionale + parametro per l'aggiunta di markup personalizzato. L'esempio in RDoc :: :: Markup Formatter ora funziona.
• RDoc :: Parser :: C è ora in grado di distinguere tra metodi di classe e metodi di istanza nel documento-metodo.
• RDoc ora codifica i nomi dei file con la codifica di uscita.
• generazione di dati RI per il metodo di alias non duplica la classe in #full_name