jsdoc3

17Ciepło

1Odpowiedz

JSDoc właściwy sposób udokumentować socket.on ('zdarzenie', function() {}) i trasy obsługi

Jak udokumentować za pomocą API JSDoc który następującą postać (pojedynczy plik) // api.js exports.addSocketEvents = function(socket) { /** * This will do that and ... * @param {Objec

javascript node.js comments jsdoc jsdoc3 2015-10-10

---

5Ciepło

1Odpowiedz

Dokumentacja wtyczki jQuery z JSDoc

Zastanawiam się, jak dokumentować wtyczkę jQuery za pomocą JSDoc? Mój kod to: /** * The default configurations of comments * @typedef {Object} CommentConfig ... */ /** *

javascript jquery jsdoc jsdoc3 2014-07-23

---

63Ciepło

2Odpowiedz

JSDoc: Zwróć obiekt struktury

Jak mogę powiedzieć JSDoc o strukturze zwróconego obiektu. Znalazłem składnię @return {{field1: type, field2: type, ...}} description i próbowała go: /** * Returns a coordinate from a given mouse or

javascript documentation-generation jsdoc code-documentation jsdoc3 2015-02-27

---

9Ciepło

1Odpowiedz

AMD + Backbone + JSDoc3 najlepszy sposób na dokumentację

Szukam najlepszego sposobu na udokumentowanie mojego kodu, ale niczego nie znajduję. Widziałem inne tematy, w tym this, ale tam wszystko nie rozwiązuje mojego problemu. mam coś takiego: define([

javascript backbone.js amd jsdoc3 2015-11-06

---

9Ciepło

2Odpowiedz

JSDocs: Dokumentowanie tras ekspresowych Node.js

Próbuję dokumentować połączenia router.get z JSDocs. Nie mogę uzyskać dokumentacji, która będzie poprawnie wyświetlana na stronie, jeśli spróbuję dołączyć ją do samego routera. /** * Health check *

node.js jsdoc jsdoc3 2015-08-04

---