rdoc, darkfish, et: appel suivants: tag

Question

Je suis en train de documenter un projet Ruby avec rdoc, et j'ai découvert le formatter darkfish RDoc. Je aime vraiment, mais la balise :call-seq: ne fonctionne plus. Au lieu de cela, il met la :call-seq: chaîne littérale dans la documentation et formate la séquence d'appel lui-même comme un bloc de code. Je ne veux pas simplement prendre tous les: appel suivants: blocs de mon code, car une grande partie de mes besoins de documentation pour faire référence aux noms d'instance et les noms des paramètres donnés dans le bloc :call-seq:. Quelqu'un d'autre a-t-il eu ce problème? Que dois-je faire, et est-il une solution? Je suis assez sûr que la balise :call-seq: travaillais avant quand j'utilisais le formatter par défaut, mais je ne peux pas être sûr parce que je ne peux pas comprendre comment revenir à générer le format d'origine (appelant rdoc sans arguments à l'exception des fichiers génère la sortie darkfish maintenant, même si je supprime le dossier doc!) Est-ce que quelqu'un sait comment résoudre ce problème?

Answer 1

Je recommande vivement passer de rdoc YARD. Il ne prend pas en charge l'ancien appel suivants lui-même, mais il a des balises et surtout le balise @ surcharge va remplacer supérieurement appel suivants. Toute la documentation sur rubydoc.info est également générée à l'aide YARD.

Voici l'exemple pour @overload de la documentation YARD:

# @overload set(key, value)
#   Sets a value on key
#   @param [Symbol] key describe key param
#   @param [Object] value describe value param
# @overload set(value)
#   Sets a value on the default key `:foo`
#   @param [Object] value describe value param
def set(*args)
end