View Issue Details
| ID | Project | Category | View Status | Date Submitted | Last Update |
|---|---|---|---|---|---|
| 0003965 | Taler | wallet (WebExtension) | public | 2015-09-09 08:34 | 2019-12-26 20:37 |
| Reporter | Marcello Stanisci | Assigned To | Marcello Stanisci | Resolution deadline | |
| Implementer | Reviewer | ||||
| Release signed by | Deployed by | ||||
| Verifier | Communicator | ||||
| Data protection authority notification required | No | ||||
| CSIRT notification required | No | ||||
| Estimated effort (hours) | Actual effort (hours) | 0 | |||
| Fast-track | No | ||||
| Work package | none | ||||
| Priority | none | Severity | text | Reproducibility | have not tried |
| Status | closed | Resolution | fixed | ||
| Product Version | git (master) | ||||
| Target Version | 0.0 | ||||
| Summary | 0003965: Documenting the JavaScript | ||||
| Description | As of now, the JS uses no structured commenting style. Do we want to switch to a structured commenting style? (A quick search shows that 'JSDoc' is a choice, but there is also a JS flavour of doxygen) | ||||
| Tags | No tags attached. | ||||
| Make some cleaning like getting rid of variables names 'aSomething', extend names like 'resPub' to 'reservePub' | |
| Yes, we definitively want some structured style for comments. How is the tool support? In particular, can we get warnings generated for missing/malformed comments? | |
| http://usejsdoc.org seems easy to set up, and is doxygen-styled. | |
| commenting 90% of the code. A way to comment object and crossreference them is still needed. 'make doc' entry to Makefile needed too. | |
| http://stackoverflow.com/questions/6460604/how-to-describe-object-arguments-in-jsdoc | |
| fixed in c7d344d. 'make doc' still missing but not striclty this bug's goal | |
| Date Modified | Username | Field | Change |
|---|---|---|---|
| 2015-09-09 08:34 | Marcello Stanisci | New Issue | |
| 2015-09-09 08:34 | Marcello Stanisci | Status | new => assigned |
| 2015-09-09 08:34 | Marcello Stanisci | Assigned To | => Marcello Stanisci |
| 2015-09-19 18:38 | Christian Grothoff | Severity | trivial => text |
| 2015-10-09 20:08 | Marcello Stanisci | Note Added: 0009719 | |
| 2015-10-17 22:59 | Christian Grothoff | Note Added: 0009741 | |
| 2015-10-17 22:59 | Christian Grothoff | Target Version | => 0.0 |
| 2015-10-22 23:10 | Christian Grothoff | Product Version | => git (master) |
| 2015-12-04 15:16 | Marcello Stanisci | Note Added: 0009975 | |
| 2015-12-06 19:22 | Marcello Stanisci | Note Added: 0009979 | |
| 2015-12-06 19:39 | Marcello Stanisci | Note Added: 0009980 | |
| 2015-12-11 17:35 | Marcello Stanisci | Note Added: 0009994 | |
| 2015-12-11 17:35 | Marcello Stanisci | Status | assigned => informing |
| 2015-12-11 17:35 | Marcello Stanisci | Resolution | open => fixed |
| 2015-12-12 10:43 | Christian Grothoff | Status | informing => closed |
| 2019-12-26 20:37 | Florian Dold | Category | wallet (browser-based) => wallet (WebExtensions) |
| 2023-04-13 18:37 | Florian Dold | Category | wallet (WebExtensions) => wallet (WebExtension) |