Documenting a Photon application

bridged with qdn.public.qnxrtp.photon
Post Reply
Guest

Documenting a Photon application

Post by Guest » Sat Oct 18, 2003 5:05 pm

How to document a Photon application outside of the AppBuilder?
When looking just at the source, things like the callbacks, changes to
the default resources etc are not apparent.
What method do you use to document this?

Also, when including screenshots in the programmer's
documentation, how to indicate callbacks?

My problem is documenting an existing application on paper,
decribing the functionality such as callbacks, events etc
The aim is to be able to document the application as completely
as possible based purely with this documentation and the source code.

Your insight and experience will be appreciated!

Bill Caroselli

Re: Documenting a Photon application

Post by Bill Caroselli » Mon Oct 20, 2003 1:33 pm

acellarius@yahoo.com wrote:
ayc > How to document a Photon application outside of the AppBuilder?
ayc > When looking just at the source, things like the callbacks, changes to
ayc > the default resources etc are not apparent.
ayc > What method do you use to document this?

ayc > Also, when including screenshots in the programmer's
ayc > documentation, how to indicate callbacks?

ayc > My problem is documenting an existing application on paper,
ayc > decribing the functionality such as callbacks, events etc
ayc > The aim is to be able to document the application as completely
ayc > as possible based purely with this documentation and the source code.

ayc > Your insight and experience will be appreciated!

In the callbacks source code I'll indicate what callbacks from what
widgets can get you to this callback.

In an external document, I would list all of the interactive widgets
and what callbacks they call and when.

--
Bill Caroselli -- Q-TPS Consulting
1-(708) 308-4956 <== Note: New Number
qtps@earthlink.net

Dave Rempel

Re: Documenting a Photon application

Post by Dave Rempel » Wed Oct 22, 2003 12:42 pm

You may also be interested in Doxygen, it lets you do the documentation
in the source code comments and then spit out html. It will inline
source in the docs if you want, create indexes of functions/classes/etc,
show heirarchies, all based on the source itself and the information you
put into the comments. I've found it to be a very valuable tool. The
latest version just got posted on the 3rd party repository. Docs for
how to use doxygen are automatically installed in the helpviewer if you
install that package :)

Dave Rempel


Bill Caroselli wrote:
acellarius@yahoo.com wrote:
ayc > How to document a Photon application outside of the AppBuilder?
ayc > When looking just at the source, things like the callbacks, changes to
ayc > the default resources etc are not apparent.
ayc > What method do you use to document this?

ayc > Also, when including screenshots in the programmer's
ayc > documentation, how to indicate callbacks?

ayc > My problem is documenting an existing application on paper,
ayc > decribing the functionality such as callbacks, events etc
ayc > The aim is to be able to document the application as completely
ayc > as possible based purely with this documentation and the source code.

ayc > Your insight and experience will be appreciated!

In the callbacks source code I'll indicate what callbacks from what
widgets can get you to this callback.

In an external document, I would list all of the interactive widgets
and what callbacks they call and when.

Post Reply

Return to “qdn.public.qnxrtp.photon”