jpt-archive/cpp_photon
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

tutorial index

Browse Source
This commit is contained in:
James Turk 2005-11-14 20:14:18 +00:00
parent d2c3194bdb
commit ea8ba7d458
4 changed files with 32 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
ndoc/Menu.txt
View File

@ -33,7 +33,7 @@ Footer: Documentation for <a href="http://photon.sourceforge.net">photon</a>. Co
File: Photon Documentation (/home/james/src/photon/ndoc/pages/index.txt) File: Photon Documentation (/home/james/src/photon/ndoc/pages/index.txt)
Group: photon:: { Group: photon:: Library Documentation {
File: Application (/home/james/src/photon/include/Application.hpp) File: Application (/home/james/src/photon/include/Application.hpp)
File: Basic Types (/home/james/src/photon/include/types.hpp) File: Basic Types (/home/james/src/photon/include/types.hpp)
@ -81,10 +81,11 @@ Group: photon:: {
File: Texture (/home/james/src/photon/include/video/Texture.hpp) File: Texture (/home/james/src/photon/include/video/Texture.hpp)
} # Group: Video:: } # Group: Video::
} # Group: photon:: } # Group: photon:: Library Documentation
Group: Tutorials { Group: Tutorials {
File: Photon Tutorials (/home/james/src/photon/ndoc/tutorials/index.txt)
File: 01 - Getting Started (no auto-title, /home/james/src/photon/ndoc/tutorials/tutorial01.txt) File: 01 - Getting Started (no auto-title, /home/james/src/photon/ndoc/tutorials/tutorial01.txt)
} # Group: Tutorials } # Group: Tutorials

28
ndoc/pages/index.txt
View File

@ -1,24 +1,30 @@
Document: Photon Documentation Document: Photon Documentation
Introduction: Introduction:
This is the photon developer documentation, generated via NaturalDocs (http://naturaldocs.org) from This is the photon developer documentation, generated via NaturalDocs
comments embedded directly in the code. If you're writing something with public documentation I'd (http://naturaldocs.org) from comments embedded directly in the code. If you're
highly recommend it, since as you can see it's output looks signifigantly better than some of those writing something with public documentation I'd highly recommend it, since as
other documentation generators ;). you can see it's output looks signifigantly better than some of those other
documentation generators ;).
How To Use The Docs: How To Use The Docs:
In the left pane the public namespaces are listed, click on a namespace name In the left pane the public namespaces are listed, click on a namespace name
to expand or collapse it. Clicking on a class/topic name will show the documentation to expand or collapse it. Clicking on a class/topic name will show the
for that class or topic. 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.
Helping Out: Helping Out:
If you see anything that is incorrect, incomplete, or is just poorly described . 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). 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 I want this documentation to be as helpful as possible to both new and
experienced users of photon, so feel free to contact me with quesions, criticisms, experienced users of photon, so feel free to contact me with quesions,
or suggestions of any kind. criticisms, or suggestions of any kind.
If you're interested in helping out, but don't feel like you could contribute useful code If you're interested in helping out, but don't feel like you could contribute
someone to help keep the documentation current would be appreciated. If interested useful code someone to help keep the documentation current would be appreciated.
in helping out in any way, I'd love to hear from you. If interested in helping out in any way, I'd love to hear from you.

10
ndoc/tutorials/index.txt Normal file
View File

@ -0,0 +1,10 @@
Document: Photon Tutorials
Welcome to the offical Photon tutorials, they are part of the NaturalDoc documentation
so that they are easy to write and cross-reference with the docs. The tutorials
are a work in progress, and if you'd like to contribute it would be greatly
appreciated as they take up time that could be used working on Photon.
- <Tutorial 01 - Getting Started> - Tutorial on basic setup of a
Photon application.
- Tutorial 02 - Coming Soon

4
ndoc/tutorials/tutorial01.txt
View File

@ -1,4 +1,4 @@
Document: Photon Tutorial 01 - Getting Started Document: Tutorial 01 - Getting Started
Group: Introduction Group: Introduction
@ -256,4 +256,4 @@ if you need specific help try asking for help on the Photon mailing lists
(<http://lists.sourceforge.net/lists/listinfo/photon-users>). (<http://lists.sourceforge.net/lists/listinfo/photon-users>).
Written for Photon 0.1.0 by James: Written for Photon 0.1.0 by James:
$Id: tutorial01.txt,v 1.1 2005/11/14 20:02:39 cozman Exp $ $Id: tutorial01.txt,v 1.2 2005/11/14 20:14:18 cozman Exp $