[interfacekit] Re: [Fwd: Re: Application Kit Tech Lead]

>>I'm glad you brought this stuff up (formatting interface specs) 
because 
>>I'm currently wrestling with this myself.  I've been reimplementing 

>My suggestion is to use doxygen. It is a neat piece of software, runs 

Yes, certainly doxygen, doc++ or ccdoc would seem to be the way to go.  
I haven't *used* any of these tools; I have, however, seen plenty of 
docs generated with them.  They all seem to look the same and, 
unfortunately, I don't like it. =(  I much prefer the structure of the 
online BeBook -- call me old-fashioned, but I like the book-like layout. 
 Is doxygen flexible enough to generate that kind of layout?

>I've mostly finished the print_server now. There are some things left 
>to do, but most of it is working :) I can use it to print, and it works 

>with the existing libbe.so and Printers preference panel :) I've 

Very cool.

>documented the code using the BeIDE addon that is in CVS, but going to 
>update the comments to doxygen style. I also want to include my "R&D" 
>text files, so I'll see how that can be done best using doxygen.

I need to grab that addon and see if I can't adapt it for Eddie.

>Reusing BeBook material is a tricky thing, we come back to our initial 
>"will the laywers let us do this" thing. BeBook content is property of 
>Be, Inc I'm afraid..... But ok, I'm not to bothered about that, can't 
>imagine Palm sueing us over that :)

Yeah, I'm not going to worry about it at this point.  I would be 
*stunned* if Palm came after an open-source project that was trying to 
replicate a piece of software they weren't even bothering to keep alive. 
;P

>Extraction of docs could be part of the build process, just another 
>target in the makefiles :) That's what's done most and I think that 
>would be pretty usefull....
>Doxygen could even be run within the "build farm" thing on sourceforge, 

>so it could generate new docs for use on the website every night 
>automagicly if we want :)

This would be ideal.

>PS: I'm evangelising on BeShare now-and-then, sometimes showing the 
>link to the website, hope you don't mind :)

Not at all. =)

e

Data is not information, and information is not knowledge: knowledge is 
not understanding, and understanding is not wisdom.
        - Philip Adams

Other related posts: