mirror of
https://github.com/id-Software/GtkRadiant.git
synced 2026-03-19 16:39:26 +01:00
The GtkRadiant sources as originally released under the GPL license.
This commit is contained in:
Travis Bradshaw
159
Doxygen_files/Doxyfile
Normal file
159
Doxygen_files/Doxyfile
Normal file
@@ -0,0 +1,159 @@
|
||||
# Doxyfile 1.2.5-20010304
|
||||
#---------------------------------------------------------------------------
|
||||
# General configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
PROJECT_NAME =
|
||||
PROJECT_NUMBER =
|
||||
OUTPUT_DIRECTORY =
|
||||
OUTPUT_LANGUAGE = English
|
||||
EXTRACT_ALL = YES
|
||||
EXTRACT_PRIVATE = YES
|
||||
EXTRACT_STATIC = YES
|
||||
HIDE_UNDOC_MEMBERS = NO
|
||||
HIDE_UNDOC_CLASSES = NO
|
||||
BRIEF_MEMBER_DESC = YES
|
||||
REPEAT_BRIEF = YES
|
||||
ALWAYS_DETAILED_SEC = YES
|
||||
FULL_PATH_NAMES = YES
|
||||
STRIP_FROM_PATH = $(PWD)/
|
||||
INTERNAL_DOCS = YES
|
||||
CLASS_DIAGRAMS = YES
|
||||
SOURCE_BROWSER = YES
|
||||
INLINE_SOURCES = YES
|
||||
STRIP_CODE_COMMENTS = NO
|
||||
CASE_SENSE_NAMES = YES
|
||||
HIDE_SCOPE_NAMES = NO
|
||||
VERBATIM_HEADERS = YES
|
||||
SHOW_INCLUDE_FILES = YES
|
||||
JAVADOC_AUTOBRIEF = YES
|
||||
INHERIT_DOCS = YES
|
||||
INLINE_INFO = YES
|
||||
SORT_MEMBER_DOCS = YES
|
||||
DISTRIBUTE_GROUP_DOC = NO
|
||||
TAB_SIZE = 2
|
||||
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 = YES
|
||||
WARNINGS = YES
|
||||
WARN_IF_UNDOCUMENTED = YES
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
WARN_LOGFILE = doxygen.log
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the input files
|
||||
#---------------------------------------------------------------------------
|
||||
INPUT =
|
||||
FILE_PATTERNS = *.h \
|
||||
*.cpp \
|
||||
*.c
|
||||
RECURSIVE = YES
|
||||
EXCLUDE =
|
||||
EXCLUDE_PATTERNS =
|
||||
EXAMPLE_PATH =
|
||||
EXAMPLE_PATTERNS =
|
||||
IMAGE_PATH =
|
||||
INPUT_FILTER =
|
||||
FILTER_SOURCE_FILES = YES
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the alphabetical class index
|
||||
#---------------------------------------------------------------------------
|
||||
ALPHABETICAL_INDEX = YES
|
||||
COLS_IN_ALPHA_INDEX = 4
|
||||
IGNORE_PREFIX =
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the HTML output
|
||||
#---------------------------------------------------------------------------
|
||||
GENERATE_HTML = YES
|
||||
HTML_OUTPUT =
|
||||
HTML_HEADER = Doxygen_files/doxygen_gtkradiant_head.html
|
||||
HTML_FOOTER = Doxygen_files/doxygen_gtkradiant_foot.html
|
||||
HTML_STYLESHEET = Doxygen_files/doxygen_gtkradiant.css
|
||||
HTML_ALIGN_MEMBERS = YES
|
||||
GENERATE_HTMLHELP = NO
|
||||
GENERATE_CHI = NO
|
||||
BINARY_TOC = NO
|
||||
TOC_EXPAND = NO
|
||||
DISABLE_INDEX = NO
|
||||
ENUM_VALUES_PER_LINE = 4
|
||||
GENERATE_TREEVIEW = NO
|
||||
TREEVIEW_WIDTH = 250
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the LaTeX output
|
||||
#---------------------------------------------------------------------------
|
||||
GENERATE_LATEX = NO
|
||||
LATEX_OUTPUT =
|
||||
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 =
|
||||
COMPACT_RTF = NO
|
||||
RTF_HYPERLINKS = NO
|
||||
RTF_STYLESHEET_FILE =
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the man page output
|
||||
#---------------------------------------------------------------------------
|
||||
GENERATE_MAN = NO
|
||||
MAN_OUTPUT =
|
||||
MAN_EXTENSION = .3
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the preprocessor
|
||||
#---------------------------------------------------------------------------
|
||||
ENABLE_PREPROCESSING = YES
|
||||
MACRO_EXPANSION = YES
|
||||
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
|
||||
#---------------------------------------------------------------------------
|
||||
# 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 =
|
||||
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 =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Include file, at the bottom to over-ride anything I missed.
|
||||
#---------------------------------------------------------------------------
|
||||
@INCLUDE = genConf
|
||||
45
Doxygen_files/doxy_mainpage.h
Normal file
45
Doxygen_files/doxy_mainpage.h
Normal file
@@ -0,0 +1,45 @@
|
||||
/*
|
||||
** Doxygen index.html generation file
|
||||
**
|
||||
*/
|
||||
|
||||
/*! \mainpage +project+ Doxygen Index
|
||||
<img src="../images/gtkr_splash.jpg" align="right" hspace="2" vspace="2">
|
||||
\section intro Introduction
|
||||
|
||||
This documentation was generated from GtkRadiant source code using Doxygen.<br>
|
||||
Generated from source in: +target+
|
||||
|
||||
\section links Links
|
||||
<b>General Links</b><br>
|
||||
<a href="http://www.doxygen.org">Doxygen Homepage</a><br>
|
||||
<a href="http://www.gtkradiant.com">GtkRadiant Homepage</a><br>
|
||||
<a href="http://zerowing.idsoftare.com">Zerowing - GtkRadiant Development</a><br>
|
||||
|
||||
<b>Local Links</b><br>
|
||||
<a href="../reference/index.html">Doxygen Quick Reference (Local)</a><br>
|
||||
|
||||
<p>
|
||||
<b>GtkRadiant FAQ Links</b><br>
|
||||
<a href="http://www.qeradiant.com/faq/fom-serve/cache/115.html">GtkRadiant FAQ</a><br>
|
||||
<a href="http://www.qeradiant.com/faq/fom-serve/cache/181.html">GtkRadiant FAQ: Open Tasks</a><br>
|
||||
<a href="http://www.qeradiant.com/faq/fom-serve/cache/116.html">GtkRadiant FAQ: Compiling instructions</a><br>
|
||||
<a href="http://www.qeradiant.com/faq/fom-serve/cache/116.html">GtkRadiant FAQ: Creating/Submitting patches</a><br>
|
||||
<a href="http://www.qeradiant.com/faq/fom-serve/cache/141.html">GtkRadiant FAQ: Coding Conventions & Guidelines</a><br>
|
||||
</p>
|
||||
|
||||
<b>Misc Links</b><br>
|
||||
<a href="http://www.idsoftware.com">idsoftware.com</a><br>
|
||||
|
||||
<p>
|
||||
<i>
|
||||
* Note: The content on this page was generated from <a href="doxy__mainpage_8h.html">this</A> file.
|
||||
It is moved into the <target> path when the doxygen documentation is generated, and removed immediately
|
||||
afterwards.
|
||||
</i>
|
||||
</p>
|
||||
|
||||
<i>This page generated: by <b>+user+</b> on <b>+machine+</b><br>
|
||||
On +date+
|
||||
</i>
|
||||
*/
|
||||
34
Doxygen_files/doxygen_gtkradiant.css
Normal file
34
Doxygen_files/doxygen_gtkradiant.css
Normal file
@@ -0,0 +1,34 @@
|
||||
body { background-color: black; }
|
||||
IMG { border-color: #222222; border: 0; }
|
||||
em { font-size: 11px; font-style: italic; font-weight: normal; color: #888888; }
|
||||
H1 { text-align: center; font-size: 15px; color: #2222AA; font-family: Geneva, Verdana, Helvetica, Arial, sans-serif; }
|
||||
H3 { text-align: center; font-size: 18px; color: #2222AA; font-family: Geneva, Verdana, Helvetica, Arial, sans-serif; }
|
||||
A { text-decoration: none; color: #6666DD; }
|
||||
A:HOVER { text-decoration: underline; color: #4444FF; }
|
||||
A:VISITED { text-decoration: none; color: #8888AA; }
|
||||
A.qindex { text-decoration: none; color: #6666DD; font-size: 11px; }
|
||||
A.qindex:HOVER { text-decoration: underline; color: #4444FF; font-size: 11px; }
|
||||
A.qindex:VISITED { text-decoration: none; color: #8888AA; font-size: 11px; }
|
||||
A.qindexRef { font-size: 11px; }
|
||||
A.el { text-decoration: none; font-weight: bold; }
|
||||
A.elRef { font-weight: bold; }
|
||||
A.code { text-decoration: none; font-weight: normal; color: #6666DD; }
|
||||
A.code:HOVER { text-decoration: underline; font-weight: normal; color: #4444FF; }
|
||||
A.code:VISITED { text-decoration: none; font-weight: normal; color: #8888AA; }
|
||||
A.codeRef { text-decoration: none; font-weight: normal; color: #6666DD; }
|
||||
A.codeRef:HOVER { text-decoration: underline; font-weight: normal; color: #4444FF; }
|
||||
A.codeRef:VISITED { text-decoration: none; font-weight: normal; color: #8888AA; }
|
||||
DL.el { margin-left: 2cm; width: 99%; }
|
||||
DIV.fragment { background-color: #FFFFFF; width: 99%; }
|
||||
DIV.ah { background-color: #AAAAAA; width: 99%; margin-bottom: 3; margin-top: 3; }
|
||||
TD.md { cellpadding: 0; background-color: #DDDDDD; border: 0; width: 99%; color: #222222; }
|
||||
DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight: bold; color: #222222; }
|
||||
DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller; }
|
||||
FONT.keyword { color: #0080A0; }
|
||||
FONT.keywordtype { color: #604020; }
|
||||
FONT.keywordflow { color: #E08000; }
|
||||
FONT.comment { color: #800000; }
|
||||
FONT.comment { color: #009900; text-decoration: italic; }
|
||||
FONT.preprocessor { color: #806020; }
|
||||
FONT.stringliteral{ color: #002080; }
|
||||
FONT.charliteral { color: #008080; }
|
||||
49
Doxygen_files/doxygen_gtkradiant_foot.html
Normal file
49
Doxygen_files/doxygen_gtkradiant_foot.html
Normal file
@@ -0,0 +1,49 @@
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> $doxygenversion</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
38
Doxygen_files/doxygen_gtkradiant_head.html
Normal file
38
Doxygen_files/doxygen_gtkradiant_head.html
Normal file
@@ -0,0 +1,38 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>$projectname $projectnumber Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92"></td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware"></td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr height="12">
|
||||
<td valign="top">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12"></td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%"></td>
|
||||
<td valign="top">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12"></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="0"><div>
|
||||
<br><hr width="95%">
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
7
Doxygen_files/doxygen_index.html
Normal file
7
Doxygen_files/doxygen_index.html
Normal file
@@ -0,0 +1,7 @@
|
||||
<html>
|
||||
<head>
|
||||
<meta http-equiv=Refresh content="1; url=./html/index.html">
|
||||
</head>
|
||||
<body>
|
||||
Redirecting to <a href="./html/index.html">Doxygen index</a>
|
||||
</body>
|
||||
46
Doxygen_files/doxygen_reference_foot.html
Normal file
46
Doxygen_files/doxygen_reference_foot.html
Normal file
@@ -0,0 +1,46 @@
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<!-- Left side of footer -->
|
||||
<i><a href="http://www.doxygen.org">Doxygen</a> is: Copyright © 1997-2001 by <a href="mailto:dimitri@stack.nl">Dimitri van Heesch.</a></i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<!-- Right side of footer -->
|
||||
<i>GtkRadiant Doxygen Maintainer: <a href="mailto:gefdavis@dingoblue.net.au">Gef</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</center>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
38
Doxygen_files/doxygen_reference_head.html
Normal file
38
Doxygen_files/doxygen_reference_head.html
Normal file
@@ -0,0 +1,38 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>GtkRadiant - Doxygen Quick Reference</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0"></td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92"></td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12"></td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%"></td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12"></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%">&nsbp;</td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr width="95%">
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
103
Doxygen_files/example/annotated.html
Normal file
103
Doxygen_files/example/annotated.html
Normal file
@@ -0,0 +1,103 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>IEPairsClassDocumentationExample Compound List</h1>Here are the classes, structs, unions and interfaces with brief descriptions:<ul>
|
||||
<li><a class="el" href="classIEpair.html">IEpair</a> (Virtual class to allow plugin operations on entity pairs)
|
||||
</ul>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
110
Doxygen_files/example/classIEpair-members.html
Normal file
110
Doxygen_files/example/classIEpair-members.html
Normal file
@@ -0,0 +1,110 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>IEpair Member List</h1>This is the complete list of members for <a class="el" href="classIEpair.html">IEpair</a>, including all inherited members.<ul>
|
||||
<li><a class="el" href="classIEpair.html#a7">CalculateRotatedBounds</a>(vec3_t mins, vec3_t maxs)=0
|
||||
<code> [pure virtual]</code><li><a class="el" href="classIEpair.html#a1">DecRef</a>()=0
|
||||
<code> [pure virtual]</code><li><a class="el" href="classIEpair.html#a3">FloatForKey</a>(char *key)=0
|
||||
<code> [pure virtual]</code><li><a class="el" href="classIEpair.html#a6">GetEntityOrigin</a>(vec3_t vec)=0
|
||||
<code> [pure virtual]</code><li><a class="el" href="classIEpair.html#a2">GetVectorForKey</a>(char *key, vec3_t vec)=0
|
||||
<code> [pure virtual]</code><li><a class="el" href="classIEpair.html#a0">IncRef</a>()=0
|
||||
<code> [pure virtual]</code><li><a class="el" href="classIEpair.html#a5">SetKeyValue</a>(char *key, char *value)=0
|
||||
<code> [pure virtual]</code><li><a class="el" href="classIEpair.html#a4">ValueForKey</a>(char *key)=0
|
||||
<code> [pure virtual]</code></ul>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
414
Doxygen_files/example/classIEpair.html
Normal file
414
Doxygen_files/example/classIEpair.html
Normal file
@@ -0,0 +1,414 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>IEpair Class Reference</h1>Virtual class to allow plugin operations on entity pairs.
|
||||
<a href="#_details">More...</a>
|
||||
<p>
|
||||
<a href="classIEpair-members.html">List of all members.</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td colspan=2><br><h2>Public Methods</h2></td></tr>
|
||||
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a0">IncRef</a> ()=0</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Increment the number of references to this object.</em> <a href="#a0">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a1">DecRef</a> ()=0</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Decrement the reference count.</em> <a href="#a1">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a2">GetVectorForKey</a> (char *key, vec3_t vec)=0</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Get a vector from a key.</em> <a href="#a2">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>virtual float </td><td valign=bottom><a class="el" href="classIEpair.html#a3">FloatForKey</a> (char *key)=0</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Get a float from a key.</em> <a href="#a3">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>virtual char* </td><td valign=bottom><a class="el" href="classIEpair.html#a4">ValueForKey</a> (char *key)=0</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Get a string (char *) from a key.</em> <a href="#a4">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a5">SetKeyValue</a> (char *key, char *value)=0</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Set a key value to char *value.</em> <a href="#a5">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a6">GetEntityOrigin</a> (vec3_t vec)=0</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Get a vec3_t for the entities origin.</em> <a href="#a6">More...</a><em></em></font><br><br></td></tr>
|
||||
<tr><td nowrap align=right valign=top>virtual void </td><td valign=bottom><a class="el" href="classIEpair.html#a7">CalculateRotatedBounds</a> (vec3_t mins, vec3_t maxs)=0</td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Compute the rotated bounds of the BBox based on "angle" and "angles" keys.</em> <a href="#a7">More...</a><em></em></font><br><br></td></tr>
|
||||
</table>
|
||||
<hr><a name="_details"></a><h2>Detailed Description</h2>
|
||||
Virtual class to allow plugin operations on entity pairs.
|
||||
<p>
|
||||
|
||||
<p>
|
||||
<dl compact><dt>
|
||||
<b><a class="el" href="todo.html#_todo000001">Todo: </a></b><dd>
|
||||
Write more complete documentation for this class so that it's use is clear</dl>
|
||||
<p>
|
||||
An interface to entity keys and key pairs that allows plugins to; read and write entity keys and key values, get a key value as a vec3_t
|
||||
<p>
|
||||
|
||||
<p>
|
||||
Definition at line <a class="el" href="test_8c-source.html#l00010">10</a> of file <a class="el" href="test_8c-source.html">iepairs.h</a>.<hr><h2>Member Function Documentation</h2>
|
||||
<a name="a7" doxytag="IEpair::CalculateRotatedBounds"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void IEpair::CalculateRotatedBounds (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
vec3_t <em>mins</em>,
|
||||
</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td><b>
|
||||
vec3_t <em>maxs</em> )<code> [pure virtual]</code>
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Compute the rotated bounds of the BBox based on "angle" and "angles" keys.
|
||||
<p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a1" doxytag="IEpair::DecRef"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void IEpair::DecRef (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
)<code> [pure virtual]</code>
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Decrement the reference count.
|
||||
<p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a3" doxytag="IEpair::FloatForKey"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
float IEpair::FloatForKey (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
char * <em>key</em> )<code> [pure virtual]</code>
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Get a float from a key.
|
||||
<p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a6" doxytag="IEpair::GetEntityOrigin"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void IEpair::GetEntityOrigin (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
vec3_t <em>vec</em> )<code> [pure virtual]</code>
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Get a vec3_t for the entities origin.
|
||||
<p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a2" doxytag="IEpair::GetVectorForKey"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void IEpair::GetVectorForKey (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
char * <em>key</em>,
|
||||
</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td><b>
|
||||
vec3_t <em>vec</em> )<code> [pure virtual]</code>
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Get a vector from a key.
|
||||
<p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a0" doxytag="IEpair::IncRef"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void IEpair::IncRef (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
)<code> [pure virtual]</code>
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Increment the number of references to this object.
|
||||
<p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a5" doxytag="IEpair::SetKeyValue"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
void IEpair::SetKeyValue (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
char * <em>key</em>,
|
||||
</b></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td></td>
|
||||
<td><b>
|
||||
char * <em>value</em> )<code> [pure virtual]</code>
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Set a key value to char *value.
|
||||
<p>
|
||||
<dl compact><dt>
|
||||
<b>Parameters: </b><dd>
|
||||
<table border=0 cellspacing=2 cellpadding=0>
|
||||
<tr><td valign=top><em>key</em>
|
||||
</td><td>
|
||||
The (char *) containing the keyname </td></tr>
|
||||
<tr><td valign=top><em>value</em>
|
||||
</td><td>
|
||||
The (char *) to set the key value to </td></tr>
|
||||
</table>
|
||||
</dl> </td>
|
||||
</tr>
|
||||
</table>
|
||||
<a name="a4" doxytag="IEpair::ValueForKey"></a><p>
|
||||
<table width="100%" cellpadding="2" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td class="md">
|
||||
<table cellpadding="0" cellspacing="0" border="0">
|
||||
<tr>
|
||||
<td nowrap valign="top"><b>
|
||||
char * IEpair::ValueForKey (
|
||||
</b></td>
|
||||
<td valign="bottom"><b>
|
||||
char * <em>key</em> )<code> [pure virtual]</code>
|
||||
</b></td>
|
||||
</tr>
|
||||
|
||||
</table>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<table cellspacing=5 cellpadding=0 border=0>
|
||||
<tr>
|
||||
<td>
|
||||
|
||||
</td>
|
||||
<td>
|
||||
|
||||
<p>
|
||||
Get a string (char *) from a key.
|
||||
<p>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
<hr>The documentation for this class was generated from the following file:<ul>
|
||||
<li><a class="el" href="test_8c-source.html">iepairs.h</a></ul>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
103
Doxygen_files/example/classes.html
Normal file
103
Doxygen_files/example/classes.html
Normal file
@@ -0,0 +1,103 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>IEPairsClassDocumentationExample Compound Index</h1><table align=center width="95%" border=0 cellspacing=0 cellpadding=0>
|
||||
<tr><td><div class="ah"><font color="white"><b> I </b></font></div></td><td><a class="el" href="classIEpair.html">IEpair</a> </td></tr>
|
||||
</table>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
BIN
Doxygen_files/example/doxygen.gif
Normal file
BIN
Doxygen_files/example/doxygen.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 2.3 KiB |
35
Doxygen_files/example/doxygen_gtkradiant.css
Normal file
35
Doxygen_files/example/doxygen_gtkradiant.css
Normal file
@@ -0,0 +1,35 @@
|
||||
body { background-color: black; }
|
||||
IMG { border-color: #222222; border: 1; }
|
||||
em { font-size: 11px; font-style: italic; font-weight: normal; color: #888888; }
|
||||
H1 { text-align: center; font-size: 15px; color: #2222AA; font-family: Geneva, Verdana, Helvetica, Arial, sans-serif; }
|
||||
H3 { text-align: center; font-size: 18px; color: #2222AA; font-family: Geneva, Verdana, Helvetica, Arial, sans-serif; }
|
||||
A { text-decoration: none; color: #6666DD; }
|
||||
A:HOVER { text-decoration: underline; color: #4444FF; }
|
||||
A:VISITED { text-decoration: none; color: #8888AA; }
|
||||
A.qindex { text-decoration: none; color: #6666DD; font-size: 11px; }
|
||||
A.qindex:HOVER { text-decoration: underline; color: #4444FF; font-size: 11px; }
|
||||
A.qindex:VISITED { text-decoration: none; color: #8888AA; font-size: 11px; }
|
||||
A.qindexRef { font-size: 11px; }
|
||||
A.el { text-decoration: none; font-weight: bold; }
|
||||
A.elRef { font-weight: bold; }
|
||||
A.code { text-decoration: none; font-weight: normal; color: #6666DD; }
|
||||
A.code:HOVER { text-decoration: underline; font-weight: normal; color: #4444FF; }
|
||||
A.code:VISITED { text-decoration: none; font-weight: normal; color: #8888AA; }
|
||||
A.codeRef { text-decoration: none; font-weight: normal; color: #6666DD; }
|
||||
A.codeRef:HOVER { text-decoration: underline; font-weight: normal; color: #4444FF; }
|
||||
A.codeRef:VISITED { text-decoration: none; font-weight: normal; color: #8888AA; }
|
||||
DL.el { margin-left: 2cm; width: 99%; }
|
||||
DIV.fragment { background-color: #FFFFFF; width: 99%; }
|
||||
DIV.ah { background-color: #AAAAAA; width: 99%; margin-bottom: 3; margin-top: 3; }
|
||||
TD.md { cellpadding: 2; background-color: #DDDDDD; border: 1; width: 99%; color: #222222; }
|
||||
DIV.groupHeader { margin-left: 16; margin-top: 12; margin-bottom: 6; font-weight: bold; color: #222222; }
|
||||
DIV.groupText { margin-left: 16; font-style: italic; font-size: smaller; }
|
||||
FONT.keyword { color: #0080A0; }
|
||||
FONT.keywordtype { color: #604020; }
|
||||
FONT.keywordflow { color: #E08000; }
|
||||
FONT.comment { color: #800000; }
|
||||
FONT.comment { color: #009900; text-decoration: italic; }
|
||||
FONT.preprocessor { color: #806020; }
|
||||
FONT.stringliteral{ color: #002080; }
|
||||
FONT.charliteral { color: #008080; }
|
||||
|
||||
102
Doxygen_files/example/files.html
Normal file
102
Doxygen_files/example/files.html
Normal file
@@ -0,0 +1,102 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>IEPairsClassDocumentationExample File List</h1>Here is a list of all files with brief descriptions:<ul>
|
||||
<li><a class="el" href="test_8c.html">iepairs.h</a> <a href="test_8c-source.html">[code]</a></ul>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
110
Doxygen_files/example/functions.html
Normal file
110
Doxygen_files/example/functions.html
Normal file
@@ -0,0 +1,110 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>IEPairsClassDocumentationExample Compound Members</h1>Here is a list of all class members with links to the class documentation for each member:<ul>
|
||||
<li>CalculateRotatedBounds()
|
||||
: <a class="el" href="classIEpair.html#a7">IEpair</a><li>DecRef()
|
||||
: <a class="el" href="classIEpair.html#a1">IEpair</a><li>FloatForKey()
|
||||
: <a class="el" href="classIEpair.html#a3">IEpair</a><li>GetEntityOrigin()
|
||||
: <a class="el" href="classIEpair.html#a6">IEpair</a><li>GetVectorForKey()
|
||||
: <a class="el" href="classIEpair.html#a2">IEpair</a><li>IncRef()
|
||||
: <a class="el" href="classIEpair.html#a0">IEpair</a><li>SetKeyValue()
|
||||
: <a class="el" href="classIEpair.html#a5">IEpair</a><li>ValueForKey()
|
||||
: <a class="el" href="classIEpair.html#a4">IEpair</a></ul>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
16
Doxygen_files/example/graph_legend.dot
Normal file
16
Doxygen_files/example/graph_legend.dot
Normal file
@@ -0,0 +1,16 @@
|
||||
digraph inheritance
|
||||
{
|
||||
Node7 [shape="box",label="Inherited",fontsize=10,height=0.2,width=0.4,fontname="doxfont",color="black",style="filled" fontcolor="white"];
|
||||
Node8 -> Node7 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="doxfont"];
|
||||
Node8 [shape="box",label="PublicBase",fontsize=10,height=0.2,width=0.4,fontname="doxfont",color="black",URL="$class_publicbase.html"];
|
||||
Node9 -> Node8 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="doxfont"];
|
||||
Node9 [shape="box",label="Truncated",fontsize=10,height=0.2,width=0.4,fontname="doxfont",color="red",URL="$class_truncated.html"];
|
||||
Node11 -> Node7 [dir=back,color="darkgreen",fontsize=10,style="solid",fontname="doxfont"];
|
||||
Node11 [shape="box",label="ProtectedBase",fontsize=10,height=0.2,width=0.4,fontname="doxfont",color="black",URL="$class_protectedbase.html"];
|
||||
Node12 -> Node7 [dir=back,color="firebrick4",fontsize=10,style="solid",fontname="doxfont"];
|
||||
Node12 [shape="box",label="PrivateBase",fontsize=10,height=0.2,width=0.4,fontname="doxfont",color="black",URL="$class_privatebase.html"];
|
||||
Node13 -> Node7 [dir=back,color="midnightblue",fontsize=10,style="solid",fontname="doxfont"];
|
||||
Node13 [shape="box",label="Undocumented",fontsize=10,height=0.2,width=0.4,fontname="doxfont",color="grey75"];
|
||||
Node14 -> Node7 [dir=back,color="darkorchid3",fontsize=10,style="dashed",label="m_usedClass",fontname="doxfont"];
|
||||
Node14 [shape="box",label="Used",fontsize=10,height=0.2,width=0.4,fontname="doxfont",color="black",URL="$class_used.html"];
|
||||
}
|
||||
BIN
Doxygen_files/example/graph_legend.gif
Normal file
BIN
Doxygen_files/example/graph_legend.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.1 KiB |
141
Doxygen_files/example/graph_legend.html
Normal file
141
Doxygen_files/example/graph_legend.html
Normal file
@@ -0,0 +1,141 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>Graph Legend</h1>This page explains how to interpret the graphs that are generated by doxygen.
|
||||
<p>
|
||||
Consider the following example: <div class="fragment"><pre><font class="comment">/*! Invisible class because of truncation */</font>
|
||||
<font class="keyword">class </font>Invisible { };
|
||||
<font class="comment"></font>
|
||||
<font class="comment">/*! Truncated class, inheritance relation is hidden */</font>
|
||||
<font class="keyword">class </font>Truncated : <font class="keyword">public</font> Invisible { };
|
||||
|
||||
<font class="comment">/* Class not documented with doxygen comments */</font>
|
||||
<font class="keyword">class </font>Undocumented { };
|
||||
<font class="comment"></font>
|
||||
<font class="comment">/*! Class that is inherited using public inheritance */</font>
|
||||
<font class="keyword">class </font>PublicBase : <font class="keyword">public</font> Truncated { };
|
||||
<font class="comment"></font>
|
||||
<font class="comment">/*! Class that is inherited using protected inheritance */</font>
|
||||
<font class="keyword">class </font>ProtectedBase { };
|
||||
<font class="comment"></font>
|
||||
<font class="comment">/*! Class that is inherited using private inheritance */</font>
|
||||
<font class="keyword">class </font>PrivateBase { };
|
||||
<font class="comment"></font>
|
||||
<font class="comment">/*! Class that is used by the Inherited class */</font>
|
||||
<font class="keyword">class </font>Used { };
|
||||
<font class="comment"></font>
|
||||
<font class="comment">/*! Super class that inherits a number of other classes */</font>
|
||||
<font class="keyword">class </font>Inherited : <font class="keyword">public</font> PublicBase,
|
||||
<font class="keyword">protected</font> ProtectedBase,
|
||||
<font class="keyword">private</font> PrivateBase,
|
||||
<font class="keyword">public</font> Undocumented
|
||||
{
|
||||
<font class="keyword">private</font>:
|
||||
Used *m_usedClass;
|
||||
};</pre></div> If the <code>MAX_DOT_GRAPH_HEIGHT</code> tag in the configuration file is set to 200 this will result in the following graph:
|
||||
<p>
|
||||
<center>
|
||||
<img src="graph_legend.gif"></center>
|
||||
|
||||
<p>
|
||||
The boxes in the above graph have the following meaning: <ul>
|
||||
<li>A filled black box represents the struct or class for which the graph is generated. <li>A box with a black border denotes a documented struct or class. <li>A box with a grey border denotes an undocumented struct or class. <li>A box with a red border denotes a documented struct or class for which not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.</ul>
|
||||
The arrows have the following meaning: <ul>
|
||||
<li>A dark blue arrow is used to visualize a public inheritance relation between two classes. <li>A dark green arrow is used for protected inheritance. <li>A dark red arrow is used for private inheritance. <li>A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible. </ul>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
102
Doxygen_files/example/index.html
Normal file
102
Doxygen_files/example/index.html
Normal file
@@ -0,0 +1,102 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairs Class Example Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>IEPairs Class Example Documentation</h1>
|
||||
<p>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
104
Doxygen_files/example/pages.html
Normal file
104
Doxygen_files/example/pages.html
Normal file
@@ -0,0 +1,104 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>IEPairsClassDocumentationExample Related Pages</h1>Here is a list of all related documentation pages:<ul>
|
||||
<li><a class="el" href="todo.html">Todo List</a>
|
||||
|
||||
</ul>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
140
Doxygen_files/example/test_8c-source.html
Normal file
140
Doxygen_files/example/test_8c-source.html
Normal file
@@ -0,0 +1,140 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>iepairs.h</h1><a href="test_8c.html">Go to the documentation of this file.</a><div class="fragment"><pre>00001 <font class="comment">//! Virtual class to allow plugin operations on entity pairs</font>
|
||||
00002 <font class="comment"></font><font class="comment">/*!</font>
|
||||
00003 <font class="comment"> \todo Write more complete documentation for this class so that it's use</font>
|
||||
00004 <font class="comment"> is clear</font>
|
||||
00005 <font class="comment"> </font>
|
||||
00006 <font class="comment"> An interface to entity keys and key pairs that allows plugins to;</font>
|
||||
00007 <font class="comment"> read and write entity keys and key values, get a key value as a</font>
|
||||
00008 <font class="comment"> vec3_t</font>
|
||||
00009 <font class="comment">*/</font>
|
||||
<a name="l00010"></a><a class="code" href="classIEpair.html">00010</a> <font class="keyword">class </font><a class="code" href="classIEpair.html">IEpair</a>
|
||||
00011 {
|
||||
00012 <font class="keyword">public</font>:<font class="comment"></font>
|
||||
00013 <font class="comment"> //! Increment the number of references to this object</font>
|
||||
00014 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a0">IncRef</a> () = 0;
|
||||
00015 <font class="comment"></font>
|
||||
00016 <font class="comment"> //! Decrement the reference count</font>
|
||||
00017 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a1">DecRef</a> () = 0;
|
||||
00018 <font class="comment"></font>
|
||||
00019 <font class="comment"> //! Get a vector from a key</font>
|
||||
00020 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a2">GetVectorForKey</a>( <font class="keywordtype">char</font>* key, vec3_t vec ) = 0;
|
||||
00021 <font class="comment"></font>
|
||||
00022 <font class="comment"> //! Get a float from a key</font>
|
||||
00023 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">float</font> <a class="code" href="classIEpair.html#a3">FloatForKey</a>( <font class="keywordtype">char</font> *key ) = 0;
|
||||
00024 <font class="comment"></font>
|
||||
00025 <font class="comment"> //! Get a string (char *) from a key</font>
|
||||
00026 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">char</font>* <a class="code" href="classIEpair.html#a4">ValueForKey</a>( <font class="keywordtype">char</font> *key ) = 0;
|
||||
00027 <font class="comment"></font>
|
||||
00028 <font class="comment"> //! Set a key value to char *value</font>
|
||||
00029 <font class="comment"></font><font class="comment"> /*!</font>
|
||||
00030 <font class="comment"> \param key The (char *) containing the keyname</font>
|
||||
00031 <font class="comment"> \param value The (char *) to set the key value to</font>
|
||||
00032 <font class="comment"> */</font>
|
||||
00033 <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a5">SetKeyValue</a>( <font class="keywordtype">char</font> *key, <font class="keywordtype">char</font> *value ) = 0;
|
||||
00034 <font class="comment"></font>
|
||||
00035 <font class="comment"> //! Get a vec3_t for the entities origin</font>
|
||||
00036 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a6">GetEntityOrigin</a>( vec3_t vec ) = 0;
|
||||
00037 <font class="comment"></font>
|
||||
00038 <font class="comment"> //! Compute the rotated bounds of the BBox based on "angle" and "angles" keys</font>
|
||||
00039 <font class="comment"></font> <font class="keyword">virtual</font> <font class="keywordtype">void</font> <a class="code" href="classIEpair.html#a7">CalculateRotatedBounds</a>( vec3_t mins, vec3_t maxs ) = 0;
|
||||
00040 };
|
||||
</pre></div>
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
107
Doxygen_files/example/test_8c.html
Normal file
107
Doxygen_files/example/test_8c.html
Normal file
@@ -0,0 +1,107 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><h1>iepairs.h File Reference</h1>
|
||||
<p>
|
||||
<a href="test_8c-source.html">Go to the source code of this file.</a><table border=0 cellpadding=0 cellspacing=0>
|
||||
<tr><td colspan=2><br><h2>Compounds</h2></td></tr>
|
||||
<tr><td nowrap align=right valign=top>class </td><td valign=bottom><a class="el" href="classIEpair.html">IEpair</a></td></tr>
|
||||
<tr><td> </td><td><font size=-1><em>Virtual class to allow plugin operations on entity pairs.</em> <a href="classIEpair.html#_details">More...</a><em></em></font><br><br></td></tr>
|
||||
</table>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
105
Doxygen_files/example/todo.html
Normal file
105
Doxygen_files/example/todo.html
Normal file
@@ -0,0 +1,105 @@
|
||||
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
||||
<html>
|
||||
<head>
|
||||
<title>IEPairsClassDocumentationExample Doxygen Documentation</title>
|
||||
<link href="doxygen_gtkradiant.css" rel="stylesheet" type="text/css">
|
||||
<meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
|
||||
</head>
|
||||
<body bgcolor="black">
|
||||
|
||||
<div align="center">
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="94%">
|
||||
<tr>
|
||||
<td>
|
||||
<img src="../images/top-title.gif" alt="" width="254" height="92">
|
||||
</td>
|
||||
<td background="../images/top-tile.gif" valign="top" align="right" width="100%">
|
||||
<br><img src="../images/history_id_logo.gif" alt="idsoftware" border="0">
|
||||
</td>
|
||||
<td align="left">
|
||||
<img src="../images/top-right.gif" alt="" width="12" height="92">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%">
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-upper-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-upper-tile.gif">
|
||||
<img border="0" src="../images/body-upper-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-upper-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td background="../images/body-left-tile.gif" height="100%"> </td>
|
||||
<td width="100%" height="100%" bgcolor="#EEEEEE" cellpadding="0" cellspacing="0" border="1"><div>
|
||||
<br><hr>
|
||||
|
||||
<center>
|
||||
<table cellpadding="0" cellspacing="0" border="0" width="95%"><tr><td>
|
||||
|
||||
<!-- ----------------- End Header ----------------- -->
|
||||
|
||||
|
||||
<!-- Generated by Doxygen 1.2.8.1 -->
|
||||
<center>
|
||||
<a class="qindex" href="index.html">Main Page</a> <a class="qindex" href="classes.html">Alphabetical List</a> <a class="qindex" href="annotated.html">Compound List</a> <a class="qindex" href="files.html">File List</a> <a class="qindex" href="functions.html">Compound Members</a> <a class="qindex" href="pages.html">Related Pages</a> </center>
|
||||
<hr><a name="todo"><h2>Todo List</h2></a>
|
||||
|
||||
<dl compact>
|
||||
<dt><a name="_todo000001"></a>Class <a class="el" href="classIEpair.html">IEpair</a> <dd>Write more complete documentation for this class so that it's use is clear
|
||||
</dl>
|
||||
|
||||
<!-- ---------------- Start Footer ----------------- -->
|
||||
</td></tr></table>
|
||||
</center>
|
||||
|
||||
<br><br>
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="1" cellspacing="0">
|
||||
<tr>
|
||||
<td width="50%">
|
||||
<i>Documentation generated by : <a href="http://www.doxygen.org">Doxygen</a> 1.2.8.1 on 11 Aug 2001</i>
|
||||
</td>
|
||||
<td align="right">
|
||||
<a href="mailto:ttimo@idsoftware.com">
|
||||
<i>ttimo@idsoftware.com</i>
|
||||
</a>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</div>
|
||||
|
||||
<br>
|
||||
<br>
|
||||
</div></td>
|
||||
<td background="../images/body-right-tile.gif" height="100%"> </td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td valign="top" align="left">
|
||||
<img src="../images/body-lower-left.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
<td valign="top" background="../images/body-lower-tile.gif">
|
||||
<img border="0" src="../images/body-lower-tile.gif" height="12" width="100%">
|
||||
</td>
|
||||
<td valign="top" align="right">
|
||||
<img src="../images/body-lower-right.gif" alt="" width="19" height="12">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</td>
|
||||
<td valign="top">
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
</div>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
159
Doxygen_files/genDoxyfile
Normal file
159
Doxygen_files/genDoxyfile
Normal file
@@ -0,0 +1,159 @@
|
||||
# Doxyfile 1.2.5-20010304
|
||||
#---------------------------------------------------------------------------
|
||||
# General configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
PROJECT_NAME =
|
||||
PROJECT_NUMBER =
|
||||
OUTPUT_DIRECTORY =
|
||||
OUTPUT_LANGUAGE = English
|
||||
EXTRACT_ALL = YES
|
||||
EXTRACT_PRIVATE = YES
|
||||
EXTRACT_STATIC = YES
|
||||
HIDE_UNDOC_MEMBERS = NO
|
||||
HIDE_UNDOC_CLASSES = NO
|
||||
BRIEF_MEMBER_DESC = YES
|
||||
REPEAT_BRIEF = YES
|
||||
ALWAYS_DETAILED_SEC = YES
|
||||
FULL_PATH_NAMES = YES
|
||||
STRIP_FROM_PATH = $(PWD)/
|
||||
INTERNAL_DOCS = YES
|
||||
CLASS_DIAGRAMS = YES
|
||||
SOURCE_BROWSER = YES
|
||||
INLINE_SOURCES = YES
|
||||
STRIP_CODE_COMMENTS = NO
|
||||
CASE_SENSE_NAMES = YES
|
||||
HIDE_SCOPE_NAMES = NO
|
||||
VERBATIM_HEADERS = YES
|
||||
SHOW_INCLUDE_FILES = YES
|
||||
JAVADOC_AUTOBRIEF = YES
|
||||
INHERIT_DOCS = YES
|
||||
INLINE_INFO = YES
|
||||
SORT_MEMBER_DOCS = YES
|
||||
DISTRIBUTE_GROUP_DOC = NO
|
||||
TAB_SIZE = 2
|
||||
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 = YES
|
||||
WARNINGS = YES
|
||||
WARN_IF_UNDOCUMENTED = YES
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
WARN_LOGFILE = doxygen.log
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the input files
|
||||
#---------------------------------------------------------------------------
|
||||
INPUT =
|
||||
FILE_PATTERNS = *.h \
|
||||
*.cpp \
|
||||
*.c
|
||||
RECURSIVE = YES
|
||||
EXCLUDE =
|
||||
EXCLUDE_PATTERNS =
|
||||
EXAMPLE_PATH =
|
||||
EXAMPLE_PATTERNS =
|
||||
IMAGE_PATH =
|
||||
INPUT_FILTER =
|
||||
FILTER_SOURCE_FILES = YES
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the alphabetical class index
|
||||
#---------------------------------------------------------------------------
|
||||
ALPHABETICAL_INDEX = YES
|
||||
COLS_IN_ALPHA_INDEX = 4
|
||||
IGNORE_PREFIX =
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the HTML output
|
||||
#---------------------------------------------------------------------------
|
||||
GENERATE_HTML = YES
|
||||
HTML_OUTPUT =
|
||||
HTML_HEADER = Doxygen_files/doxygen_gtkradiant_head.html
|
||||
HTML_FOOTER = Doxygen_files/doxygen_gtkradiant_foot.html
|
||||
HTML_STYLESHEET = Doxygen_files/doxygen_gtkradiant.css
|
||||
HTML_ALIGN_MEMBERS = YES
|
||||
GENERATE_HTMLHELP = NO
|
||||
GENERATE_CHI = NO
|
||||
BINARY_TOC = NO
|
||||
TOC_EXPAND = NO
|
||||
DISABLE_INDEX = NO
|
||||
ENUM_VALUES_PER_LINE = 4
|
||||
GENERATE_TREEVIEW = NO
|
||||
TREEVIEW_WIDTH = 250
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the LaTeX output
|
||||
#---------------------------------------------------------------------------
|
||||
GENERATE_LATEX = NO
|
||||
LATEX_OUTPUT =
|
||||
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 =
|
||||
COMPACT_RTF = NO
|
||||
RTF_HYPERLINKS = NO
|
||||
RTF_STYLESHEET_FILE =
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the man page output
|
||||
#---------------------------------------------------------------------------
|
||||
GENERATE_MAN = NO
|
||||
MAN_OUTPUT =
|
||||
MAN_EXTENSION = .3
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the preprocessor
|
||||
#---------------------------------------------------------------------------
|
||||
ENABLE_PREPROCESSING = YES
|
||||
MACRO_EXPANSION = YES
|
||||
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
|
||||
#---------------------------------------------------------------------------
|
||||
# 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 =
|
||||
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 =
|
||||
|
||||
#---------------------------------------------------------------------------
|
||||
# Include file, at the bottom to over-ride anything I missed.
|
||||
#---------------------------------------------------------------------------
|
||||
@INCLUDE = ./Doxygen_files/genConf
|
||||
421
Doxygen_files/gendoxfunctions
Normal file
421
Doxygen_files/gendoxfunctions
Normal file
@@ -0,0 +1,421 @@
|
||||
#!/bin/bash
|
||||
# Functions for the gendox script
|
||||
#
|
||||
# Gef, Aug 2001
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Set the doxygen output language from the system locale
|
||||
#------------------------------------------------------------------------
|
||||
get_language() {
|
||||
if [ -n "$LANG" ] ; then
|
||||
local LANG=`locale | grep LANG | cut -d= -f2`;
|
||||
fi
|
||||
case "$LANG" in
|
||||
czech)
|
||||
OUPUTLANGUAGE="Czech";
|
||||
;;
|
||||
german)
|
||||
OUPUTLANGUAGE="German";
|
||||
;;
|
||||
spanish)
|
||||
OUPUTLANGUAGE="Spanish";
|
||||
;;
|
||||
finnish)
|
||||
OUPUTLANGUAGE="Finnish";
|
||||
;;
|
||||
french)
|
||||
OUPUTLANGUAGE="French";
|
||||
;;
|
||||
italian)
|
||||
OUPUTLANGUAGE="Italian";
|
||||
;;
|
||||
japanese*)
|
||||
OUPUTLANGUAGE="Japanese";
|
||||
;;
|
||||
dutch)
|
||||
OUPUTLANGUAGE="Dutch";
|
||||
;;
|
||||
swedish)
|
||||
OUPUTLANGUAGE="Swedish";
|
||||
;;
|
||||
*)
|
||||
OUPUTLANGUAGE="English";
|
||||
;;
|
||||
esac
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Output usage info & output help
|
||||
#------------------------------------------------------------------------
|
||||
output_usage() {
|
||||
echo -e "Usage: $0 [<target(s)>] [-o <output_directory>]";
|
||||
return;
|
||||
}
|
||||
|
||||
output_help() {
|
||||
output_usage;
|
||||
echo -e "\nOptions:";
|
||||
echo -e " [<target(s)>]";
|
||||
echo -e " This is an optional parameter that specifies the directory, or multiple";
|
||||
echo -e " directories from which to generate the documentation.";
|
||||
echo -e "";
|
||||
echo -e " [-o <output_directory>]";
|
||||
echo -e " An optional parameter that specifies the output directory in which";
|
||||
echo -e " to save the generated documentation.";
|
||||
echo -e "";
|
||||
echo -e " -q or --quiet";
|
||||
echo -e " Prevents the output of status information"
|
||||
echo -e ""
|
||||
echo -e " --help, or -h";
|
||||
echo -e " Displays this information";
|
||||
echo -e ""
|
||||
echo -e " -q or --quiet";
|
||||
echo -e " Prevents the output of status information"
|
||||
echo -e ""
|
||||
echo -e " -k or --kill";
|
||||
echo -e " kills running doxygen pids."
|
||||
echo -e ""
|
||||
echo -e "* Further information on using this script, can be found in README.doxygen";
|
||||
echo -e "* in the current directory.";
|
||||
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Set the target to what was passed on the command line
|
||||
#------------------------------------------------------------------------
|
||||
parse_commandline() {
|
||||
# todo:
|
||||
# need to add the ability to check for an auto gen'd version
|
||||
# used for automatically generating new documentation for each commit
|
||||
# to the cvs server
|
||||
|
||||
# funky bash shell array
|
||||
declare -a OPTLIST[$#];
|
||||
|
||||
if [ $OPTCOUNT == 0 ] ; then
|
||||
# No options on the command line so set the target list to the core
|
||||
TARGETCOUNT=0;
|
||||
OUTPUTDIR="../$(basename `pwd`)-doxygen";
|
||||
else
|
||||
# put all the command line options into an array
|
||||
for f in $COMLINE ; do
|
||||
OPTLIST[$COUNTER]="$f";
|
||||
let COUNTER++;
|
||||
done
|
||||
|
||||
for (( COUNTER=0 ; $COUNTER < $OPTCOUNT; $[COUNTER++] )) ; do
|
||||
if [ "${OPTLIST[$COUNTER]}" == "--help" ] ; then
|
||||
# output usage information
|
||||
output_help;
|
||||
RETVAL=1;
|
||||
return;
|
||||
elif [ "${OPTLIST[$COUNTER]}" == "-h" ] ; then
|
||||
# output usage information
|
||||
output_help;
|
||||
RETVAL=1;
|
||||
return;
|
||||
fi
|
||||
|
||||
case ${OPTLIST[$COUNTER]} in
|
||||
-q)
|
||||
QUIETMODE=1;
|
||||
;;
|
||||
--quiet)
|
||||
QUIETMODE=1;
|
||||
;;
|
||||
-k)
|
||||
KILLON=1;
|
||||
;;
|
||||
--kill)
|
||||
KILLON=1;
|
||||
;;
|
||||
-o)
|
||||
# look for the -o switch, and get the next command line option as the output dir
|
||||
if [ -z ${OPTLIST[$COUNTER + 1]} ] ; then
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " ** Output switch used, but no output dir passed...";
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " ** Setting default output dir.";
|
||||
else
|
||||
let COUNTER++;
|
||||
OUTPUTDIR=${OPTLIST[$COUNTER]};
|
||||
fi
|
||||
break;
|
||||
;;
|
||||
**)
|
||||
# If the command line option is anything other that -o then assume it's a target
|
||||
# Check to make sure the target exists first...
|
||||
if [ -d ${OPTLIST[$COUNTER]} ] ; then
|
||||
TARGETLIST[$COUNTER]=${OPTLIST[$COUNTER]};
|
||||
else
|
||||
output_usage;
|
||||
echo -e " ** Error: Non-existent directory specified as a target.\nExiting.";
|
||||
RETVAL=1;
|
||||
return;
|
||||
fi
|
||||
let TARGETCOUNT++;
|
||||
;;
|
||||
esac
|
||||
done
|
||||
|
||||
fi # if [ $OPTCOUNT == 0 ] ;
|
||||
|
||||
if [ $TARGETCOUNT == 0 ] ; then
|
||||
TARGETCOUNT=4;
|
||||
TARGETLIST[0]="include";
|
||||
TARGETLIST[1]="libs";
|
||||
TARGETLIST[2]="radiant";
|
||||
TARGETLIST[3]="plugins";
|
||||
# Gef: outputdir for default core when no targets are passed on the command line
|
||||
# TTimo problem still there, if -o used on command line, don't override
|
||||
if [ -z $OUTPUTDIR ] ; then
|
||||
OUTPUTDIR="../$(basename `pwd`)-doxygen";
|
||||
fi
|
||||
fi
|
||||
|
||||
# Add trailing slash's to the lines that need them
|
||||
TARGETSTRING=`echo ${TARGETLIST[*]} | sed -e 's/" "/", "/'`
|
||||
[ $QUIETMODE -gt 0 ] || echo -ne " -> Set Input to: ";
|
||||
for (( COUNTER=0; COUNTER < $TARGETCOUNT ; $[COUNTER++] )) ; do
|
||||
if [ $COUNTER == $[TARGETCOUNT - 1] ] ; then
|
||||
[ $QUIETMODE -gt 0 ] || echo -ne "${TARGETLIST[$COUNTER]}\n";
|
||||
TARGETLIST[$COUNTER]="${TARGETLIST[$COUNTER]}";
|
||||
else
|
||||
[ $QUIETMODE -gt 0 ] || echo -ne "${TARGETLIST[$COUNTER]}, ";
|
||||
TARGETLIST[$COUNTER]="${TARGETLIST[$COUNTER]} \\";
|
||||
fi
|
||||
done
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " -> Set Output Dir to: $OUTPUTDIR";
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Try to extract the version number
|
||||
# todo: find a better way to determine the version
|
||||
#------------------------------------------------------------------------
|
||||
get_version() {
|
||||
VERSION=`grep PROJECT_NUMBER $DOXYCONFIG | grep -v \# | cut -d= -f2`;
|
||||
if [ -z $VERSION ] ; then
|
||||
if [ -f "./include/version.default" ] ; then # checks that we are in the right dir
|
||||
VERSION=`cat ./include/version.default`;
|
||||
else
|
||||
VERSION="(Unknown)";
|
||||
fi
|
||||
fi
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Create a projectname from the tree name
|
||||
#------------------------------------------------------------------------
|
||||
get_projectname() {
|
||||
PROJECTNAME=`grep PROJECT_NAME $DOXYCONFIG | grep -v \# | cut -d= -f2`;
|
||||
if [ -z $PROJECTNAME ] ; then
|
||||
# PROJECTNAME=`echo $TARGET | sed -e s/[^A-Za-z0-9]/!/ | cut -d! -f1`;
|
||||
PROJECTNAME="$(basename `pwd`)";
|
||||
fi
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# function to determine the path to the perl executable
|
||||
#------------------------------------------------------------------------
|
||||
get_perlpath() {
|
||||
if [ -f "$DOXYCONFIG" ] ; then
|
||||
PERLPATH=`grep PERL_PATH $DOXYCONFIG | grep = | cut -d= -f2`
|
||||
fi
|
||||
|
||||
if [ 'basename $PERLPATH &2>/dev/null' != "perl" ] ; then
|
||||
PERLPATH=`which perl 2>/dev/null | sed -e 's/perl//'`;
|
||||
elif [ 'basename $PERLPATH &2>/dev/null' != "perl" ] ; then
|
||||
PERLPATH="";
|
||||
fi
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Function to determine the path to the dot executable
|
||||
#------------------------------------------------------------------------
|
||||
get_dotpath() {
|
||||
if [ -f "$DOXYCONFIG" ] ; then
|
||||
DOTPATH=`grep DOT_PATH $DOXYCONFIG | grep = | cut -d= -f2`
|
||||
fi
|
||||
|
||||
if [ -z $DOTPATH ] || [ `basename $DOTPATH 2>/dev/null` != "dot" ] ; then
|
||||
DOTPATH=`which dot 2>/dev/null`;
|
||||
fi
|
||||
|
||||
if [ -z $DOTPATH ] || [ `basename $DOTPATH 2>/dev/null` != "dot" ] ; then
|
||||
DOTPATH="";
|
||||
HAVEDOT="No";
|
||||
echo -e "** Warning: dot not found.";
|
||||
[ $QUIETMODE -gt 0 ] || echo -e "** dot is part of the GraphVis package and is used to generate";
|
||||
[ $QUIETMODE -gt 0 ] || echo -e "** dependancy/inheritance/include (etc) diagrams.";
|
||||
[ $QUIETMODE -gt 0 ] || echo -e "** It's suggested that you install the GraphVis package for those";
|
||||
[ $QUIETMODE -gt 0 ] || echo -e "** features.";
|
||||
[ $QUIETMODE -gt 0 ] || echo -e "** GraphVis can be downloaded from www.graphvis.org";
|
||||
else
|
||||
HAVEDOT="Yes";
|
||||
DOTPATH=`echo $DOTPATH | sed -e 's/dot//'`;
|
||||
fi
|
||||
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Function to move stuff around
|
||||
#------------------------------------------------------------------------
|
||||
# eg: move the images into the output directory & the reference doc into the
|
||||
# html directory.
|
||||
# called after doxygen has finished generating documentation
|
||||
move_stuff() {
|
||||
[ $QUIETMODE -gt 0 ] || echo -ne " -> Move stuff.\n";
|
||||
if [ ! -d $OUTPUTDIR ] ; then
|
||||
mkdir $OUTPUTDIR;
|
||||
fi
|
||||
|
||||
if [ ! -d "$EXTRAS_PATH/images/" ] ; then
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " - Looking for images.";
|
||||
[ $QUIETMODE -gt 0 ] || sleep 2;
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " - I can't find the images...";
|
||||
[ $QUIETMODE -gt 0 ] || sleep 1;
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " - Where did you put the images!?";
|
||||
[ $QUIETMODE -gt 0 ] || sleep 2;
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " - They have to be here somewhere...";
|
||||
[ $QUIETMODE -gt 0 ] || sleep 1;
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " - Looking in /dev/null";
|
||||
[ $QUIETMODE -gt 0 ] || sleep 3;
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " - YOU FOOL, YOU DELETED THE IMAGES!!!";
|
||||
[ $QUIETMODE -gt 0 ] || sleep 1;
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " - I quit!";
|
||||
RETVAL=666;
|
||||
else
|
||||
if [ ! -d $OUTPUTDIR/images ] ; then
|
||||
mkdir $OUTPUTDIR/images ;
|
||||
fi
|
||||
cp $EXTRAS_PATH/images/* $OUTPUTDIR/images/ ;
|
||||
RETVAL=0;
|
||||
fi
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# clean_up() removes old versions of the documentation
|
||||
#------------------------------------------------------------------------
|
||||
clean_up() {
|
||||
if [ -f $OUTPUTDIR/html/index.html ] ; then
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " -> Trashing old dox.";
|
||||
rm -f $OUTPUTDIR/html/*
|
||||
fi
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Create a new genConf & Doxyfile
|
||||
#------------------------------------------------------------------------
|
||||
gen_doxyconfig() {
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " -> Generating DoxyConfig.";
|
||||
RETVAL=0;
|
||||
# first need to make sure there is a Doxyfile here
|
||||
if [ ! -f $DOXYFILE ] ; then
|
||||
# what now? (could generate one with 'doxygen -e Doxyfile') but it would be screwed.
|
||||
echo -e "No Doxyfile here...";
|
||||
RETVAL=3;
|
||||
return;
|
||||
else
|
||||
# Create a new doxyfile with the @INCLUDE statement including the generated stuff
|
||||
echo "`cat $DOXYFILE | grep -v @INCLUDE`" > $NEWDOXYFILE
|
||||
echo "@INCLUDE = $CONFIG_OUTPUT" >> $NEWDOXYFILE
|
||||
fi
|
||||
|
||||
# remove the old config file
|
||||
rm -f $CONFIG_OUTPUT
|
||||
|
||||
# create a new one
|
||||
touch $CONFIG_OUTPUT
|
||||
echo "# Generated configuration - Do Not Edit." >> $CONFIG_OUTPUT;
|
||||
echo "# If you want to modify options, edit DoxyConfig and re-run genconf." >> $CONFIG_OUTPUT;
|
||||
echo -e "\n" >> $CONFIG_OUTPUT;
|
||||
echo -e "PROJECT_NAME=$PROJECTNAME" >> $CONFIG_OUTPUT;
|
||||
echo -e "PROJECT_NUMBER=$VERSION" >> $CONFIG_OUTPUT;
|
||||
echo -e "PERL_PATH=$PERLPATH" >> $CONFIG_OUTPUT;
|
||||
echo -e "HAVE_DOT=$HAVEDOT" >> $CONFIG_OUTPUT;
|
||||
echo -e "DOT_PATH=$DOTPATH" >> $CONFIG_OUTPUT;
|
||||
echo -e "OUTPUT_LANGUAGE=$OUTPUTLANGUAGE" >> $CONFIG_OUTPUT;
|
||||
|
||||
echo -n "INPUT=" >> $CONFIG_OUTPUT;
|
||||
for (( COUNTER=0 ; COUNTER < $TARGETCOUNT; $[COUNTER++] )) ; do
|
||||
# echo -e "${TARGETLIST[$COUNTER]}";
|
||||
echo -e "${TARGETLIST[$COUNTER]}" >> $CONFIG_OUTPUT
|
||||
done
|
||||
# echo -e "INPUT=$TARGET" >> $CONFIG_OUTPUT;
|
||||
|
||||
echo -e "OUTPUT_DIRECTORY=$OUTPUTDIR" >> $CONFIG_OUTPUT;
|
||||
echo -e "\n" >> $CONFIG_OUTPUT;
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Build the reference page & index
|
||||
#------------------------------------------------------------------------
|
||||
build_extra_html() {
|
||||
# file locations
|
||||
REF_OUT="$OUTPUTDIR/reference/index.html"
|
||||
INDEX_OUT="$OUTPUTDIR/index.html"
|
||||
|
||||
# Make the output directory if it doesn't exist
|
||||
if [ ! -d $OUTPUTDIR/reference/ ] ; then
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " -> Making reference directory";
|
||||
mkdir $OUTPUTDIR/reference
|
||||
fi
|
||||
|
||||
# cat the files together and output the result to each file
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " -> Building reference document";
|
||||
cat $EXTRAS_PATH/doxygen_reference_head.html $EXTRAS_PATH/reference1.html $EXTRAS_PATH/doxygen_reference_foot.html > $REF_OUT;
|
||||
|
||||
if [ ! -d $OUTPUTDIR/example/ ] ; then
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " -> Making example dir";
|
||||
mkdir $OUTPUTDIR/example
|
||||
fi
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " -> Moving example docs";
|
||||
cp $EXTRAS_PATH/example/* $OUTPUTDIR/example/
|
||||
cp $EXTRAS_PATH/doxygen_gtkradiant.css $OUTPUTDIR/example/
|
||||
|
||||
# Make a redirecting index.html
|
||||
cat $EXTRAS_PATH/doxygen_index.html > $INDEX_OUT;
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# Execute doxygen
|
||||
#------------------------------------------------------------------------
|
||||
run_doxygen() {
|
||||
# copy doxy_mainpage.h to the target directory
|
||||
# pipe it through sed to add generation time/date and username - $machine
|
||||
TEMPLOCATION=`echo $TARGETSTRING | cut -d' ' -f1`;
|
||||
if [ X"$USERNAME" == "X" ] ; then
|
||||
USERNAME=`whoami`;
|
||||
fi
|
||||
MACHINE=`uname -n`; # `uname -n` or `hostname` ??
|
||||
cp $EXTRAS_PATH/doxy_mainpage.h temp.h
|
||||
cat temp.h |
|
||||
sed "s/+project+/$PROJECTNAME/" |
|
||||
sed "s|+target+|$TARGETSTRING|" |
|
||||
sed "s/+user+/$USERNAME/" |
|
||||
sed "s/+machine+/$MACHINE/" |
|
||||
sed "s/+date+/$(date '+%b %d %Y')/" > $TEMPLOCATION/doxy_mainpage.h ;
|
||||
|
||||
rm -f temp.h
|
||||
|
||||
# Start doxygen with the command "doxygen $DOXYFILE"
|
||||
[ $QUIETMODE -gt 0 ] || echo -e " -> Executing doxygen.";
|
||||
[ $QUIETMODE -gt 0 ] || echo -e "> doxygen $NEWDOXYFILE";
|
||||
doxygen $NEWDOXYFILE
|
||||
RETVAL=$?
|
||||
|
||||
# remove doxy_mainpage.h from the target directory
|
||||
rm -f $TEMPLOCATION/doxy_mainpage.h
|
||||
return;
|
||||
}
|
||||
|
||||
#------------------------------------------------------------------------
|
||||
# End.
|
||||
|
||||
BIN
Doxygen_files/images/body-left-tile.gif
Normal file
BIN
Doxygen_files/images/body-left-tile.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 94 B |
BIN
Doxygen_files/images/body-lower-left.gif
Normal file
BIN
Doxygen_files/images/body-lower-left.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 366 B |
BIN
Doxygen_files/images/body-lower-right.gif
Normal file
BIN
Doxygen_files/images/body-lower-right.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 352 B |
BIN
Doxygen_files/images/body-lower-tile.gif
Normal file
BIN
Doxygen_files/images/body-lower-tile.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 67 B |
BIN
Doxygen_files/images/body-right-tile.gif
Normal file
BIN
Doxygen_files/images/body-right-tile.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 94 B |
BIN
Doxygen_files/images/body-upper-left.gif
Normal file
BIN
Doxygen_files/images/body-upper-left.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 358 B |
BIN
Doxygen_files/images/body-upper-right.gif
Normal file
BIN
Doxygen_files/images/body-upper-right.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 362 B |
BIN
Doxygen_files/images/body-upper-tile.gif
Normal file
BIN
Doxygen_files/images/body-upper-tile.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 92 B |
BIN
Doxygen_files/images/gtkr_splash.jpg
Normal file
BIN
Doxygen_files/images/gtkr_splash.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 24 KiB |
BIN
Doxygen_files/images/gtkr_splash_sm.jpg
Normal file
BIN
Doxygen_files/images/gtkr_splash_sm.jpg
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.4 KiB |
BIN
Doxygen_files/images/history_id_logo.gif
Normal file
BIN
Doxygen_files/images/history_id_logo.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 1.4 KiB |
BIN
Doxygen_files/images/top-right.gif
Normal file
BIN
Doxygen_files/images/top-right.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 606 B |
BIN
Doxygen_files/images/top-tile.gif
Normal file
BIN
Doxygen_files/images/top-tile.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 122 B |
BIN
Doxygen_files/images/top-title.gif
Normal file
BIN
Doxygen_files/images/top-title.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 5.2 KiB |
333
Doxygen_files/reference1.html
Normal file
333
Doxygen_files/reference1.html
Normal file
@@ -0,0 +1,333 @@
|
||||
<div align="center">
|
||||
<table width="95%" cellpadding="0" cellspacing="0" border="0">
|
||||
<tr><td>
|
||||
<a href="../html/index.html">GtkRadiant Doxygen Documentation</a>
|
||||
|
||||
<a name="top"></a>
|
||||
<h1>Doxygen Quick Reference</h1>
|
||||
<hr>
|
||||
<p align="left">
|
||||
|
||||
<h2>Index</h2>
|
||||
<ol>
|
||||
<li><a href="#cs">Commenting styles</a></li>
|
||||
<li><a href="#qts">Qt Style C++ Class Example</a></li>
|
||||
<li><a href="#jds">JavaDoc Style C++ Class Example</a></li>
|
||||
<li><a href="#spt">Special Tags</a></li>
|
||||
<li><a href="#stt">Structural Tags</a></li>
|
||||
</ol>
|
||||
</p>
|
||||
|
||||
<hr>
|
||||
<a name="cs"></a>
|
||||
<h2>1. Commenting Styles</h2>
|
||||
There are two different <i>styles</i> of commenting that doxygen recognises.
|
||||
<p align="left">
|
||||
Qt Style:<br>
|
||||
<code>
|
||||
/*!<br>
|
||||
.... text ....<br>
|
||||
*/<br>
|
||||
<br>
|
||||
</code>
|
||||
Qt Style Single line<br>
|
||||
<code>
|
||||
//! .... one line of text ....<br>
|
||||
</code>
|
||||
</p>
|
||||
|
||||
<p align="left">
|
||||
JavaDoc Style:<br>
|
||||
<code>
|
||||
/**<br>
|
||||
* .... text ....<br>
|
||||
*/<br>
|
||||
</code>
|
||||
<br>
|
||||
JavaDoc Style Single line<br>
|
||||
<code>
|
||||
/// .... one line of text ....<br>
|
||||
</code>
|
||||
</p>
|
||||
|
||||
<p>
|
||||
Doxygen only allows one brief and one detailed description for each declaration/definition.
|
||||
If there is a brief description before a declaration, and one before the a definition, only
|
||||
the one before the <i>declaration</i> will be used. If the same situation occurs for a detailed
|
||||
description the one before the <i>definition</i> is preferred and the one before the declaration will
|
||||
be ignored.<br>
|
||||
A useful method is to have the brief documentation with the declaration in the header file,
|
||||
and the detailed documentation with the definition in the source file.
|
||||
<p>
|
||||
<i>Note: Standard C/C++ comments are ignored by doxygen, but will be included in the code listing
|
||||
for that file. </i>
|
||||
</p>
|
||||
</p>
|
||||
<p align="right"><a href="#top">top</a> </p>
|
||||
<hr>
|
||||
|
||||
<a name="qts"></a>
|
||||
<h2>2. Qt Style C++ Class Example</h2>
|
||||
<p>
|
||||
Here is an example of a C++ class using Qt Style documentation.<br>
|
||||
The IEpair class from include/iepairs.h is used here. The html result of using these comments
|
||||
can be found <a href="../example/index.html">here</a>.<br>
|
||||
<p>
|
||||
<i>Note: The resulting html was generated from a single file. If it were generated as part of
|
||||
the whole documentation, many of the function names and variables would be hyperlinks to
|
||||
their definitions.</i><br>
|
||||
</p>
|
||||
<pre>
|
||||
//! Virtual class to allow plugin operations on entity pairs
|
||||
/*!
|
||||
\todo Write more complete documentation for this class so that it's use
|
||||
is clear
|
||||
|
||||
An interface to entity keys and key pairs that allows plugins to;
|
||||
read and write entity keys and key values, get a key value as a
|
||||
vec3_t
|
||||
*/
|
||||
class IEpair
|
||||
{
|
||||
public:
|
||||
//! Increment the number of references to this object
|
||||
virtual void IncRef () = 0;
|
||||
|
||||
//! Decrement the reference count
|
||||
virtual void DecRef () = 0;
|
||||
|
||||
//! Get a vector from a key
|
||||
virtual void GetVectorForKey( char* key, vec3_t vec ) = 0;
|
||||
|
||||
//! Get a float from a key
|
||||
virtual float FloatForKey( char *key ) = 0;
|
||||
|
||||
//! Get a string (char *) from a key
|
||||
virtual char* ValueForKey( char *key ) = 0;
|
||||
|
||||
//! Set a key value to char *value
|
||||
/*!
|
||||
\param key The (char *) containing the keyname
|
||||
\param value The (char *) to set the key value to
|
||||
*/
|
||||
virtual void SetKeyValue( char *key, char *value ) = 0;
|
||||
|
||||
//! Get a vec3_t for the entities origin
|
||||
virtual void GetEntityOrigin( vec3_t vec ) = 0;
|
||||
|
||||
//! Compute the rotated bounds of the BBox based on "angle" and "angles" keys
|
||||
virtual void CalculateRotatedBounds( vec3_t mins, vec3_t maxs ) = 0;
|
||||
};
|
||||
</pre>
|
||||
</p>
|
||||
<p>
|
||||
<p align="right"><a href="#top">top</a> </p>
|
||||
<a name="jds"></a>
|
||||
<h2>3. JavaDoc Style C++ Class Example</h2>
|
||||
|
||||
The same class documented using JavaDoc Style comments
|
||||
<pre>
|
||||
/// Virtual class to allow plugin operations on entity pairs
|
||||
/**
|
||||
* @todo Write more complete documentation for this class so that it's use
|
||||
* is clear
|
||||
*
|
||||
* An interface to entity keys and key pairs that allows plugins to;
|
||||
* read and write entity keys and key values, get a key value as a
|
||||
* vec3_t
|
||||
*/
|
||||
class IEpair
|
||||
{
|
||||
public:
|
||||
/// Increment the number of references to this object
|
||||
virtual void IncRef () = 0;
|
||||
|
||||
/// Decrement the reference count
|
||||
virtual void DecRef () = 0;
|
||||
|
||||
/// Get a vector from a key
|
||||
virtual void GetVectorForKey( char* key, vec3_t vec ) = 0;
|
||||
|
||||
/// Get a float from a key
|
||||
virtual float FloatForKey( char *key ) = 0;
|
||||
|
||||
/// Get a string (char *) from a key
|
||||
virtual char* ValueForKey( char *key ) = 0;
|
||||
|
||||
/** Set a key value to char *value
|
||||
* @param key The (char *) containing the keyname
|
||||
* @param value The (char *) to set the key value to
|
||||
*/
|
||||
virtual void SetKeyValue( char *key, char *value ) = 0;
|
||||
|
||||
//! Get a vec3_t for the entities origin
|
||||
virtual void GetEntityOrigin( vec3_t vec ) = 0;
|
||||
|
||||
//! Compute the rotated bounds of the BBox based on "angle" and "angles" keys
|
||||
virtual void CalculateRotatedBounds( vec3_t mins, vec3_t maxs ) = 0;
|
||||
};
|
||||
</pre>
|
||||
</p>
|
||||
<p align="right"><a href="#top">top</a> </p>
|
||||
<hr>
|
||||
|
||||
<a name="spt"></a>
|
||||
<h2>4. Special Tags</h2>
|
||||
<p>
|
||||
Special tags using the Qt style begin with a " \ ", or using JavaDoc style a " @ " (the two should not be mixed).<br>
|
||||
<br>
|
||||
<b>Common special tags</b><br>
|
||||
<center>
|
||||
<table width="90%" cellpadding="4" cellspacing="2" border="0" valign="top">
|
||||
<tr><td width="10%" bgcolor="#DDDDDD" align="right">
|
||||
<b>author</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>The author or a list of comma separated authors/contributers</i>
|
||||
</td></tr><tr><td bgcolor="#CCCCCC" align="right">
|
||||
<b>see</b>
|
||||
</td><td bgcolor="#CCCCCC">
|
||||
<i>A reference to another class, class member, function, etc...</i>
|
||||
</td></tr><tr><td bgcolor="#DDDDDD" align="right">
|
||||
<b>param</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>A description of a specific function argument or parameter</i>
|
||||
</td></tr><tr><td bgcolor="#CCCCCC" align="right">
|
||||
<b>return</b>
|
||||
</td><td bgcolor="#CCCCCC">
|
||||
<i>A description of the value returned from a function/method</i>
|
||||
</td></tr><tr><td bgcolor="#DDDDDD" align="right">
|
||||
<b>bug</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>Starts a paragraph where one or more bugs may be listed.</i>
|
||||
</td></tr><tr><td bgcolor="#CCCCCC" align="right">
|
||||
<b>note</b>
|
||||
</td><td bgcolor="#CCCCCC">
|
||||
<i>Starts a paragraph where a note may be entered.</i>
|
||||
</td></tr><tr><td bgcolor="#DDDDDD" align="right">
|
||||
<b>todo</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>Starts a paragraph where a TODO item is described.</i><br>
|
||||
Note: All TODO items are collated into a separate todo list, each linking to each other
|
||||
</td></tr><tr><td bgcolor="#CCCCCC" align="right">
|
||||
<b>version</b>
|
||||
</td><td bgcolor="#CCCCCC">
|
||||
<i>Starts a paragraph where one or more version strings may be entered.</i>
|
||||
</td></tr><tr><td bgcolor="#DDDDDD" align="right">
|
||||
<b>warning</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>Starts a paragraph where one or more warning messages may be entered.</i>
|
||||
</td></tr><tr><td bgcolor="#DDDDDD" align="right">
|
||||
<b>brief</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>A single line comment in place of the //! or /// comment.</i>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</center>
|
||||
<br>
|
||||
<p align="right"><a href="#top">top</a></p>
|
||||
<hr>
|
||||
<a name="stt"></a>
|
||||
<h2>5. Structural Tags</h2>
|
||||
<p>
|
||||
These are used to document a named object, and are not required to be located near that
|
||||
object definition or declaration. This allows the documentation for an object to be located
|
||||
anywhere in the doxygen input files. The exception to this rule however, is that these
|
||||
documentation blocks cannot be within the body of a function or within C style comment blocks.
|
||||
All structural commands are preceded by either a " \ " or a " @ ", depending on the
|
||||
documentation style, and require one or more parameters to specify the name of the object
|
||||
the description is referring to.<br>
|
||||
</p>
|
||||
<p>
|
||||
An example of the \file structural tag:
|
||||
<pre>
|
||||
/*! \file iepairs.h
|
||||
\brief One line documentation for this file
|
||||
\author Author(s)
|
||||
Long description of this file
|
||||
*/
|
||||
</pre>
|
||||
</p>
|
||||
|
||||
<b>Common Structural Tags</b><br><br>
|
||||
<center>
|
||||
<table width="90%" cellpadding="4" cellspacing="2" border="0" valign="top">
|
||||
<tr><td width="10%" bgcolor="#DDDDDD" align="right">
|
||||
<b>class</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>Documents a class<br>
|
||||
eg:<code><br>
|
||||
/*! \class IEpair<br>
|
||||
\brief Short description of the IEpair class<br>
|
||||
<br>
|
||||
Detailed description of the IEpair class<br>
|
||||
*/<br>
|
||||
</code>
|
||||
</i>
|
||||
</td></tr><tr><td bgcolor="#CCCCCC" align="right">
|
||||
<b>def</b>
|
||||
</td><td bgcolor="#CCCCCC">
|
||||
<i>Describes a #define<br>
|
||||
eg:<code><br>
|
||||
/*! \def MAX_VALUE The name of the define<br>
|
||||
\brief Description of MAX_VALUE<br>
|
||||
*/<br>
|
||||
</code>
|
||||
</i>
|
||||
</td></tr><tr><td bgcolor="#DDDDDD" align="right">
|
||||
<b>file</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>Describes a file<br>
|
||||
eg:<code><br>
|
||||
/*! \file iepairs.h The name of the file<br>
|
||||
\brief Description of the file iepairs.h<br>
|
||||
<br>
|
||||
Details<br>
|
||||
*/<br>
|
||||
</code>
|
||||
</i>
|
||||
</td></tr><tr><td bgcolor="#CCCCCC" align="right">
|
||||
<b>struct</b>
|
||||
</td><td bgcolor="#CCCCCC">
|
||||
<i>Documents a struct<br>
|
||||
eg:<code><br>
|
||||
/*! \struct BTListList_t the name of the struct<br>
|
||||
\brief Description of BTListList_t<br>
|
||||
<br>
|
||||
Details<br>
|
||||
*/<br>
|
||||
</code>
|
||||
</i>
|
||||
</td></tr><tr><td bgcolor="#DDDDDD" align="right">
|
||||
<b>var</b>
|
||||
</td><td bgcolor="#DDDDDD">
|
||||
<i>Documents a typedef, variable or enum value<br>
|
||||
eg:<code><br>
|
||||
/*! \var typedef unsigned int UINT32<br>
|
||||
\brief Short description<br>
|
||||
*/<br>
|
||||
</code>
|
||||
</i>
|
||||
</td></tr><tr><td bgcolor="#CCCCCC" align="right">
|
||||
<b>fn</b>
|
||||
</td><td bgcolor="#CCCCCC">
|
||||
<i>Documents a function</i>
|
||||
eg:<code><br>
|
||||
/*! \fn virtual void IEpair::DecRef() = 0;<br>
|
||||
\brief Short description of this function<br>
|
||||
<br>
|
||||
Detailed description of this function<br>
|
||||
*/<br>
|
||||
</code>
|
||||
</i>
|
||||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
</center>
|
||||
|
||||
<br>
|
||||
<p align="right"><a href="#top">top</a> </p>
|
||||
<hr>
|
||||
</td></tr>
|
||||
</table>
|
||||
</div>
|
||||
Reference in New Issue
Block a user