Link copiato negli appunti
Molti aspetti possono essere gestiti utilizzando le opzioni del tool rdoc, ecco le principali:
- --diagram, -d viene generato un semplice diagramma che mostra i moduli e le classi
- --inline-source, -S il codice sorgente dei moduli viene mostrato inline invece che attraverso i pop-up
- --line-numbers, -N viene mostrato il numero di linea nei sorgenti
- --one-file, -1 tutto l'output viene inserito in un unico file
- --fmt, -f format name imposta il tipo di file generato, è possibile produrre file HTML, XML e CHM
l'elenco completo delle opzioni è visualizzabile chiamando rdoc con l'opzione --help. RDoc è capace di generare anche documentazione leggibile dal tool ri utilizzando le seguenti opzioni
- --ri, -r viene generata documentazione, leggibile da ri, che viene salvata nella directory .rdoc nella directory home a meno che non venga indicato un altro percorso con l'opzione --op oppure -o.
- --ri-site, -R i file generati vengono salvati in una directory globale, ad esempio /usr/share/ri/1.8/site/ rendendoli accessibili a tutti gli utenti.
- --ri-system, -Y i file generati vengono salvati in una directory di sistema, ad esempio /usr/share/ri/1.8/system/; opzione da utilizzare in fase di installazione.
Ad esempio:
$ rdoc --ri veicolo.rb
veicolo.rb: c..c.c.
Generating RI...
Files: 1
Classes: 3
Modules: 0
Methods: 4
Elapsed: 0.181s
$ ls .rdoc/
Camion/ CarroArmato/ created.rid Veicolo/
$ ri Veicolo#rifornimento
--------------------------------------------------- Veicolo#rifornimento
rifornimento(quantita)
------------------------------------------------------------------------
rifornisce il veicolo di carburante
Perfetto, tutto funziona come deve.