View Issue Details
ID | Project | Category | View Status | Date Submitted | Last Update |
---|---|---|---|---|---|
0000082 | JEDI VCL | 01 Help | public | 2002-03-22 14:40 | 2002-06-05 09:24 |
Reporter | igivanov | Assigned To | user81 | ||
Priority | normal | Severity | major | Reproducibility | sometimes |
Status | closed | Resolution | suspended | ||
Product Version | |||||
Target Version | Fixed in Version | ||||
Summary | 0000082: Some entries in help file are completely undocumented | ||||
Description | Suggestions: (a) donations should be accepted only when there is at least a brief description of what each component or function is meant for. There could be one description for a group of functions/components, but it must exist. If e.g. there are 100 items and 10 of them are described, it must be explicitly made clear that the rest 90 are helper functions/classes not designed for direct use. (b) donations should make it to an official release after each entry in the help for the donation is documented. It can even be a simple "See [reference to another part of the help file]" thing, or a statement that this is an internally used class or function, but not an empty space. Undocumented entries must be excluded from help build. | ||||
Tags | No tags attached. | ||||