Hello, I suggest some kind of conference this week (IRC, MSN, whatnot) to get all compasses pointing to the same place. What do you guys think? -- Cumprimentos, Bruno mailto:sardaukar.siet@xxxxxxxxx Monday, April 23, 2007, 1:24:01 PM, you wrote: > 2007/4/22, Sevik <sevik9@xxxxxxxxx>: >> Hello, >> >> I used Cygwin/Windows combination (I'll have a BeOS system up soon though) >> with Subversion and Doxygen to do an anonymous checkout and generate the >> documentation. > Great. You don't actually need cygwin. http://www.doxygen.org/ has a > binary that works on 'standard' windows. >> Please let me know if I am on the right track in terms of understanding >> though. >> >> 1. The Doxygen commands are not in the source but are in separate .dox >> files. Our job is to build these .dox files by hand for each class. > Yes. >> 2. I can understand how we create the shell of the documentation -- listing >> the names of the classes, methods and members, and showing class >> relationships. But where are we getting the technical explanations ? > Well, I think that we can get the bigger picture complete by the guys > that wrote the classes. The problem is that for some classes, the > original developers aren't around anymore. So basically it will > require a good look at the source and deducing ideas based on that. >> The purpose of some of the methods are not obvious to me from looking at the >> source code. Is there an external source of information (BeBook?) ? Or is >> one of the joys of doing the documentation, the opportunity to learn the >> technical details of everything ? [Which is fine too since my goal is to >> develop some desktop apps for Haiku.] > I forgot to mention this before, but it is actually _forbidden_ from > even looking at the BeBook for inspiration. We need to avoid using > anything from the Bebook, and the best thing to do is not to look at > it at all. > Niels