rdoc, darkfish, e il: call-seq: tag

Question

Sono in procinto di documentare un progetto rubino con rdoc, e ho scoperto il formattatore rdoc darkfish. Mi piace molto, ma il tag :call-seq: non funziona più. Invece, mette il letterale :call-seq: stringa nella documentazione e poi formatta la sequenza di chiamata in sé come un blocco di codice. Non voglio prendere solo tutti i: call-seq: blocchi di fuori del mio codice, dal momento che gran parte del mio esigenze di documentazione per riferirsi a nomi di istanza e nomi dei parametri indicati nel blocco :call-seq:. Qualcun altro ha avuto questo problema? Cosa devo fare, e c'è una soluzione? Sono abbastanza sicuro che il tag :call-seq: lavoravo prima, quando ero utilizzando il formattatore predefinito, ma non posso essere sicuro perché io non riesco a capire come tornare a generare il formato originale (rdoc chiamando senza argomenti tranne i file genera output darkfish ora, anche se si elimina la cartella doc!) qualcuno sa come risolvere questo problema?

Answer 1

consiglio vivamente passando da rdoc a YARD . Non supporta il vecchio call-ss in sé, ma invece ha tag e in particolare il @ sovraccarico tag superiormente sostituirà call-ss. Tutta la documentazione sul rubydoc.info viene anche generato utilizzando YARD.

Ecco l'esempio per @overload dalla documentazione 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