rdoc

10calore

2risposta

Come documentare un'applicazione di rotaia?

Ho appena iniziato a documentare un'applicazione di rotaie. So che questo è in realtà fatto da rdoc, quindi ho seguito alcune guide rdoc riguardo la sintassi e così via, ma mi sono bloccato quando ho

5calore

3risposta

Posso ottenere il mio README.textile nel mio RDoc con una formattazione corretta?

Mi piace usare Textile o Markdown per scrivere file readme per i miei progetti, ma quando genero l'RDoc il file readme viene interpretato come RDoc e sembra davvero orribile. C'è un modo per far funzi

70calore

2risposta

Esiste un riferimento valido e valido per la corretta sintassi RDoc?

Sto cercando un riferimento valido e solido per la corretta sintassi RDoc. Raccomandazioni? Non riesco a trovare nulla che mostra chiaramente: Come documentare i metodi della classe e dei relativi par

14calore

2risposta

Come ricostruire rdoc per tutte le gemme installate?

Ho diverse gemme installate in più posizioni. Qual è il modo più difficile/facile da generare/rigenerare: rdoc per tutte queste gemme installati, tutto in una volta? yardoc per tutte queste gemme inst

12calore

9risposta

Come posso generare RDOC per (tutti) i binari?

posso fare sudo gem rdoc activerecord --no-ri e sudo gem rdoc actionpack --no-ri entrambi i quali mi danno buona documentazione. Ma sudo gem rdoc rails --no-ri mi dà praticamente nulla, come la

5calore

1risposta

Problemi di installazione di rdoc, irb, bluecloth, cronica su fedora 12

Cosa significano questi errori? [[email protected] config]# gem install bluecloth Building native extensions. This could take a while... ERROR: Error installing bluecloth: ERROR: Failed to buil

32calore

3risposta

Qual è la differenza tra ri e rdoc

Ogni volta che installo gems, vedo ri e rdoc follow. So che questa è documentazione ma qual è la differenza tra i due e come usarli?

15calore

2risposta

Perché è necessaria la sintassi ": nodoc:"?

sembra un sacco di librerie/plugins utilizzare questa sintassi: def self.included(base) # :nodoc: base.extend ClassMethods end Perché è la parte :nodoc: necessaria?

27calore

1risposta

yard e collegamenti a classi/moduli nel documento

Attualmente sto passando da rdoc a yard per la mia documentazione del software ruby. Nel mio documento ho spesso riferimento alcune classi/moduli dai commenti, per esempio: ## == Provides various util

27calore

1risposta

Perché il mio strumento Ruby 'ri' non restituisce risultati nel prompt dei comandi?

Eventuali duplicati: ruby 1.9 ri problem Quando provo ad utilizzare lo strumento di Ruby ri in una finestra del prompt dei comandi per ottenere aiuto sulle classi, metodi, ecc sembra non riuscire semp