aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/doc
diff options
context:
space:
mode:
authoronefang2019-08-23 09:48:29 +1000
committeronefang2019-08-23 09:48:29 +1000
commit35b9e38c17ce04d07ea6e926a405dc7c060b6ea3 (patch)
tree68d4fe3dee53d15b5b11f81e430d473340c10170 /doc
parentconfig/ROBUST/RobustExtra.ini (diff)
downloadopensim-SC_OLD-35b9e38c17ce04d07ea6e926a405dc7c060b6ea3.zip
opensim-SC_OLD-35b9e38c17ce04d07ea6e926a405dc7c060b6ea3.tar.gz
opensim-SC_OLD-35b9e38c17ce04d07ea6e926a405dc7c060b6ea3.tar.bz2
opensim-SC_OLD-35b9e38c17ce04d07ea6e926a405dc7c060b6ea3.tar.xz
Shuffle some coder level docs to it's own directory.
Diffstat (limited to 'doc')
-rw-r--r--doc/README20
-rw-r--r--doc/doxygen.conf290
2 files changed, 0 insertions, 310 deletions
diff --git a/doc/README b/doc/README
deleted file mode 100644
index 9c95557..0000000
--- a/doc/README
+++ /dev/null
@@ -1,20 +0,0 @@
1README
2
3This directory does not currently contain any OpenSimulator user level documentation. Such
4documentation can be found at
5
6http://opensimulator.org
7
8instead.
9
10Rather, this directory can contain source-code documentation as generated via the doxygen package.
11
12To do this, either execute
13
14doxygen doxygen.conf
15
16on the command line or run the target
17
18nant doxygen
19
20if you have nant installed.
diff --git a/doc/doxygen.conf b/doc/doxygen.conf
deleted file mode 100644
index 148de9c..0000000
--- a/doc/doxygen.conf
+++ /dev/null
@@ -1,290 +0,0 @@
1# Doxyfile 1.8.2
2
3#---------------------------------------------------------------------------
4# Project related configuration options
5#---------------------------------------------------------------------------
6DOXYFILE_ENCODING = UTF-8
7PROJECT_NAME = OpenSim
8PROJECT_NUMBER = GIT
9PROJECT_BRIEF =
10PROJECT_LOGO =
11OUTPUT_DIRECTORY =
12CREATE_SUBDIRS = NO
13OUTPUT_LANGUAGE = English
14BRIEF_MEMBER_DESC = YES
15REPEAT_BRIEF = YES
16ABBREVIATE_BRIEF =
17ALWAYS_DETAILED_SEC = NO
18INLINE_INHERITED_MEMB = NO
19FULL_PATH_NAMES = YES
20STRIP_FROM_PATH =
21STRIP_FROM_INC_PATH =
22SHORT_NAMES = NO
23JAVADOC_AUTOBRIEF = NO
24QT_AUTOBRIEF = NO
25MULTILINE_CPP_IS_BRIEF = NO
26INHERIT_DOCS = YES
27SEPARATE_MEMBER_PAGES = NO
28TAB_SIZE = 8
29ALIASES =
30TCL_SUBST =
31OPTIMIZE_OUTPUT_FOR_C = NO
32OPTIMIZE_OUTPUT_JAVA = NO
33OPTIMIZE_FOR_FORTRAN = NO
34OPTIMIZE_OUTPUT_VHDL = NO
35EXTENSION_MAPPING =
36MARKDOWN_SUPPORT = YES
37AUTOLINK_SUPPORT = YES
38BUILTIN_STL_SUPPORT = NO
39CPP_CLI_SUPPORT = NO
40SIP_SUPPORT = NO
41IDL_PROPERTY_SUPPORT = YES
42DISTRIBUTE_GROUP_DOC = NO
43SUBGROUPING = YES
44INLINE_GROUPED_CLASSES = NO
45INLINE_SIMPLE_STRUCTS = NO
46TYPEDEF_HIDES_STRUCT = NO
47SYMBOL_CACHE_SIZE = 0
48LOOKUP_CACHE_SIZE = 0
49#---------------------------------------------------------------------------
50# Build related configuration options
51#---------------------------------------------------------------------------
52EXTRACT_ALL = YES
53EXTRACT_PRIVATE = NO
54EXTRACT_PACKAGE = NO
55EXTRACT_STATIC = NO
56EXTRACT_LOCAL_CLASSES = YES
57EXTRACT_LOCAL_METHODS = NO
58EXTRACT_ANON_NSPACES = NO
59HIDE_UNDOC_MEMBERS = NO
60HIDE_UNDOC_CLASSES = NO
61HIDE_FRIEND_COMPOUNDS = NO
62HIDE_IN_BODY_DOCS = NO
63INTERNAL_DOCS = NO
64CASE_SENSE_NAMES = YES
65HIDE_SCOPE_NAMES = NO
66SHOW_INCLUDE_FILES = YES
67FORCE_LOCAL_INCLUDES = NO
68INLINE_INFO = YES
69SORT_MEMBER_DOCS = YES
70SORT_BRIEF_DOCS = NO
71SORT_MEMBERS_CTORS_1ST = NO
72SORT_GROUP_NAMES = NO
73SORT_BY_SCOPE_NAME = NO
74STRICT_PROTO_MATCHING = NO
75GENERATE_TODOLIST = YES
76GENERATE_TESTLIST = YES
77GENERATE_BUGLIST = YES
78GENERATE_DEPRECATEDLIST= YES
79ENABLED_SECTIONS =
80MAX_INITIALIZER_LINES = 30
81SHOW_USED_FILES = YES
82SHOW_FILES = YES
83SHOW_NAMESPACES = YES
84FILE_VERSION_FILTER =
85LAYOUT_FILE =
86CITE_BIB_FILES =
87#---------------------------------------------------------------------------
88# configuration options related to warning and progress messages
89#---------------------------------------------------------------------------
90QUIET = NO
91WARNINGS = YES
92WARN_IF_UNDOCUMENTED = YES
93WARN_IF_DOC_ERROR = YES
94WARN_NO_PARAMDOC = NO
95WARN_FORMAT = "$file:$line: $text"
96WARN_LOGFILE = doxygen.error.log
97#---------------------------------------------------------------------------
98# configuration options related to the input files
99#---------------------------------------------------------------------------
100INPUT = ../OpenSim
101INPUT_ENCODING = UTF-8
102FILE_PATTERNS =
103RECURSIVE = YES
104EXCLUDE =
105EXCLUDE_SYMLINKS = NO
106EXCLUDE_PATTERNS =
107EXCLUDE_SYMBOLS =
108EXAMPLE_PATH =
109EXAMPLE_PATTERNS =
110EXAMPLE_RECURSIVE = NO
111IMAGE_PATH =
112INPUT_FILTER =
113FILTER_PATTERNS =
114FILTER_SOURCE_FILES = NO
115FILTER_SOURCE_PATTERNS =
116#---------------------------------------------------------------------------
117# configuration options related to source browsing
118#---------------------------------------------------------------------------
119SOURCE_BROWSER = NO
120INLINE_SOURCES = NO
121STRIP_CODE_COMMENTS = YES
122REFERENCED_BY_RELATION = NO
123REFERENCES_RELATION = NO
124REFERENCES_LINK_SOURCE = YES
125USE_HTAGS = NO
126VERBATIM_HEADERS = YES
127#---------------------------------------------------------------------------
128# configuration options related to the alphabetical class index
129#---------------------------------------------------------------------------
130ALPHABETICAL_INDEX = NO
131COLS_IN_ALPHA_INDEX = 5
132IGNORE_PREFIX =
133#---------------------------------------------------------------------------
134# configuration options related to the HTML output
135#---------------------------------------------------------------------------
136GENERATE_HTML = YES
137HTML_OUTPUT = html
138HTML_FILE_EXTENSION = .html
139HTML_HEADER =
140HTML_FOOTER =
141HTML_STYLESHEET =
142HTML_EXTRA_STYLESHEET =
143HTML_EXTRA_FILES =
144HTML_COLORSTYLE_HUE = 220
145HTML_COLORSTYLE_SAT = 100
146HTML_COLORSTYLE_GAMMA = 80
147HTML_TIMESTAMP = YES
148HTML_DYNAMIC_SECTIONS = NO
149HTML_INDEX_NUM_ENTRIES = 100
150GENERATE_DOCSET = NO
151DOCSET_FEEDNAME = "OpenSimulator docs"
152DOCSET_BUNDLE_ID = org.opensimulator.OpenSim
153DOCSET_PUBLISHER_ID = org.opensimulator.OpenSim
154DOCSET_PUBLISHER_NAME = OpenSim
155GENERATE_HTMLHELP = NO
156CHM_FILE =
157HHC_LOCATION =
158GENERATE_CHI = NO
159CHM_INDEX_ENCODING =
160BINARY_TOC = NO
161TOC_EXPAND = NO
162GENERATE_QHP = NO
163QCH_FILE =
164QHP_NAMESPACE = org.opensimulator.OpenSim
165QHP_VIRTUAL_FOLDER = doc
166QHP_CUST_FILTER_NAME =
167QHP_CUST_FILTER_ATTRS =
168QHP_SECT_FILTER_ATTRS =
169QHG_LOCATION =
170GENERATE_ECLIPSEHELP = NO
171ECLIPSE_DOC_ID = org.opensimulator.OpenSim
172DISABLE_INDEX = NO
173GENERATE_TREEVIEW = NO
174ENUM_VALUES_PER_LINE = 4
175TREEVIEW_WIDTH = 250
176EXT_LINKS_IN_WINDOW = NO
177FORMULA_FONTSIZE = 10
178FORMULA_TRANSPARENT = YES
179USE_MATHJAX = NO
180MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest
181MATHJAX_EXTENSIONS =
182SEARCHENGINE = YES
183SERVER_BASED_SEARCH = NO
184#---------------------------------------------------------------------------
185# configuration options related to the LaTeX output
186#---------------------------------------------------------------------------
187GENERATE_LATEX = NO
188LATEX_OUTPUT = latex
189LATEX_CMD_NAME = latex
190MAKEINDEX_CMD_NAME = makeindex
191COMPACT_LATEX = NO
192PAPER_TYPE = a4wide
193EXTRA_PACKAGES =
194LATEX_HEADER =
195LATEX_FOOTER =
196PDF_HYPERLINKS = YES
197USE_PDFLATEX = YES
198LATEX_BATCHMODE = NO
199LATEX_HIDE_INDICES = NO
200LATEX_SOURCE_CODE = NO
201LATEX_BIB_STYLE = plain
202#---------------------------------------------------------------------------
203# configuration options related to the RTF output
204#---------------------------------------------------------------------------
205GENERATE_RTF = NO
206RTF_OUTPUT = rtf
207COMPACT_RTF = NO
208RTF_HYPERLINKS = NO
209RTF_STYLESHEET_FILE =
210RTF_EXTENSIONS_FILE =
211#---------------------------------------------------------------------------
212# configuration options related to the man page output
213#---------------------------------------------------------------------------
214GENERATE_MAN = NO
215MAN_OUTPUT = man
216MAN_EXTENSION = .3
217MAN_LINKS = NO
218#---------------------------------------------------------------------------
219# configuration options related to the XML output
220#---------------------------------------------------------------------------
221GENERATE_XML = NO
222XML_OUTPUT = xml
223XML_SCHEMA =
224XML_DTD =
225XML_PROGRAMLISTING = YES
226#---------------------------------------------------------------------------
227# configuration options for the AutoGen Definitions output
228#---------------------------------------------------------------------------
229GENERATE_AUTOGEN_DEF = NO
230#---------------------------------------------------------------------------
231# configuration options related to the Perl module output
232#---------------------------------------------------------------------------
233GENERATE_PERLMOD = NO
234PERLMOD_LATEX = NO
235PERLMOD_PRETTY = YES
236PERLMOD_MAKEVAR_PREFIX =
237#---------------------------------------------------------------------------
238# Configuration options related to the preprocessor
239#---------------------------------------------------------------------------
240ENABLE_PREPROCESSING = YES
241MACRO_EXPANSION = NO
242EXPAND_ONLY_PREDEF = NO
243SEARCH_INCLUDES = YES
244INCLUDE_PATH =
245INCLUDE_FILE_PATTERNS =
246PREDEFINED =
247EXPAND_AS_DEFINED =
248SKIP_FUNCTION_MACROS = YES
249#---------------------------------------------------------------------------
250# Configuration::additions related to external references
251#---------------------------------------------------------------------------
252TAGFILES =
253GENERATE_TAGFILE =
254ALLEXTERNALS = NO
255EXTERNAL_GROUPS = YES
256PERL_PATH = /usr/bin/perl
257#---------------------------------------------------------------------------
258# Configuration options related to the dot tool
259#---------------------------------------------------------------------------
260CLASS_DIAGRAMS = YES
261MSCGEN_PATH =
262HIDE_UNDOC_RELATIONS = YES
263HAVE_DOT = NO
264DOT_NUM_THREADS = 0
265DOT_FONTNAME = Helvetica
266DOT_FONTSIZE = 10
267DOT_FONTPATH =
268CLASS_GRAPH = YES
269COLLABORATION_GRAPH = YES
270GROUP_GRAPHS = YES
271UML_LOOK = NO
272UML_LIMIT_NUM_FIELDS = 10
273TEMPLATE_RELATIONS = NO
274INCLUDE_GRAPH = YES
275INCLUDED_BY_GRAPH = YES
276CALL_GRAPH = NO
277CALLER_GRAPH = NO
278GRAPHICAL_HIERARCHY = YES
279DIRECTORY_GRAPH = YES
280DOT_IMAGE_FORMAT = png
281INTERACTIVE_SVG = NO
282DOT_PATH =
283DOTFILE_DIRS =
284MSCFILE_DIRS =
285DOT_GRAPH_MAX_NODES = 50
286MAX_DOT_GRAPH_DEPTH = 0
287DOT_TRANSPARENT = YES
288DOT_MULTI_TARGETS = NO
289GENERATE_LEGEND = YES
290DOT_CLEANUP = YES