[Gd-hackers] refman tool ready for check-in

Dustin Voss d-j-v at earthlink.net
Wed Jan 24 17:14:42 CET 2007


Peter Housel pointed out his testworks-spec code in d2c; using that,  
I got the superclasses to show up. Thanks, housel!

Peter also suggested that I incorporate refman into d2c. However,  
having tried it, I can say that this does not prove to be as  
practical as a separate tool:

a) d2c has to be run on a particular .lid file to create the  
corresponding refman file. Even with the --no-binaries and --no- 
makefile flags, the files are still touched enough so that the  
library has to be rebuilt later. In the case of the common-dylan  
libraries, you'd have to rebuild large parts of GD to get a small  
part's refman file.

b) To document a particular library, d2c will have to be run on  
the .lid file that generates that library. To document a common-dylan  
library, you'd have to navigate down to that directory and issue a  
make command. That means that the makefiles all have to have an  
additional target, call it "docs", that will run d2c with the refman  
option.

c) Keeping the refman tool separate allows it to be decoupled  
from .lid files, which means multiple libraries may be documented in  
one refman file.

For these reasons, I am keeping the tool separate.




More information about the hackers mailing list