RDoc

RDoc est composé de deux parties principales.

L'un est rdoc , un utilitaire pour générer des documents HTML. La seconde est ri , un outil pour créer la documentation pour l'interface de ligne de commande Ruby.

Pour pouvoir utiliser correctement RDoc, le développeur doit changer la façon dont il ajoute des commentaires à son code source.

RDoc utilise une source spécifique des commentaires de code la structure, de sorte qu'ils peuvent être facilement extrait et aider à remplir le site de documentation.

commentaire la structure de RDoc est un très grand succès, utilisé par de nombreux générateurs de documentation similaires créés pour d'autres langages de programmation

Ce qui est nouveau dans cette version:.

• RDoc peut maintenant produire des fichiers de traduction pour une utilisation avec gettext.

Ce qui est nouveau dans la version 4.2.0:

• RDoc peut maintenant produire des fichiers de traduction pour une utilisation avec gettext .

Ce qui est nouveau dans la version 4.1.0:.

• Amélioration de l'accessibilité de la production HTML
• Le regard de RDoc a été mis à jour.

Ce qui est nouveau dans la version 4.0.0:.

• Ajout Markdown comme un format pris en charge
• ri peut maintenant afficher les pages (README, etc.).
• état global retiré de RDoc. RDoc :: Magasin détient l'arbre de documentation et relie le conducteur à les parseurs et le générateur.

Ce qui est nouveau dans la version 3.12:

• Améliorations mineures:
• Document Ajouté DÉVELOPPEURS qui contient un aperçu de la façon dont les travaux de rdoc et comment ajouter de nouvelles fonctionnalités à RDoc.
• Amélioration de titre pour la sortie HTML pour inclure --title dans l'élément de titre.
• rdoc --pipe comprend maintenant --markup.
• RDoc supporte maintenant irc-système des hyperliens.
• Correction de bugs:
• Titre fixe sur la sortie HTML pour les pages.
• parsing fixe de heredoc non dentelée.
• analyse fixe de% p [] et d'autres littéraux%.
• remplacement de la flèche fixe en sortie HTML munging l'opérateur de vaisseau spatial.
• sections Verbatim avec ERB qui correspondent au code de rubis whitelist ne sont plus mis en évidence la syntaxe.
• Les fins de ligne sur les fenêtres sont normalisées immédiatement après la lecture avec binmode.
• RDoc comprend mieux les directives pour commentaires. Commentaire directives peuvent maintenant être trouvés partout dans les commentaires multi-lignes.
• Liens Tidy aux méthodes montrer l'étiquette à nouveau.
• RDoc :: Parser :: C peut maintenant trouver des commentaires directement au-dessus rb_define_class_under.
• Dans rdoc, backspace et formatteurs ansi, étiquettes et notes sans corps sont maintenant affichés.
• Dans rdoc, backspace et formatteurs ansi, espace entre l'étiquette ou la note et le côlon est maintenant dépouillé.

Ce qui est nouveau dans la version 3.11:

• Correction de bugs:
• Évitez analyse de fichiers TAGS inclus dans les pierres précieuses.

Ce qui est nouveau dans la version 3.9.2:

• Bug fix:
• desserré TIDYLINK regexp pour permettre à tout le contenu dans la section de lien comme: & # x3C; tt & # X3e; {foo} [rdoc-ref: SomeClass] & # x3C; / tt & # X3e;
• En-têtes de sortie HTML sont plafonnés à & # x3C; tt & # X3e; & # x3C; h6 & # X3e; & # x3C; / tt & # X3e; à nouveau.

Ce qui est nouveau dans la version 3.9.1:

• Correction de bugs:
• Fix RDoc :: parser Markup pour un en-tête suivi d'un jeton non-texte.
• Fix RDoc :: Markup :: ToHtmlCrossref # gen_url pour non - & # x3C; tt & # X3e; rdoc-ref & # x3C; / tt & # X3e; liens.
• rapport de bogue Fix URL lorsque les accidents de rdoc.

Ce qui est nouveau dans la version 3.8:

• Améliorations mineures:
• RDoc :: Parser :: C peut maintenant découvrir des méthodes sur ENV et ARGF.
• RDoc :: Parser :: C connaît maintenant rb_cSocket et rb_mDL.
• Correction de bugs:
• Mise à jour de l'objet dans un magasin de données ri avec de nouvelles données supprime maintenant les méthodes, les comprend, les constantes et les alias.

Ce qui est nouveau dans la version 3.7:

• Améliorations mineures:
• Nouvelle directive: catégorie: ce qui permet des méthodes pour être regroupées en sections plus proprement. Voir RDoc :: Markup pour plus de détails.
• Document classe pour RDoc :: Parser :: C supporte maintenant Foo :: CONST ainsi que CONST.
• méthode ri sortie est maintenant une liste séparée par des virgules lorsqu'elles sont affichées de manière interactive.
• RDoc :: ClassModule # fusionne maintenant préfère l'information de l'argument sur ce récepteur (il se comporte maintenant comme Hash # fusionnent! Au lieu d'un arrière Hash # fusion!).
• RDoc :: Markup # convertit maintenant accepte un RDoc :: L'instance de document de balisage
• RDoc possède maintenant le code pour générer RDoc et des données ri quand gemmes installer
• Ajout RDoc :: RDoc :: reset
• RDoc Ajouté :: CodeObject # nom_fichier
• Correction de bugs:
• ri ne plante plus lors d'une tentative de remplir un simple
• RDoc :: Parser Ruby ne mange plus de contenu lorsque = commencent blocs / = documentation de fin sont suivis par un élément documentable. Problème n ° 41 par NPF.
• RDoc :: Markup :: Formatteur et sous-classes permettent maintenant + balisage option + paramètre pour ajouter un balisage personnalisé. L'exemple de RDoc :: Markup :: Formatter va maintenant travailler.
• RDoc :: Parser de la C peut maintenant distinguer les méthodes de classe et les méthodes d'instance dans le document-méthode.
• RDoc code maintenant les noms de fichiers dans le codage de sortie.
• génération de données de ri pour la méthode alias ne duplique plus la classe dans #full_name