Pano12.dll doc explanationI have linked this into Bruno's compiling
pano12.dll piece on the PanoTools wiki.
John
-----Original Message-----
From: Joel A. Foner [mailto:#removed#]
Sent: Monday, September 26, 2005 10:51 AM
To: 'PanoTools - Beta Test List'
Subject: [PTBeta] Pano12.dll doc explanation
John asked me to do a quick explanation of "what's here" in the docs for
pano12.dll
http://www.panotools.info/members/documentation/pano12/index.html
The files were just updated about an hour ago to include inline sources, so
that you can browse back and forth between the documentation (functions,
members etc) and the actual source code that these were pulled from.
What this is:
This is doc built using Doxygen, a GPL'd code documentor maintained by
Dimitri van Heesch (http://www.stack.nl/~dimitri/doxygen/). The docs are the
results of a scan by doxygen of the source as of May 4, 2005. I've turned on
most of the scan options so that the coverage is pretty complete. I've also
enabled doxygen's collaboration diagrams in this build of doc, so you can
see which parts of the code depend on or call other parts of the code. These
diagrams are useful when trying to see how things fit together. Also note
that the boxes with black borders on these diagrams are live hyperlinks -
click one and you'll jump to that item's page.
Why it's called libpano-2005-05-04-original:
This is the sources as I picked them up on that date, in original form
(before trying some things and then setting it aside for a while).
Things to try:
Click the link above, and when your browser opens:
- Click Alphabetical List at the top (get a hyperlinked alpha list of all
the data structures in the code base!)
- Click Data Stuctures at the top ("had this code been documented" you'd see
the brief description next to each one ;)
- Click Directories at the top, then "libpano-2005-05-04-original" (note
that from here you can jump to either the doc for a function, or the code,
and that once you're in either place there are links to jump back and forth
- Click adjust.c (note dependency graph, showing the dependency tree walked
from adjust.c
- Click the square block with solid border labeled "panorama.h" (note jump
to the panorama.h doc page with dependency graph and include graph
- Note links in various places "Go to the source code of this file"
. all of this from getting doxygen and graphviz installed, then choosing a
source folder and output folder, clicking some checkboxes, and then waiting
a whopping total of maybe 60 seconds to generate the output...
What this isn't (!):
It isn't the result of me going in and figuring out how things work, and
then adding "human code documentation" with explanations from a real
person's point of view.
What it could be:
If someone gets inspired to add code comments as they wander through the
code base, we could regenerate the doxygen build to include those comments.
See this page (http://www.stack.nl/~dimitri/doxygen/docblocks.html) on
Dimitri's for how comments should be set up to end up in the doc. The
comment style is basically standard C++ with a few ornaments to decide where
in the doc various things will get placed.
I hope this is helpful. I can't say I've spent a huge amount of time reading
the code, but this was what I did to at least get a feel for how pano12.dll
is organized.
Regards,
Joel
P.S. I have no commercial (how could that be, it's GPL'd!) interest in
doxygen. I just think it's a neat simple tool that works and works and works
and that having the doc around might help folks to get inspired to learn
more about how this works.
[Non-text portions of this message have been removed]
------------------------ Yahoo! Groups Sponsor --------------------~-->
Get Bzzzy! (real tools to help you find a job). Welcome to the Sweet Life.
http://us.click.yahoo.com/A77XvD/vlQLAA/TtwFAA/.Cr1lB/TM
--------------------------------------------------------------------~->
Yahoo! Groups Links
<*> To visit your group on the web, go to:
http://groups.yahoo.com/group/PanoTools/
<*> To unsubscribe from this group, send an email to:
#removed#
<*> Your use of Yahoo! Groups is subject to:
http://docs.yahoo.com/info/terms/
Next message:
Previous message: