documentation

7Ciepło

1Odpowiedz

Czy istnieje uzgodniony styl diagramu UML do dokumentowania lub ilustrowania roli kontenerów (Docker) w specyfikacji architektury systemu?

Planuję narysować niektóre schematy struktur UML, które ilustrują miejsce obrazów Docker (lub kontenerów, w diagramach wdrażania) w ogólnej strukturze oprogramowania, które projektuję. Jestem zaintere

docker architecture uml documentation distributed-computing 2016-07-08

---

12Ciepło

2Odpowiedz

VSCode: Jak dokumentować obietnicę rozwiązującą złożony obiekt?

Mam funkcję f, która zwraca Promise. Zwrócony Promise albo albo albo . Próbowałem następującą składnię (jak wspomniano w an issue in JSDoc) w VSCode, ale to nie działa: /** * @promise fPromise * @re

documentation visual-studio-code jsdoc 2017-08-10

---

7Ciepło

1Odpowiedz

Jak przekonwertować adnotację Java Swagger na schemat json Swagger?

Jak wygenerować plik JSON z plików Java zawierających adnotacje typu Swagger, aby Swagger-UI mógł go odczytać.

java documentation swagger swagger-ui springfox 2016-02-22

---

6Ciepło

1Odpowiedz

Jak wyświetlić dokumentację interfejsu API w narzędziach QtCreator?

Qt Creator zapewnia podpowiedzi dla wbudowanych funkcji Qt, tak: Dodałem jakąś dokumentację do własnej funkcji tak: /** * @brief serialize Writes the passed field definition set to the specifie

qt documentation qt-creator 2016-09-10

---

5Ciepło

1Odpowiedz

Dokumentacja API dla biblioteki yaml-cpp

Postanowiłem użyć biblioteki yaml-cpp v0.3 do przeanalizowania pliku konfiguracyjnego dla demona FOSS, który utrzymuję. Zdecydowałem się przenieść do nowego 0.5 API, ale moim największym problemem jes

c++ api parsing documentation yaml 2016-04-15

---

6Ciepło

1Odpowiedz

Czy istnieje sposób na lint pliku Python, aby sprawdzić przestrzeganie stylu dokumentacji Numpy?

Pracuję nad projektem, który wymaga dokumentacji Numpy. W moich dniach Java pamiętam o lintersach, które sprawdzały zgodność Javadoc w Eclipse/IDEA; czy istnieje odpowiednik, który sprawdza przestrzeg

python documentation numpydoc 2017-02-08

---

6Ciepło

1Odpowiedz

KDoc: Wstaw fragment kodu

Jak wstawić fragment kodu do KDoc, domyślnego narzędzia dokumentacji Kotlin? W Javie można użyć następujących: /** * Example usage: * * <pre> * <code>@JavaAnnotation * public void foo() { *

documentation kotlin kdoc 2016-11-03

---

30Ciepło

6Odpowiedz

Jak wygenerować dokumentację JavaScript API dla GitHub Pages

Istnieje wiele wspaniałych opcji generowania dokumentacji API dla innych języków, ale muszę jeszcze znaleźć rozwiązanie dla mojego JavaScript API, które chcę hostować na stronach GitHub. Wygląda na to

javascript documentation jekyll github-pages jsdoc 2016-03-04

---

8Ciepło

1Odpowiedz

Funkcja wykluczająca z instrukcji obsługi pakietu R

Piszę pakiet R, a ja dokumentuję wszystkie moje funkcje z roxygen2. Jednak nie chcę, aby wszystkie funkcje pojawiały się w instrukcji pakietu. Jak mogę określić, które funkcje powinny pojawiać się w p

r documentation package roxygen2 2016-03-04

---

9Ciepło

2Odpowiedz

Czy możliwe jest udokumentowanie obiektu javascript za pomocą ESDOC?

Wygląda na to, że ESDOC działa tylko w stylu klasy ES6. Czy istnieje sposób, aby udokumentować zwykły przedmiot jak: /** * ??? */ var Foo = { /** * ??? */ info: true }; expor

javascript documentation esdoc 2016-12-29

---