Opened 17 years ago
Closed 11 years ago
#252 closed defect (fixed)
common/bitstream.h could do with documentation comments
| Reported by: | Richard Boulton | Owned by: | Olly Betts |
|---|---|---|---|
| Priority: | lowest | Milestone: | 1.3.2 |
| Component: | Documentation | Version: | |
| Severity: | minor | Keywords: | |
| Cc: | Blocked By: | ||
| Blocking: | Operating System: | All |
Description
bitstream.h has no documentation comments at present. It could do with some.
Change History (6)
comment:1 by , 17 years ago
| Milestone: | 1.1.0 → 1.1.1 |
|---|---|
| Priority: | normal → lowest |
| Severity: | normal → minor |
comment:2 by , 16 years ago
| Milestone: | 1.1.1 → 1.1.7 |
|---|
comment:4 by , 14 years ago
| Milestone: | 1.2.x |
|---|---|
| Resolution: | → invalid |
| Status: | new → closed |
I don't think it's useful to keep a ticket open for this - as I noted in comment:1, this certainly isn't the only case where we're missing comments, and opening tickets for all of them would just make it much harder to see what's what in trac. So I've added a new section to MissingDocumentation and am closing this ticket (as "invalid", which seems the closest to "shouldn't be tracked as a ticket"...)
comment:5 by , 11 years ago
| Resolution: | invalid |
|---|---|
| Status: | closed → reopened |
comment:6 by , 11 years ago
| Component: | Other → Documentation |
|---|---|
| Milestone: | → 1.3.2 |
| Resolution: | → fixed |
| Status: | reopened → closed |
Documented in trunk r17867.
Note:
See TracTickets
for help on using tickets.
While it would be nice to have doc comments for every internal class and function, the reality is that many currently don't, and I don't think it's sane to single this class out as a blocker for 1.1.0 (this isn't a new class - it was added in 0.9.1, nearly 3 years ago).