ETSI's Bug Tracker - Part 10: TTCN-3 documentation tags
View Issue Details

ID | Project | Category | View Status | Date Submitted | Last Update
0002817 | Part 10: TTCN-3 documentation tags | Technical | public | 01-02-2008 15:27 | 14-07-2008 14:17

Reporter | Stephan Schulz |
Assigned To | Gyorgy Rethy |
Priority | normal | Severity | minor | Reproducibility | N/A
Status | closed | Resolution | fixed |
Platform |  | OS |  | OS Version |
Product Version | v3.2.1 (published 2007-02) |
Target Version | v3.4.1 (published 2008-09) | Fixed in Version | v3.4.1 (published 2008-09) |
Source (company - Author) | Stephan Schulz - ETSI

Summary | 0002817: Unclear handling of whitespace in documentation blocks between tag and identifier

Description

Section 5.2 of this standard discusses how the body of documentation blocks may be structured. The example used is the desc tag.
We wonder how flexible the standard is about the whitespace between tags and identifier fields which are required example with param, member or verdict tags.
Example:
/**
*
* @param
* p_xyz_ID The Id of the xyz
*/
function f_foo(integer p_xyz) {}
Is the above ok accroding to the standard or must it be:
/**
*
* @param p_xyz_ID The Id of the xyz
*/
function f_foo(integer p_xyz) {}
Maybe a clarifaction could be added in the next edition of the standard.

Steps To Reproduce |
Additional Information |
Tags | No tags attached.
Relationships |
Attached Files | CR2817 - Resolution.doc (77,312) 21-04-2008 20:14 http://oldforge.etsi.org/mantis/file_download.php?file_id=1424&type=bug

Issue History
Date Modified | Username | Field | Change
01-02-2008 15:27 | Stephan Schulz | New Issue |
01-02-2008 15:27 | Stephan Schulz | Status | new => assigned
01-02-2008 15:27 | Stephan Schulz | Assigned To | => Gyorgy Rethy
01-02-2008 15:27 | Stephan Schulz | Source (company - Author) | => Stephan Schulz - ETSI
01-02-2008 15:32 | Stephan Schulz | Relationship added | related to 0002783
10-03-2008 15:40 | Ina Schieferdecker | Target Version | => Edition 4.1.1 (not yet published)
21-04-2008 08:56 | Ina Schieferdecker | Target Version | Edition 4.1.1 (not yet published) => Edition 3.4.1 (not yet published)
21-04-2008 20:12 | Gyorgy Rethy | Note Added: 0005484 |
21-04-2008 20:12 | Gyorgy Rethy | Status | assigned => closed
21-04-2008 20:13 | Gyorgy Rethy | Status | closed => feedback
21-04-2008 20:13 | Gyorgy Rethy | Resolution | open => reopened
21-04-2008 20:13 | Gyorgy Rethy | Note Added: 0005485 |
21-04-2008 20:14 | Gyorgy Rethy | File Added: CR2817 - Resolution.doc |
21-04-2008 20:14 | Gyorgy Rethy | Status | feedback => closed
22-04-2008 10:57 | Gyorgy Rethy | Note Added: 0005487 |
22-04-2008 10:57 | Gyorgy Rethy | Assigned To | Gyorgy Rethy => Thomas DeiÃŸ
22-04-2008 10:57 | Gyorgy Rethy | Status | closed => assigned
22-04-2008 10:57 | Gyorgy Rethy | Note Added: 0005488 |
22-04-2008 12:36 | Thomas DeiÃŸ | Note Added: 0005493 |
22-04-2008 12:36 | Thomas DeiÃŸ | Assigned To | Thomas DeiÃŸ => Gyorgy Rethy
22-04-2008 12:36 | Thomas DeiÃŸ | Status | assigned => resolved
22-04-2008 12:36 | Thomas DeiÃŸ | Resolution | reopened => fixed
14-07-2008 14:17 | Ina Schieferdecker | Status | resolved => closed
14-07-2008 14:17 | Ina Schieferdecker | Fixed in Version | => Edition 3.4.1 (not yet published)

Notes

(0005484)
Gyorgy Rethy
21-04-2008 20:12

Whitespace will be allowed (to be ignored) between the tag the field following it (i.e. it will not be possible to push indentaton by using spaces, tabs etc. to the generated documents at the beginning of freetext). See attached file.

(0005485)
Gyorgy Rethy
21-04-2008 20:13

Reopened to upload file attachment

(0005487)
Gyorgy Rethy
22-04-2008 10:57

To be cross-checked

(0005488)
Gyorgy Rethy
22-04-2008 10:57

To be cross-checked

(0005493)
Thomas DeiÃŸ
22-04-2008 12:36

STF 349, Thomas. Checked, and ok.