From 35b9e38c17ce04d07ea6e926a405dc7c060b6ea3 Mon Sep 17 00:00:00 2001 From: onefang Date: Fri, 23 Aug 2019 09:48:29 +1000 Subject: Shuffle some coder level docs to it's own directory. --- BUILDING.md | 46 -------- TESTING.txt | 74 ------------- TODO.txt | 68 ------------ coderDocs/BUILDING.md | 46 ++++++++ coderDocs/README | 14 +++ coderDocs/TESTING.txt | 74 +++++++++++++ coderDocs/TODO.txt | 68 ++++++++++++ coderDocs/doxygen.conf | 290 +++++++++++++++++++++++++++++++++++++++++++++++++ doc/README | 20 ---- doc/doxygen.conf | 290 ------------------------------------------------- 10 files changed, 492 insertions(+), 498 deletions(-) delete mode 100644 BUILDING.md delete mode 100644 TESTING.txt delete mode 100644 TODO.txt create mode 100644 coderDocs/BUILDING.md create mode 100644 coderDocs/README create mode 100644 coderDocs/TESTING.txt create mode 100644 coderDocs/TODO.txt create mode 100644 coderDocs/doxygen.conf delete mode 100644 doc/README delete mode 100644 doc/doxygen.conf diff --git a/BUILDING.md b/BUILDING.md deleted file mode 100644 index 233fa08..0000000 --- a/BUILDING.md +++ /dev/null @@ -1,46 +0,0 @@ -# Building on Windows - -Steps: - * runprebuild.bat - * Load OpenSim.sln into Visual Studio .NET and build the solution. - * chdir bin - * copy OpenSim.ini.example to OpenSim.ini and other appropriate files in ../../config/config-include - * run OpenSim.exe - -# Building on Linux - -Prereqs: -* Mono >= 2.4.3 -* Nant >= 0.85 -* On some Linux distributions you may need to install additional packages. - See http://opensimulator.org/wiki/Dependencies for more information. -* May also use xbuild (included in mono distributions) -* May use Monodevelop, a cross-platform IDE - -From the distribution type: - * ./runprebuild.sh - * nant (or !* xbuild) - * cd bin - * copy OpenSim.ini.example to OpenSim.ini and other appropriate files in ../../config/config-include - * run mono OpenSim.exe - !* xbuild option switches - !* clean: xbuild /target:clean - !* debug: (default) xbuild /property:Configuration=Debug - !* release: xbuild /property:Configuration=Release - -# Using Monodevelop - -From the distribution type: - * ./runprebuild.sh - * type monodevelop OpenSim.sln - -# References - -Helpful resources: -* http://opensimulator.org/wiki/Build_Instructions - - -# For Devuan ASCII (and likely Debian Stretch) - - * xbuild /p:TargetFrameworkVersion="v4.5" - diff --git a/TESTING.txt b/TESTING.txt deleted file mode 100644 index da9dd60..0000000 --- a/TESTING.txt +++ /dev/null @@ -1,74 +0,0 @@ -= The Quick Guide to OpenSim Unit Testing = - -== Running Tests == - -On Linux you will need to have NUnit installed (http://www.nunit.org). -This is commonly available in distribution package repositories. - -When this is installed, run the command - - > nant test - -Please see the TESTING ON WINDOWS section below for Windows instructions. - -== Adding Tests == - -Tests should not be added to production assemblies. They should -instead be added to assemblies of the name -My.Production.Assembly.Tests.dll. This lets them easily be removed -from production environments that don't want the bloat. - -Tests should be as close to the code as possible. It is recommended -that if you are writing tests they end up in a "Tests" sub-directory -of the directory where the code you are testing resides. - -If you have added a new test assembly that hasn't existed before you -must list it in both ".nant/local.include" -for it to be accessible to Linux users and to the continuous -integration system. - -== TESTING ON WINDOWS == - -To use nunit testing on opensim code, you have a variety of methods. The -easiast methods involve using IDE capabilities to test code. Using -VS2005/2008 I recommend using the testing capabilities of Resharper(commercial) -or TestDriven.Net(free). Both will recognize nunit tests within your -application and allow you to test them individually, or all at once, etc. You -will also be able to step into debug mode into a test through these add-ins -enabling a developer to jump right in and see how a specific -test-case/scenerio works. - -Additionally, it is my understanding that sharpdevelop and monodevelop have -their own nunit testing plugins within their IDE. Though I am not certain of -their exact feature set or stability. - -== Using NUnit Directly == -The NUnit project is a very mature testing application. It can be obtained -from www.nunit.org are via various package distrobutions for Linux. Please be -sure to get a .Net 2.0 version of Nunit, as OpenSim makes use of .Net 2.0 -functionality. - -Nunit comes with 2 tools that will enable you to run tests from assembly -inputs. Nunit-gui and nunit-console. NUnit-gui is a console that will let -you view the execution of various tests within your assemblies and give visual -indication of teir success or failure. This is a useful tool for those who -lack IDE addins ( or lack IDEs at all ). - -Nunit console allows you to execute the nunit tests of assemblies via console. -Its output will show test failures and successes and a summary of what -happened. This is very useful for a quick overview and/or automated testing. - -=== Windows === -Windows version of nunit-console is by default .Net 2.0 if you downloaded the -.Net 2.0 version of Nunit. Be sure to setup your PATH environment variable. - -=== Linux & OSX === -On these operating systems you will have to use the command "nunit-console2" - -=== Example === - -nunit-console2 OpenSim.Framework.Tests.dll (on linux) -nunit-console OpenSim.Framework.Tests.dll (on windows) - -See the file OpenSim/Data/Tests/Resources/TestDataConnections.ini -for information to setup testing for data diff --git a/TODO.txt b/TODO.txt deleted file mode 100644 index 2d53a2f..0000000 --- a/TODO.txt +++ /dev/null @@ -1,68 +0,0 @@ -Still to do - - -Clean up the configs. - Why do we have Include-Common, Include-modules, Include-osslEnable, Include-Architecture, Include-Storage, Include-*Cache ?????? - It only looks for "Include-". - Maybe move bin/assets and bin/inventory out of tree as well? - -save iar password check. - Check against the users password, and all the gods passwords. - -osForceSit() add a popup asking permission. - And with the os*animation, ossetspeed, ... - - - There was a showstopper, forgot what it is. lol - - - -Paths - -------- - -cd /opt/opensim-0.9.0.1_MG/current/bin -mono Robust.exe -inidirectory=/opt/opensim-0.9.0.1_MG/config/ROBUST -mono OpenSim.exe -inidirectory=/opt/opensim-0.9.0.1_MG/config/sim05 - -/usr/bin/mono /opt/opensim/current/bin/Robust.exe -logconfig=/opt/opensim/config/ROBUST/Robust.exe.config -inifile=/opt/opensim/config/ROBUST/Robust.ini - - - # When each .ini file is read, it's includes get added to the end of the list of .ini files to read - # -inimaster is read first, the defaults - # -inifile is read next, defaults to OpenSim.ini - # -inidirectory files are read next, in some random order - # include files are read last - # This is the problem, coz files included from earlier get to overide later files. - # Which is really against all that is holy. - -/usr/bin/mono /opt/opensim/current/bin/OpenSim.exe -logconfig=/opt/opensim/config/sim07/OpenSim.exe.config -inifile=/opt/opensim/config/OpenSim.ini -inidirectory=/opt/opensim/config/sim07 - - -Name ----- - -UnifiedKidsGrids -SledjChisel, the version where we chisel away at OpenSim until it's all gone and is now SledjHamr. B-) - SledjChisl? - - - -Old TODO --------- - -FIX BUGS - - -Zarro boogs! - - -NEW FEATURES - - -In [Startup] there is this - - ; To run a script every few minutes, set the script filename here - ; timer_Script = "filename" -Could do things with that perhaps. - - -In [Startup] there is this - - ; Simulator Stats URI - ; Enable JSON simulator data by setting a URI name (case sensitive) - ; Stats_URI = "jsonSimStats" diff --git a/coderDocs/BUILDING.md b/coderDocs/BUILDING.md new file mode 100644 index 0000000..233fa08 --- /dev/null +++ b/coderDocs/BUILDING.md @@ -0,0 +1,46 @@ +# Building on Windows + +Steps: + * runprebuild.bat + * Load OpenSim.sln into Visual Studio .NET and build the solution. + * chdir bin + * copy OpenSim.ini.example to OpenSim.ini and other appropriate files in ../../config/config-include + * run OpenSim.exe + +# Building on Linux + +Prereqs: +* Mono >= 2.4.3 +* Nant >= 0.85 +* On some Linux distributions you may need to install additional packages. + See http://opensimulator.org/wiki/Dependencies for more information. +* May also use xbuild (included in mono distributions) +* May use Monodevelop, a cross-platform IDE + +From the distribution type: + * ./runprebuild.sh + * nant (or !* xbuild) + * cd bin + * copy OpenSim.ini.example to OpenSim.ini and other appropriate files in ../../config/config-include + * run mono OpenSim.exe + !* xbuild option switches + !* clean: xbuild /target:clean + !* debug: (default) xbuild /property:Configuration=Debug + !* release: xbuild /property:Configuration=Release + +# Using Monodevelop + +From the distribution type: + * ./runprebuild.sh + * type monodevelop OpenSim.sln + +# References + +Helpful resources: +* http://opensimulator.org/wiki/Build_Instructions + + +# For Devuan ASCII (and likely Debian Stretch) + + * xbuild /p:TargetFrameworkVersion="v4.5" + diff --git a/coderDocs/README b/coderDocs/README new file mode 100644 index 0000000..6e94d1e --- /dev/null +++ b/coderDocs/README @@ -0,0 +1,14 @@ +README + +This directory does not currently contain any OpenSimulator user level +documentation. Such documentation can be found at http://opensimulator.org +instead. + +Rather, this directory can contain source-code documentation as generated +via the doxygen package, and some other coder level documentation. + +To do this, execute - + +doxygen doxygen.conf + +on the command line. diff --git a/coderDocs/TESTING.txt b/coderDocs/TESTING.txt new file mode 100644 index 0000000..da9dd60 --- /dev/null +++ b/coderDocs/TESTING.txt @@ -0,0 +1,74 @@ += The Quick Guide to OpenSim Unit Testing = + +== Running Tests == + +On Linux you will need to have NUnit installed (http://www.nunit.org). +This is commonly available in distribution package repositories. + +When this is installed, run the command + + > nant test + +Please see the TESTING ON WINDOWS section below for Windows instructions. + +== Adding Tests == + +Tests should not be added to production assemblies. They should +instead be added to assemblies of the name +My.Production.Assembly.Tests.dll. This lets them easily be removed +from production environments that don't want the bloat. + +Tests should be as close to the code as possible. It is recommended +that if you are writing tests they end up in a "Tests" sub-directory +of the directory where the code you are testing resides. + +If you have added a new test assembly that hasn't existed before you +must list it in both ".nant/local.include" +for it to be accessible to Linux users and to the continuous +integration system. + +== TESTING ON WINDOWS == + +To use nunit testing on opensim code, you have a variety of methods. The +easiast methods involve using IDE capabilities to test code. Using +VS2005/2008 I recommend using the testing capabilities of Resharper(commercial) +or TestDriven.Net(free). Both will recognize nunit tests within your +application and allow you to test them individually, or all at once, etc. You +will also be able to step into debug mode into a test through these add-ins +enabling a developer to jump right in and see how a specific +test-case/scenerio works. + +Additionally, it is my understanding that sharpdevelop and monodevelop have +their own nunit testing plugins within their IDE. Though I am not certain of +their exact feature set or stability. + +== Using NUnit Directly == +The NUnit project is a very mature testing application. It can be obtained +from www.nunit.org are via various package distrobutions for Linux. Please be +sure to get a .Net 2.0 version of Nunit, as OpenSim makes use of .Net 2.0 +functionality. + +Nunit comes with 2 tools that will enable you to run tests from assembly +inputs. Nunit-gui and nunit-console. NUnit-gui is a console that will let +you view the execution of various tests within your assemblies and give visual +indication of teir success or failure. This is a useful tool for those who +lack IDE addins ( or lack IDEs at all ). + +Nunit console allows you to execute the nunit tests of assemblies via console. +Its output will show test failures and successes and a summary of what +happened. This is very useful for a quick overview and/or automated testing. + +=== Windows === +Windows version of nunit-console is by default .Net 2.0 if you downloaded the +.Net 2.0 version of Nunit. Be sure to setup your PATH environment variable. + +=== Linux & OSX === +On these operating systems you will have to use the command "nunit-console2" + +=== Example === + +nunit-console2 OpenSim.Framework.Tests.dll (on linux) +nunit-console OpenSim.Framework.Tests.dll (on windows) + +See the file OpenSim/Data/Tests/Resources/TestDataConnections.ini +for information to setup testing for data diff --git a/coderDocs/TODO.txt b/coderDocs/TODO.txt new file mode 100644 index 0000000..2d53a2f --- /dev/null +++ b/coderDocs/TODO.txt @@ -0,0 +1,68 @@ +Still to do - + +Clean up the configs. + Why do we have Include-Common, Include-modules, Include-osslEnable, Include-Architecture, Include-Storage, Include-*Cache ?????? + It only looks for "Include-". + Maybe move bin/assets and bin/inventory out of tree as well? + +save iar password check. + Check against the users password, and all the gods passwords. + +osForceSit() add a popup asking permission. + And with the os*animation, ossetspeed, ... + + + There was a showstopper, forgot what it is. lol + + + +Paths - +------- + +cd /opt/opensim-0.9.0.1_MG/current/bin +mono Robust.exe -inidirectory=/opt/opensim-0.9.0.1_MG/config/ROBUST +mono OpenSim.exe -inidirectory=/opt/opensim-0.9.0.1_MG/config/sim05 + +/usr/bin/mono /opt/opensim/current/bin/Robust.exe -logconfig=/opt/opensim/config/ROBUST/Robust.exe.config -inifile=/opt/opensim/config/ROBUST/Robust.ini + + + # When each .ini file is read, it's includes get added to the end of the list of .ini files to read + # -inimaster is read first, the defaults + # -inifile is read next, defaults to OpenSim.ini + # -inidirectory files are read next, in some random order + # include files are read last + # This is the problem, coz files included from earlier get to overide later files. + # Which is really against all that is holy. + +/usr/bin/mono /opt/opensim/current/bin/OpenSim.exe -logconfig=/opt/opensim/config/sim07/OpenSim.exe.config -inifile=/opt/opensim/config/OpenSim.ini -inidirectory=/opt/opensim/config/sim07 + + +Name +---- + +UnifiedKidsGrids +SledjChisel, the version where we chisel away at OpenSim until it's all gone and is now SledjHamr. B-) + SledjChisl? + + + +Old TODO +-------- + +FIX BUGS - + +Zarro boogs! + + +NEW FEATURES - + +In [Startup] there is this - + ; To run a script every few minutes, set the script filename here + ; timer_Script = "filename" +Could do things with that perhaps. + + +In [Startup] there is this - + ; Simulator Stats URI + ; Enable JSON simulator data by setting a URI name (case sensitive) + ; Stats_URI = "jsonSimStats" diff --git a/coderDocs/doxygen.conf b/coderDocs/doxygen.conf new file mode 100644 index 0000000..148de9c --- /dev/null +++ b/coderDocs/doxygen.conf @@ -0,0 +1,290 @@ +# Doxyfile 1.8.2 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +DOXYFILE_ENCODING = UTF-8 +PROJECT_NAME = OpenSim +PROJECT_NUMBER = GIT +PROJECT_BRIEF = +PROJECT_LOGO = +OUTPUT_DIRECTORY = +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +QT_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +INHERIT_DOCS = YES +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +TCL_SUBST = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +OPTIMIZE_FOR_FORTRAN = NO +OPTIMIZE_OUTPUT_VHDL = NO +EXTENSION_MAPPING = +MARKDOWN_SUPPORT = YES +AUTOLINK_SUPPORT = YES +BUILTIN_STL_SUPPORT = NO +CPP_CLI_SUPPORT = NO +SIP_SUPPORT = NO +IDL_PROPERTY_SUPPORT = YES +DISTRIBUTE_GROUP_DOC = NO +SUBGROUPING = YES +INLINE_GROUPED_CLASSES = NO +INLINE_SIMPLE_STRUCTS = NO +TYPEDEF_HIDES_STRUCT = NO +SYMBOL_CACHE_SIZE = 0 +LOOKUP_CACHE_SIZE = 0 +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_PACKAGE = NO +EXTRACT_STATIC = NO +EXTRACT_LOCAL_CLASSES = YES +EXTRACT_LOCAL_METHODS = NO +EXTRACT_ANON_NSPACES = NO +HIDE_UNDOC_MEMBERS = NO +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = NO +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +FORCE_LOCAL_INCLUDES = NO +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +SORT_BRIEF_DOCS = NO +SORT_MEMBERS_CTORS_1ST = NO +SORT_GROUP_NAMES = NO +SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = YES +SHOW_FILES = YES +SHOW_NAMESPACES = YES +FILE_VERSION_FILTER = +LAYOUT_FILE = +CITE_BIB_FILES = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = doxygen.error.log +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../OpenSim +INPUT_ENCODING = UTF-8 +FILE_PATTERNS = +RECURSIVE = YES +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = NO +REFERENCES_RELATION = NO +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = NO +VERBATIM_HEADERS = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_EXTRA_STYLESHEET = +HTML_EXTRA_FILES = +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 +HTML_TIMESTAMP = YES +HTML_DYNAMIC_SECTIONS = NO +HTML_INDEX_NUM_ENTRIES = 100 +GENERATE_DOCSET = NO +DOCSET_FEEDNAME = "OpenSimulator docs" +DOCSET_BUNDLE_ID = org.opensimulator.OpenSim +DOCSET_PUBLISHER_ID = org.opensimulator.OpenSim +DOCSET_PUBLISHER_NAME = OpenSim +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +CHM_INDEX_ENCODING = +BINARY_TOC = NO +TOC_EXPAND = NO +GENERATE_QHP = NO +QCH_FILE = +QHP_NAMESPACE = org.opensimulator.OpenSim +QHP_VIRTUAL_FOLDER = doc +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = +GENERATE_ECLIPSEHELP = NO +ECLIPSE_DOC_ID = org.opensimulator.OpenSim +DISABLE_INDEX = NO +GENERATE_TREEVIEW = NO +ENUM_VALUES_PER_LINE = 4 +TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = NO +FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES +USE_MATHJAX = NO +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest +MATHJAX_EXTENSIONS = +SEARCHENGINE = YES +SERVER_BASED_SEARCH = NO +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +LATEX_FOOTER = +PDF_HYPERLINKS = YES +USE_PDFLATEX = YES +LATEX_BATCHMODE = NO +LATEX_HIDE_INDICES = NO +LATEX_SOURCE_CODE = NO +LATEX_BIB_STYLE = plain +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +MSCGEN_PATH = +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = NO +DOT_NUM_THREADS = 0 +DOT_FONTNAME = Helvetica +DOT_FONTSIZE = 10 +DOT_FONTPATH = +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +UML_LIMIT_NUM_FIELDS = 10 +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +CALLER_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png +INTERACTIVE_SVG = NO +DOT_PATH = +DOTFILE_DIRS = +MSCFILE_DIRS = +DOT_GRAPH_MAX_NODES = 50 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = YES +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES diff --git a/doc/README b/doc/README deleted file mode 100644 index 9c95557..0000000 --- a/doc/README +++ /dev/null @@ -1,20 +0,0 @@ -README - -This directory does not currently contain any OpenSimulator user level documentation. Such -documentation can be found at - -http://opensimulator.org - -instead. - -Rather, this directory can contain source-code documentation as generated via the doxygen package. - -To do this, either execute - -doxygen doxygen.conf - -on the command line or run the target - -nant doxygen - -if 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 @@ -# Doxyfile 1.8.2 - -#--------------------------------------------------------------------------- -# Project related configuration options -#--------------------------------------------------------------------------- -DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = OpenSim -PROJECT_NUMBER = GIT -PROJECT_BRIEF = -PROJECT_LOGO = -OUTPUT_DIRECTORY = -CREATE_SUBDIRS = NO -OUTPUT_LANGUAGE = English -BRIEF_MEMBER_DESC = YES -REPEAT_BRIEF = YES -ABBREVIATE_BRIEF = -ALWAYS_DETAILED_SEC = NO -INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = YES -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = -SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO -QT_AUTOBRIEF = NO -MULTILINE_CPP_IS_BRIEF = NO -INHERIT_DOCS = YES -SEPARATE_MEMBER_PAGES = NO -TAB_SIZE = 8 -ALIASES = -TCL_SUBST = -OPTIMIZE_OUTPUT_FOR_C = NO -OPTIMIZE_OUTPUT_JAVA = NO -OPTIMIZE_FOR_FORTRAN = NO -OPTIMIZE_OUTPUT_VHDL = NO -EXTENSION_MAPPING = -MARKDOWN_SUPPORT = YES -AUTOLINK_SUPPORT = YES -BUILTIN_STL_SUPPORT = NO -CPP_CLI_SUPPORT = NO -SIP_SUPPORT = NO -IDL_PROPERTY_SUPPORT = YES -DISTRIBUTE_GROUP_DOC = NO -SUBGROUPING = YES -INLINE_GROUPED_CLASSES = NO -INLINE_SIMPLE_STRUCTS = NO -TYPEDEF_HIDES_STRUCT = NO -SYMBOL_CACHE_SIZE = 0 -LOOKUP_CACHE_SIZE = 0 -#--------------------------------------------------------------------------- -# Build related configuration options -#--------------------------------------------------------------------------- -EXTRACT_ALL = YES -EXTRACT_PRIVATE = NO -EXTRACT_PACKAGE = NO -EXTRACT_STATIC = NO -EXTRACT_LOCAL_CLASSES = YES -EXTRACT_LOCAL_METHODS = NO -EXTRACT_ANON_NSPACES = NO -HIDE_UNDOC_MEMBERS = NO -HIDE_UNDOC_CLASSES = NO -HIDE_FRIEND_COMPOUNDS = NO -HIDE_IN_BODY_DOCS = NO -INTERNAL_DOCS = NO -CASE_SENSE_NAMES = YES -HIDE_SCOPE_NAMES = NO -SHOW_INCLUDE_FILES = YES -FORCE_LOCAL_INCLUDES = NO -INLINE_INFO = YES -SORT_MEMBER_DOCS = YES -SORT_BRIEF_DOCS = NO -SORT_MEMBERS_CTORS_1ST = NO -SORT_GROUP_NAMES = NO -SORT_BY_SCOPE_NAME = NO -STRICT_PROTO_MATCHING = NO -GENERATE_TODOLIST = YES -GENERATE_TESTLIST = YES -GENERATE_BUGLIST = YES -GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = -MAX_INITIALIZER_LINES = 30 -SHOW_USED_FILES = YES -SHOW_FILES = YES -SHOW_NAMESPACES = YES -FILE_VERSION_FILTER = -LAYOUT_FILE = -CITE_BIB_FILES = -#--------------------------------------------------------------------------- -# configuration options related to warning and progress messages -#--------------------------------------------------------------------------- -QUIET = NO -WARNINGS = YES -WARN_IF_UNDOCUMENTED = YES -WARN_IF_DOC_ERROR = YES -WARN_NO_PARAMDOC = NO -WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = doxygen.error.log -#--------------------------------------------------------------------------- -# configuration options related to the input files -#--------------------------------------------------------------------------- -INPUT = ../OpenSim -INPUT_ENCODING = UTF-8 -FILE_PATTERNS = -RECURSIVE = YES -EXCLUDE = -EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = -EXAMPLE_PATTERNS = -EXAMPLE_RECURSIVE = NO -IMAGE_PATH = -INPUT_FILTER = -FILTER_PATTERNS = -FILTER_SOURCE_FILES = NO -FILTER_SOURCE_PATTERNS = -#--------------------------------------------------------------------------- -# configuration options related to source browsing -#--------------------------------------------------------------------------- -SOURCE_BROWSER = NO -INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES -REFERENCED_BY_RELATION = NO -REFERENCES_RELATION = NO -REFERENCES_LINK_SOURCE = YES -USE_HTAGS = NO -VERBATIM_HEADERS = YES -#--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index -#--------------------------------------------------------------------------- -ALPHABETICAL_INDEX = NO -COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = -#--------------------------------------------------------------------------- -# configuration options related to the HTML output -#--------------------------------------------------------------------------- -GENERATE_HTML = YES -HTML_OUTPUT = html -HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = -HTML_EXTRA_STYLESHEET = -HTML_EXTRA_FILES = -HTML_COLORSTYLE_HUE = 220 -HTML_COLORSTYLE_SAT = 100 -HTML_COLORSTYLE_GAMMA = 80 -HTML_TIMESTAMP = YES -HTML_DYNAMIC_SECTIONS = NO -HTML_INDEX_NUM_ENTRIES = 100 -GENERATE_DOCSET = NO -DOCSET_FEEDNAME = "OpenSimulator docs" -DOCSET_BUNDLE_ID = org.opensimulator.OpenSim -DOCSET_PUBLISHER_ID = org.opensimulator.OpenSim -DOCSET_PUBLISHER_NAME = OpenSim -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = -GENERATE_CHI = NO -CHM_INDEX_ENCODING = -BINARY_TOC = NO -TOC_EXPAND = NO -GENERATE_QHP = NO -QCH_FILE = -QHP_NAMESPACE = org.opensimulator.OpenSim -QHP_VIRTUAL_FOLDER = doc -QHP_CUST_FILTER_NAME = -QHP_CUST_FILTER_ATTRS = -QHP_SECT_FILTER_ATTRS = -QHG_LOCATION = -GENERATE_ECLIPSEHELP = NO -ECLIPSE_DOC_ID = org.opensimulator.OpenSim -DISABLE_INDEX = NO -GENERATE_TREEVIEW = NO -ENUM_VALUES_PER_LINE = 4 -TREEVIEW_WIDTH = 250 -EXT_LINKS_IN_WINDOW = NO -FORMULA_FONTSIZE = 10 -FORMULA_TRANSPARENT = YES -USE_MATHJAX = NO -MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest -MATHJAX_EXTENSIONS = -SEARCHENGINE = YES -SERVER_BASED_SEARCH = NO -#--------------------------------------------------------------------------- -# configuration options related to the LaTeX output -#--------------------------------------------------------------------------- -GENERATE_LATEX = NO -LATEX_OUTPUT = latex -LATEX_CMD_NAME = latex -MAKEINDEX_CMD_NAME = makeindex -COMPACT_LATEX = NO -PAPER_TYPE = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = -LATEX_FOOTER = -PDF_HYPERLINKS = YES -USE_PDFLATEX = YES -LATEX_BATCHMODE = NO -LATEX_HIDE_INDICES = NO -LATEX_SOURCE_CODE = NO -LATEX_BIB_STYLE = plain -#--------------------------------------------------------------------------- -# configuration options related to the RTF output -#--------------------------------------------------------------------------- -GENERATE_RTF = NO -RTF_OUTPUT = rtf -COMPACT_RTF = NO -RTF_HYPERLINKS = NO -RTF_STYLESHEET_FILE = -RTF_EXTENSIONS_FILE = -#--------------------------------------------------------------------------- -# configuration options related to the man page output -#--------------------------------------------------------------------------- -GENERATE_MAN = NO -MAN_OUTPUT = man -MAN_EXTENSION = .3 -MAN_LINKS = NO -#--------------------------------------------------------------------------- -# configuration options related to the XML output -#--------------------------------------------------------------------------- -GENERATE_XML = NO -XML_OUTPUT = xml -XML_SCHEMA = -XML_DTD = -XML_PROGRAMLISTING = YES -#--------------------------------------------------------------------------- -# configuration options for the AutoGen Definitions output -#--------------------------------------------------------------------------- -GENERATE_AUTOGEN_DEF = NO -#--------------------------------------------------------------------------- -# configuration options related to the Perl module output -#--------------------------------------------------------------------------- -GENERATE_PERLMOD = NO -PERLMOD_LATEX = NO -PERLMOD_PRETTY = YES -PERLMOD_MAKEVAR_PREFIX = -#--------------------------------------------------------------------------- -# Configuration options related to the preprocessor -#--------------------------------------------------------------------------- -ENABLE_PREPROCESSING = YES -MACRO_EXPANSION = NO -EXPAND_ONLY_PREDEF = NO -SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = -PREDEFINED = -EXPAND_AS_DEFINED = -SKIP_FUNCTION_MACROS = YES -#--------------------------------------------------------------------------- -# Configuration::additions related to external references -#--------------------------------------------------------------------------- -TAGFILES = -GENERATE_TAGFILE = -ALLEXTERNALS = NO -EXTERNAL_GROUPS = YES -PERL_PATH = /usr/bin/perl -#--------------------------------------------------------------------------- -# Configuration options related to the dot tool -#--------------------------------------------------------------------------- -CLASS_DIAGRAMS = YES -MSCGEN_PATH = -HIDE_UNDOC_RELATIONS = YES -HAVE_DOT = NO -DOT_NUM_THREADS = 0 -DOT_FONTNAME = Helvetica -DOT_FONTSIZE = 10 -DOT_FONTPATH = -CLASS_GRAPH = YES -COLLABORATION_GRAPH = YES -GROUP_GRAPHS = YES -UML_LOOK = NO -UML_LIMIT_NUM_FIELDS = 10 -TEMPLATE_RELATIONS = NO -INCLUDE_GRAPH = YES -INCLUDED_BY_GRAPH = YES -CALL_GRAPH = NO -CALLER_GRAPH = NO -GRAPHICAL_HIERARCHY = YES -DIRECTORY_GRAPH = YES -DOT_IMAGE_FORMAT = png -INTERACTIVE_SVG = NO -DOT_PATH = -DOTFILE_DIRS = -MSCFILE_DIRS = -DOT_GRAPH_MAX_NODES = 50 -MAX_DOT_GRAPH_DEPTH = 0 -DOT_TRANSPARENT = YES -DOT_MULTI_TARGETS = NO -GENERATE_LEGEND = YES -DOT_CLEANUP = YES -- cgit v1.1