rdoc - En ligne dans le Cloud

PROGRAMME:

Nom

rdoc2.3 - Générer de la documentation à partir des fichiers de script Ruby

SYNOPSIS

rdoc2.3 [options] [noms...]

DESCRIPTION

Les fichiers sont analysés et les informations qu'ils contiennent collectées, avant toute sortie
produit. Cela permet de résoudre les références croisées entre tous les fichiers. Si un nom est un
répertoire, il est parcouru. Si aucun nom n'est spécifié, tous les fichiers Ruby dans le
répertoire (et sous-répertoires) sont traités.

Formateurs de sortie disponibles : chm, html, ri, xml

Pour plus d'informations sur la destination de la sortie, utilisez :
rdoc --help-sortie

OPTIONS

--accesseur, -A nom_accessoire[,..]
liste séparée par des virgules de méthodes de classe supplémentaires qui doivent être traitées comme
'attr_reader' et amis. L'option peut être répétée. Chaque accessorname peut avoir
'=texte' ajouté, auquel cas ce texte apparaît là où le r/w/rw apparaît pour
accesseurs normaux.

--tous, -a
inclure toutes les méthodes (pas seulement publiques) dans la sortie.

--jeu de caractères, -c jeu de caractères
spécifie le jeu de caractères HTML

--déboguer, -D
affiche beaucoup sur des trucs internes

--diagramme, -d
générer des diagrammes montrant des modules et des classes. Vous avez besoin de dot V1.8.6 ou version ultérieure pour utiliser
l'option --diagram correctement. Dot est disponible à partir de
<URL :http://www.research.att.com/sw/tools/graphviz/>.

--exclure, -x modèle
ne traitez pas les fichiers ou répertoires correspondant au modèle. Les fichiers donnés explicitement sur le
la ligne de commande ne sera jamais exclue.

--extension, -E nouvelle = et les sites anciens
traiter les fichiers se terminant par .new comme s'ils se terminaient par .old. L'utilisation de '-E cgi=rb'
provoquer l'analyse de xxx.cgi en tant que fichier Ruby

--boîtes de fichiers, -F
les classes sont placées dans des boîtes qui représentent les fichiers, où résident ces classes.
Les classes partagées entre plusieurs fichiers sont affichées avec la liste des fichiers partagés
eux. Rejeté en silence si --diagram n'est pas donné Experimental.

--fmt, -f nom du format
définir le formateur de sortie (voir ci-dessous).

--aider, -h
utilisation de l'impression.

--help-sortie, -O
expliquer les différentes options de sortie.

--format d'image, -I gif|png|jpg|jpeg
définit le format d'image de sortie pour les diagrammes. Peut être png, gif, jpeg, jpg. Si cette option
est omis, png est utilisé. Nécessite --diagram.

--comprendre, -i rép[,rép...]
définir (ou ajouter à) la liste des répertoires à rechercher en satisfaisant :include :
demandes. Peut être utilisé plus d'une fois.

--source-en-ligne, -S
afficher le code source de la méthode en ligne, plutôt que via un lien contextuel.

--ligne-numéros, -N
inclure les numéros de ligne dans le code source

--principale, -m prénom
name sera la première page affichée.

--fusionner, -M
lors de la création de la sortie ri, fusionner les classes traitées dans les classes précédemment documentées
du nom nom.

--un-fichier, -1
mettre toute la sortie dans un seul fichier.

--op, -o dir
définir le répertoire de sortie.

--nom_op, -n prénom
définir le nom de la sortie. N'a aucun effet pour le HTML.

-- promiscuité, -p
Lors de la documentation d'un fichier qui contient un module ou une classe également défini dans d'autres
fichiers, affichez tous les éléments de ce module/classe dans chaque page de fichiers. Par défaut, seulement
afficher les éléments définis dans ce fichier particulier.

--calmer, -q
ne montre pas de progrès pendant l'analyse.

--ri, -r
générer une sortie à utiliser par 'ri.' Les fichiers sont stockés dans le répertoire '.rdoc'
sous votre répertoire personnel à moins qu'il ne soit remplacé par un paramètre --op ultérieur, donc non
des privilèges spéciaux sont nécessaires.

--ri-site, -R
générer une sortie à utiliser par 'ri.' Les fichiers sont stockés dans un répertoire à l'échelle du site,
les rendant accessibles aux autres, des privilèges spéciaux sont donc nécessaires.

--ri-système, -Y
générer une sortie à utiliser par 'ri.' Les fichiers sont stockés dans un répertoire au niveau du système,
les rendant accessibles aux autres, des privilèges spéciaux sont donc nécessaires. Cette option est
destiné à être utilisé lors des installations Ruby.

--show-hachage, -H
un nom de la forme #nom dans un commentaire est un lien hypertexte possible vers une méthode d'instance
Nom. Lorsqu'il est affiché, le '#' est supprimé à moins que cette option ne soit spécifiée.

--style, -s URL de feuille de style
spécifie l'URL d'une feuille de style distincte.

--tab-largeur, -w n
définir la largeur des caractères de tabulation (par défaut 8).

--modèle, -T nom-modèle
définir le modèle utilisé lors de la génération de la sortie.

--Titre, -t texte
définir le texte comme titre pour la sortie.

--version, -v
afficher la version de RDoc.

--webcvs, -W url
spécifiez une URL pour un lien vers une interface Web vers CVS. Si l'URL contient un contient un
'%s', le nom du fichier lui sera ajouté.

Juillet 2023 RDOC2.3(1)

Utiliser rdoc en ligne à l'aide des services onworks.net