Documentation Available

#1 I can throw them up on my tripod site... won't handle too many hits a day, but we all only need them once (:

Send me an email, and I'll see what I can do!

-Blayne Watt

la_rapiere@hotmail.com

#2 You should cerate a .chm file from it. It has only 4 MB, then.

bye
Felix

#3 MGO.NETwork would be happy to host them on one of our servers, email me.

awright@maxgaming.net

#4 Adrian Wright had space on his ftp site for the zip. Please contact him for access at

awright@maxgaming.net

www.mgonetwork.com

Thanks.

Jeff Thelen
Quixotic

#5 You can download the zip file through http if you like

http://www.mgonetwork.com/~v12doc/v12_doc.zip

Any problems downloading, please email me at awright@maxgaming.net

Also, would anyone like me to have the pages available for net use?

#6 Doxygen is nice, I tried it yesterday and it makes reading the source much easier. I really hope people start putting Doxygen comments into the code.

We should be careful with what we put on the WWW, though.
Doxygen placed all source into the HTML files it generated (which is what I wanted). Be careful not to post the V12 source freely on the web! :-)

#7 Yeah I just grabbed the archive and source is there. It's not such a great idea to be posting that archive like that. Don't want anyone that shouldn't be seeing it get it. :-)

#8 Seems like GG should put it up on the secure CVS when they get it running.

#9 right I will move it to a secure location. I thoght only licensees could red this.

#10 Only licensee's can read these forums. That wouldn't necessarily prevent the URL from being leaked in some way.

If you can't find a secure way of posting it soon, mind shooting an email my way? cmturner2@alltel.net Thanks.

#11 will prob look at it more in the morning. really would like someway to know who is alicensee and who is not :)

#12 The .cpp/.cc files included only illustrate definitions and signatures. The functions themselves are not included.

#13 Well you could ask for a certain line of code within some random v12 file... That would tell you that the person has the code already.

#14 Am I wrong? I was certain that unless you purchased the V12 license you can not see these forums, period. So far I'm the only one on my team to have licensed it and the V12 SDK Forum does not show up for them. Are they just being Moe/Rons or is it me?

#15 The V12 Engine SDK forums should only be visible to those who have purchased the SDK.

#16 So there's the answer, but I'm sure you'll get sick of emailing out the docs Adrian. I guess one temporary solution (until GG gets some sort of licensee only file repository) is to place it on a password protected ftp site or play email tag amongst the members.

#17 I agree that the docs should not be accessible from non-licensees. I am a licensee however and would really like to have access to those files. So please do let us all know how we can get them as soon as practical.

Is doxygen something that can be downloaded. Perhaps we could each run this on the code individually?

Thanks

#18 Rick plans on releasing his dOxygen config scripts soon (like today or tomorrow). It should then be pretty easy to generate the docs.

#19 This is the config I used for anyone who wants it. Save it as a text file and load it into Doxygen ( http://www.stack.nl/~dimitri/doxygen/ ) and let it run (about an hour on my system).

Make sure to replace all my local paths with your own.

Also, this config wants Graphviz from ATT (see link at http://www.stack.nl/~dimitri/doxygen/ ), which creates the excellent inheritance graphs. If you don't want that, remove the reference.

Should work.






# Doxyfile 0.1

#---------------------------------------------------------------------------
# General configuration options
#---------------------------------------------------------------------------
PROJECT_NAME = v12
PROJECT_NUMBER = 1.0.0
OUTPUT_DIRECTORY = C:/Projects/v12/doc/Doxygen/
OUTPUT_LANGUAGE = English
EXTRACT_ALL = YES
EXTRACT_PRIVATE = YES
EXTRACT_STATIC = YES
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
BRIEF_MEMBER_DESC = NO
REPEAT_BRIEF = NO
ALWAYS_DETAILED_SEC = NO
FULL_PATH_NAMES = NO
STRIP_FROM_PATH =
INTERNAL_DOCS = NO
CLASS_DIAGRAMS = YES
SOURCE_BROWSER = NO
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = YES
CASE_SENSE_NAMES = YES
SHORT_NAMES = NO
HIDE_SCOPE_NAMES = NO
VERBATIM_HEADERS = YES
SHOW_INCLUDE_FILES = YES
JAVADOC_AUTOBRIEF = NO
INHERIT_DOCS = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
DISTRIBUTE_GROUP_DOC = NO
TAB_SIZE = 8
ENABLED_SECTIONS =
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
ALIASES =
MAX_INITIALIZER_LINES = 30
OPTIMIZE_OUTPUT_FOR_C = NO
SHOW_USED_FILES = YES
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE = c:\warn.txt
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = C:/Projects/v12/engine/ai/ \
C:/Projects/v12/engine/audio/ \
C:/Projects/v12/engine/collision/ \
C:/Projects/v12/engine/console/ \
C:/Projects/v12/engine/core/ \
C:/Projects/v12/engine/dgl/ \
C:/Projects/v12/engine/editor/ \
C:/Projects/v12/engine/game/ \
C:/Projects/v12/engine/gui/ \
C:/Projects/v12/engine/interior/ \
C:/Projects/v12/engine/math/ \
C:/Projects/v12/engine/platform/ \
C:/Projects/v12/engine/platformWin32/ \
C:/Projects/v12/engine/sceneGraph/ \
C:/Projects/v12/engine/sim/ \
C:/Projects/v12/engine/terrain/ \
C:/Projects/v12/engine/ts/
FILE_PATTERNS = *.hpp \
*.cc \
*.h \
*.cpp
RECURSIVE = NO
EXCLUDE =
EXCLUDE_PATTERNS =
EXAMPLE_PATH =
EXAMPLE_PATTERNS =
IMAGE_PATH =
INPUT_FILTER =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = YES
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = YES
HTML_OUTPUT = html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = YES
GENERATE_CHI = YES
BINARY_TOC = NO
TOC_EXPAND = YES
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = YES
TREEVIEW_WIDTH = 250
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
LATEX_OUTPUT = latex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
RTF_OUTPUT = rtf
COMPACT_RTF = YES
RTF_HYPERLINKS = YES
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = NO
MAN_OUTPUT = man
MAN_EXTENSION = .3
MAN_LINKS = NO
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
MACRO_EXPANSION = NO
EXPAND_ONLY_PREDEF = NO
SEARCH_INCLUDES = YES
INCLUDE_PATH =
INCLUDE_FILE_PATTERNS =
PREDEFINED =
EXPAND_AS_DEFINED =
#---------------------------------------------------------------------------
# Configuration::addtions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
HAVE_DOT = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
GRAPHICAL_HIERARCHY = YES
DOT_PATH = C:/Projects/Tools/ATT/Graphviz/bin/
MAX_DOT_GRAPH_WIDTH = 1024
MAX_DOT_GRAPH_HEIGHT = 1024
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::addtions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
CGI_NAME = search.cgi
CGI_URL =
DOC_URL =
DOC_ABSPATH =
BIN_ABSPATH = /usr/local/bin/
EXT_DOC_PATHS =

#20 doxygen is available to the public. Those that don't have it yet should download it. You will need the program to create the dox from Rick's config file or from the file listed above. Get the file from www.doxygen.org