documentation

34calore

5risposta

Spring REST API Documentation using Swagger

Sto cercando uno strumento che possa aiutarmi a generare documentazione API RESTful. Il mio server è scritto in Java e utilizza il framework Spring MVC. Non ho VISTE nel mio server. È un servizio REST

spring api rest documentation swagger 2012-02-08

---

77calore

7risposta

Come documentare un metodo con i parametri?

Come documentare metodi con parametri usando le stringhe di documentazione di Python? EDIT: PEP 257 dà questo esempio: def complex(real=0.0, imag=0.0): """Form a complex number. Keyword arg

python documentation documentation-generation 2012-02-08

---

13calore

2risposta

Generazione documentazione Javascript

Sto cercando di documentare il codice javascript che sviluppiamo e stiamo cercando alcuni buoni generatori di documentazione javascript, qualcuno ha qualche suggerimento? Abbiamo usato ndoc per creare

javascript documentation 2012-02-13

---

39calore

2risposta

Quando si documenta in Roxygen: Come posso creare un elenco dettagliato in @details?

Qual è la sintassi appropriata per aggiungere un elenco dettagliato a roxygen2, ad esempio, nella sezione @dettagli? Posso creare un ambiente di lista di lattice? sembra che le interruzioni di linea v

r documentation roxygen 2012-02-13

---

6calore

1risposta

Doxygen e aggiunta di un valore di un attributo alla documentazione di output

ServiceStack contrassegna i percorsi di riposo per i servizi Web utilizzando gli attributi C#. Per esempio [RestService("/hello1")] [RestService("/hello2")] public class Hello vorrei fare Doxygen

c# documentation doxygen servicestack 2012-02-15

---

22calore

2risposta

XCode Command Line 4.3 Strumenti

Apple ha recentemente rilasciato Command Line Tools: Quali sono gli strumenti forniti nel pacchetto di strumenti di riga di comando? Esiste una documentazione diversa dalle pagine man? Si noti che ho

xcode command-line documentation 2012-02-18

---

12calore

1risposta

Come riferimento incrociato un'equazione in un file di aiuto R/roxygen2

Sono in procinto di documentare alcune delle mie funzioni per un pacchetto R che sto facendo. Uso il markup del roxygen, sebbene ciò sia in gran parte irrilevante per la mia domanda. Ho messo equazion

r documentation roxygen roxygen2 2012-02-21

---

8calore

2risposta

Docstrings - una riga o più righe

Aggiungo della documentazione (epydoc) a un pacchetto che ho scritto e mi sono imbattuto in molti casi in cui mi sto ripetendo una moltitudine di volte. def script_running(self, script): """Retur

python documentation docstring 2012-02-22

---

15calore

2risposta

Quali file devo dire al mio VCS di ignorare quando si utilizza Sphinx per la documentazione?

Voglio iniziare a utilizzare Sphinx per documentare il mio progetto. Ho detto a Sphinx di usare fonti separate e creare directory durante lo sphinx-quickstart. Ora il mio layout della directory è la s

python git version-control documentation python-sphinx 2012-03-05

---

10calore

3risposta

Documentazione di Doctrine per 1.2

Qualcuno capisce cosa è successo a Doctrine docs per 1.x? Passando attraverso il loro official documentation page (necessario scorrere verso il basso a 1.2), e facendo clic su uno qualsiasi dei colleg

orm documentation doctrine doctrine-1.2 2012-03-09

---