2005-11-13 07:59:48 +00:00
|
|
|
Document: Photon Documentation
|
|
|
|
|
|
|
|
|
|
Introduction:
|
2005-11-14 20:14:18 +00:00
|
|
|
This is the photon developer documentation, generated via NaturalDocs
|
|
|
|
|
(http://naturaldocs.org) from comments embedded directly in the code. If you're
|
|
|
|
|
writing something with public documentation I'd highly recommend it, since as
|
|
|
|
|
you can see it's output looks signifigantly better than some of those other
|
|
|
|
|
documentation generators ;).
|
2005-11-13 07:59:48 +00:00
|
|
|
|
|
|
|
|
How To Use The Docs:
|
|
|
|
|
In the left pane the public namespaces are listed, click on a namespace name
|
2005-11-14 20:14:18 +00:00
|
|
|
to expand or collapse it. Clicking on a class/topic name will show the
|
|
|
|
|
documentation for that class or topic.
|
|
|
|
|
|
|
|
|
|
The Tutorials:
|
|
|
|
|
Because just diving right into the documentation can be daunting, there are also
|
|
|
|
|
official tutorials alongside the documentation. The <Photon Tutorials> section
|
|
|
|
|
has more detail.
|
2005-11-13 07:59:48 +00:00
|
|
|
|
|
|
|
|
Helping Out:
|
|
|
|
|
If you see anything that is incorrect, incomplete, or is just poorly described .
|
|
|
|
|
and could use clarification, please be sure to let me know (cozman@users.sf.net).
|
|
|
|
|
I want this documentation to be as helpful as possible to both new and
|
2005-11-14 20:14:18 +00:00
|
|
|
experienced users of photon, so feel free to contact me with quesions,
|
|
|
|
|
criticisms, or suggestions of any kind.
|
2005-11-13 07:59:48 +00:00
|
|
|
|
2005-11-14 20:14:18 +00:00
|
|
|
If you're interested in helping out, but don't feel like you could contribute
|
|
|
|
|
useful code someone to help keep the documentation current would be appreciated.
|
|
|
|
|
If interested in helping out in any way, I'd love to hear from you.
|
2005-11-13 07:59:48 +00:00
|
|
|
|
