yardoc - En ligne dans le Cloud

PROGRAMME:

Nom

yardoc - Outil Ruby pour générer de la documentation pour le langage de programmation Ruby

SYNOPSIS

yarddoc [Options] [fichiers source [- fichiers_supplémentaires]] cour dock [Options] [fichiers source [-
fichiers_supplémentaires]]

DESCRIPTION

cour(1) est un outil de génération de documentation extensible pour le langage de programmation Ruby.
Il permet à l'utilisateur de générer une documentation cohérente et utilisable qui peut être exportée vers un
nombre de formats très facilement, et prend également en charge l'extension pour les constructions Ruby personnalisées telles que
en tant que définitions de niveau de classe personnalisées.

chantier, synonyme de cour dock génère la documentation à partir de la liste des fichiers source. Si
cette liste est omise, "{lib,app}/**/*.rb ext/**/*.c" est utilisé.

Un ensemble de base d'options peut être spécifié en ajoutant un .yardopts fichier à votre chemin de base
contenant toutes les options supplémentaires séparées par des espaces.

OPTIONS

Général Options
-b, --db DOSSIER
Utilisez une base de données .yardoc spécifiée pour charger ou enregistrer vers (par défaut .yardoc)

--[no-]db unique
Si les objets de code doivent être stockés dans un seul fichier de base de données (avancé)

-n, --aucune sortie
Générez uniquement la base de données .yardoc, aucune documentation.

-c, --use-cache [DOSSIER]
Utilisez la base de données .yardoc en cache pour générer de la documentation (par défaut, aucun cache)

--pas de cache
Effacez la base de données .yardoc avant d'analyser la source.

--[no-]yard opts [DOSSIER]
Si les arguments doivent être lus à partir de FILE (par défaut à yes, FILE par défaut à .yardopts)

--[no-]document
Si les arguments doivent être lus à partir du fichier .document (par défaut, oui)

--pas de sauvegarde
Ne pas enregistrer les données analysées dans la base de données yardoc

--exclure REGEXP
Ignore un fichier s'il correspond à une correspondance de chemin (regexp)

Sortie Options
--un-fichier
Génère une sortie sous forme de fichier unique

--liste
Lister les objets sur la sortie standard (implique -n)

--pas de public
Ne pas afficher les méthodes publiques. (par défaut, affiche public)

--protégé
Afficher les méthodes protégées. (cache par défaut protégé)

--privé
Afficher les méthodes privées. (par défaut masque privé)

--non-privé
Masquer les objets avec la balise @private

--[non-]API API
Génère de la documentation pour une API donnée (objets qui définissent la balise @api correcte).
If --pas d'API est donné, affiche les objets sans balise @api.

--embed-mixins
Intègre les méthodes mixin dans la documentation de classe

--embed-mixine [MODULE]
Intègre les méthodes mixin d'un module particulier dans la documentation de classe

--pas de surbrillance
Ne mettez pas en surbrillance les blocs de code dans la sortie.

--retour par défaut TYPE
Affiché si la méthode n'a pas de type de retour. (par défaut sur 'Objet')

--hide-void-retour
Masque les types de retour spécifiés comme « void ». (la valeur par défaut est affichée)

--mettre en doute QUERY
Afficher uniquement les objets qui correspondent à une requête spécifique

--Titre TITRE
Ajouter un titre spécifique aux documents HTML

-r, --lisezmoi, --principale DOSSIER
Le fichier readme utilisé comme page de titre de la documentation.

--des dossiers FICHIER1,FICHIER2...
Tous les fichiers statiques supplémentaires séparés par des virgules à inclure (par exemple, FAQ)

--actif De[:À]
Un fichier ou un répertoire à copier dans le répertoire de sortie après la génération

-o, --rép-sortie PATH
Le répertoire de sortie. (par défaut à ./doc)

-m, --balisage MARQUAGE
Style de balisage utilisé dans la documentation, comme textile, markdown ou rdoc (par défaut, rdoc).

-M MARKUP_PROVIDER
Remplace la bibliothèque utilisée pour traiter le balisage

--markup-fournisseur
formatage (précisez le nom de la gemme)

--jeu de caractères ENC
Jeu de caractères à utiliser lors de l'analyse des fichiers (par défaut, les paramètres régionaux du système)

-t, --modèle MODÈLE
Le modèle à utiliser. (la valeur par défaut est "par défaut")

-p, --modèle-chemin PATH
Le chemin du modèle dans lequel rechercher les modèles (utilisé avec -t).

-f, --format Format
Le format de sortie du modèle (par défaut, html).

--pas de statistiques
Ne pas imprimer les statistiques

--lieu LIEU
La locale pour la documentation générée (par défaut en).

--po-répertoire DIR
Le répertoire contenant les fichiers .po (par défaut #{YARD::Registry.po_dir}).

Jour options:
(TAG:TITRE ressemble à: 'surcharge:Surchargé Méthode')

--étiqueter TAG:TITRE
Enregistre un nouveau @tag de métadonnées de forme libre

--type-balise TAG:TITRE
Balise avec un champ de types facultatif

--type-name-tag TAG:TITRE
Balise avec des types facultatifs et un champ de nom

--nom-étiquette TAG:TITRE
Balise avec un champ de nom

--étiquette-titre TAG:TITRE
Balise avec la première ligne comme champ de titre

--hide-tag TAG
Masque une balise précédemment définie dans les modèles

--balise-transitive TAG
Marque une balise comme transitive

--balise-non-transitive TAG
Marque une balise comme non transitive

Autres options:
-e, --charge DOSSIER
Un script Ruby à charger avant d'exécuter la commande.

--brancher BRANCHER
Chargez un plugin YARD (gemme avec le préfixe 'yard-')

--héritage
Utilisez l'ancien analyseur et les gestionnaires Ruby. Toujours allumé en 1.8.x.

--en sécurité
Activer le mode sans échec pour cette instance

-q, --silencieux
N'affiche aucun avertissement.

--verbeux
Afficher plus d'informations.

--déboguer
Afficher les informations de débogage.

--trace
Afficher les traces de la pile

-v, --version
Afficher la version.

-h, --Aidez-moi
Montrez cette aide.

EXEMPLES

chantier -o "documentation/" - "FAQ" "LICENCE"

L'exemple ci-dessus affiche la documentation des fichiers dans "lib/**/*.rb" vers "documentation/"
y compris les fichiers supplémentaires "FAQ" et "LICENCE".

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