|
Viewing Issue Simple Details
[ Jump to Notes ]
|
[ View Advanced ]
[ Issue History ]
[ Print ]
|
|
ID |
Category |
Severity |
Reproducibility |
Date Submitted |
Last Update |
|
0000020 |
[GgrTF] |
minor |
N/A |
2007-01-02 06:02 |
2009-09-07 08:13 |
|
|
Reporter |
ggr |
View Status |
public |
|
|
Assigned To |
ggr |
|
Priority |
normal |
Resolution |
fixed |
|
|
Status |
resolved |
|
|
|
|
|
Summary |
0000020: Research and implement a Doxygen/JavaDoc-style documentation solution for commands |
|
Description |
The documentation of GgrTF macros and command bindings is not easy to keep up to date, so a some kind of code-embedded documentation format in style of Doxygen/JavaDoc should be implemented.
Initial idea by me (Ggr) is that commands are documented in the TF script using following syntax:
;?/command [.. arguments ..]
;!Description and explanation blah
/def -i command = ...
The special lines starting with ";?" and ";!" would be then interpreted by documentation extractor written in Perl, and combined with the SGML/XML manual template when build-docs.sh is run.
|
|
Additional Information |
|
| Tags |
No tags attached. |
|
|
Attached Files |
|
|
|
Relationships 
