Re: [Flightgear-devel] properties documentation

2002-12-29 Thread David Megginson
Mike Bonar writes: I would be happy to take on this responsibility. It will give me a chance to get to know the code before I start messing with it ;-) So, feel free to bombard me with direction. What are the priorities? Are we going to stick with javadoc format? If so, know any

Re: [Flightgear-devel] properties documentation

2002-12-28 Thread David Megginson
Mike Bonar writes: If I'm wasting my time just let me know. Not at all. Curt hasn't had time to update the doxygen docs for SimGear very frequently, or to generate and post any at all for FlightGear and TerraGear. I've already added a fair amount of JavaDoc-like comments to both, and if

Re: [Flightgear-devel] properties documentation

2002-12-27 Thread Mike Bonar
I am currently experimenting with doxemacs, a lisp extension to emacs that aids in formatting code for use with doxygen. Being an emacs newbie this might take a few days to get working ;-) I'll upload samples for everyone to see shortly. In the meantime, here are a couple of sites that have

Re: [Flightgear-devel] properties documentation

2002-12-27 Thread Mike Bonar
Correction: doxymacs. On Friday 27 December 2002 16:08, Mike Bonar wrote: I am currently experimenting with doxemacs, a lisp extension to emacs that aids in formatting code for use with doxygen. Being an emacs newbie this ...snip ___

Re: [Flightgear-devel] properties documentation

2002-12-27 Thread Bernie Bright
On Fri, 27 Dec 2002 16:08:30 -0600 Mike Bonar [EMAIL PROTECTED] wrote: I am currently experimenting with doxemacs, a lisp extension to emacs that aids in formatting code for use with doxygen. Being an emacs newbie this might take a few days to get working ;-) I'll upload samples for

Re: [Flightgear-devel] properties documentation

2002-12-27 Thread Mike Bonar
If I'm wasting my time just let me know. On Friday 27 December 2002 17:01, Bernie Bright wrote: On Fri, 27 Dec 2002 16:08:30 -0600 Mike Bonar [EMAIL PROTECTED] wrote: ...snip doxygen working well. They show the kinds of things we can include if we ...snip

RE: [Flightgear-devel] properties documentation

2002-12-23 Thread Jon Berndt
This may sound like a lame idea. I am not all that versed on xml technology, but it seems to me that there is a standard form for something like this. In the database world there is something called a Data dictionary that works as a central repository for data items, their types, default

RE: [Flightgear-devel] properties documentation

2002-12-23 Thread Jim Wilson
Jon Berndt [EMAIL PROTECTED] said: This may sound like a lame idea. I am not all that versed on xml technology, but it seems to me that there is a standard form for something like this. In the database world there is something called a Data dictionary that works as a central

re: [Flightgear-devel] properties documentation

2002-12-23 Thread David Megginson
Jim Wilson writes: Is this the sort of thing that a standard DTD document provides? Or could we develop our own dictionary of sorts? I'm suggesting that this could provide the documentation we need (if it is centralized). No, DTDs are strictly structural -- think of it as a specialized

Re: [Flightgear-devel] properties documentation

2002-12-23 Thread Mike Bonar
Doxygen would need to be tweaked a bit, since it is not set up for XML I started hunting for an XML documentation engine last night. All the ones I have found so far do only one page at a time. We want it to do the same thing that Doxygen does, which is to read through all the

RE: [Flightgear-devel] properties documentation

2002-12-23 Thread Jon Berndt
Doxygen would need to be tweaked a bit, since it is not set up for XML I Right. I was looking at it from another angle. That is, from the source code side. JSBSim uses properties and in the header we can probably document all the properties for a particular class. When Doxygen builds the docs

RE: [Flightgear-devel] properties documentation

2002-12-23 Thread David Megginson
Jon Berndt writes: Right. I was looking at it from another angle. That is, from the source code side. JSBSim uses properties and in the header we can probably document all the properties for a particular class. When Doxygen builds the docs from header comments, those will be included.

[Flightgear-devel] properties documentation

2002-12-22 Thread Jim Wilson
This may sound like a lame idea. I am not all that versed on xml technology, but it seems to me that there is a standard form for something like this. In the database world there is something called a Data dictionary that works as a central repository for data items, their types, default