rdoc3.2

rdoc3.2

# Lance rdoc sur tous les fichiers Ruby du répertoire courant et ses sous-dossiers
rdoc3.2

# Génère la documentation en utilisant le format HTML par défaut pour un fichier spécifique
rdoc3.2 mon_fichier.rb

# Traite plusieurs fichiers sources différents à la fois
rdoc3.2 moduleA.rb scriptB.rb utilitaireC.rb

# Lance rdoc sur tous les fichiers d'un répertoire donné (traversal de dossier)
rdoc3.2 /chemin/vers/mon/module

# Génère un fichier .pot pour la localisation (format pot)
rdoc3.2 --formatter=pot

# Crée des fichiers de données 'ri' utilisables par d'autres outils
rdoc3.2 --formatter=ri

# Utilise le générateur HTML spécifique darkfish
rdoc3.2 --formatter=darkfish

# Définit l'option pour afficher les hashes dans les liens (via variable d'environnement)
export RDOCOPT="--show-hash"
rdoc3.2 # Lance après avoir défini l'option

# Réinitialise la variable d'environnement des options rdoc
unset RDOCOPT

# Force le traitement de tous les fichiers, même s'il n'y a pas de noms spécifiés (comportement par défaut)
rdoc3.2 --all-files

# Traite un fichier en utilisant une option spécifique au formatage
rdoc3.2 mon_fichier.rb --option=verbose

# Simule le traitement d'un fichier ChangeLog pour la documentation
rdoc3.2 chemin/vers/ChangeLog

# Lance rdoc sur un répertoire et spécifie explicitement l'exclusion de certains fichiers
rdoc3.2 --exclude "test/*.rb" /src

# Combine plusieurs options en une seule exécution (ex: format + option)
rdoc3.2 --formatter=darkfish --option=strict

# Vérifie la syntaxe et les options disponibles pour rdoc (si supporté par l'outil)
rdoc3.2 --help

# Traite un dossier de manière récursive en utilisant le formatter 'ri'
rdoc3.2 /chemin/source --formatter=ri

# Lance rdoc sur des fichiers spécifiques tout en ignorant les erreurs potentielles
rdoc3.2 mon_fichier.rb --ignore-errors