Remove a number of unused CryCommon interfaces and docs related folders. (#788)
This commit is contained in:
bosnichd
GitHub
File diff suppressed because it is too large
Load Diff
@@ -1,32 +0,0 @@
|
||||
This directory contains the necessary configuration files to create the API documentation for the Lumberyard Engine.
|
||||
|
||||
The documentation for the doxygen tool can be found at:
|
||||
|
||||
http://www.stack.nl/~dimitri/doxygen/
|
||||
|
||||
The main configuration of Doxygen is found in the file:
|
||||
|
||||
Doxyfile
|
||||
|
||||
The layout of the major components in the documentation is controlled by the file:
|
||||
|
||||
layout.xml
|
||||
|
||||
Consult the doxygen documentation to understand how to modify the configuration and the layout.
|
||||
|
||||
Additionally, there in the directory doc-inputs you will find external documentation files with the suffix ".dox" and ".md".
|
||||
|
||||
.dox files are in doxygen comment format and .md files are in markdown format (See doxygen documentation for further information).
|
||||
|
||||
The three key files here are:
|
||||
|
||||
groups.dox: The module structure roughly matching the original CryEngine documentation
|
||||
auto-groups.dox Additional module structure induced from the directory structure of the source.
|
||||
index.md: A front page for the documentation.
|
||||
|
||||
There are also some key tools and files in the main directory:
|
||||
|
||||
doxfilter.py: A filter to label files with doxygen @addtogroup commands, and convert from
|
||||
DocOMatic format comments to doxygen format comments. Requires Python27 to be installed.
|
||||
makegroups.sh: A tool to construct auto-groups.dox file. Requires msys or msysgit to be installed.
|
||||
filegroups.txt: A file mapping source code paths onto groups. Used by doxyfilter.py to assign groups to source.
|
||||
@@ -1 +0,0 @@
|
||||
This is the reference documentation for the programmer APIs in the Lumberyard engine.
|
||||
@@ -1,137 +0,0 @@
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
#!/c/python27/python
|
||||
import sys
|
||||
import re
|
||||
|
||||
# Utility function to copy file contents to stdout
|
||||
def copyFileToStdout(file):
|
||||
with open(file) as f:
|
||||
for x in f:
|
||||
sys.stdout.write(x)
|
||||
|
||||
# Search the filegroups.,txt file to find what doxygen group the content of the file should belong to
|
||||
def findGroup(filename):
|
||||
lookupFile = sys.argv[1]
|
||||
lookupFile = re.sub("^.*/Code/","",lookupFile)
|
||||
lookupFile = re.sub("\.\./","",lookupFile)
|
||||
|
||||
#sys.stderr.write("Lookup {0}\n".format(lookupFile))
|
||||
group = "Default"
|
||||
with open('filegroups.txt','r') as f:
|
||||
for x in f:
|
||||
x = x.rstrip()
|
||||
p = str.split(x,':')
|
||||
if p[0] in lookupFile:
|
||||
group = p[1]
|
||||
break
|
||||
if group == "Default":
|
||||
# If there is no group specified for this file in our map, then
|
||||
# use the file structure to place it under the Default grouping for now
|
||||
group = "_" + re.sub("[\./]","_",lookupFile) + "_"
|
||||
sys.stderr.write("\nCreating new file group: {0}\n".format(group))
|
||||
return group
|
||||
|
||||
def main():
|
||||
|
||||
if "/Doxygen/" in sys.argv[1]:
|
||||
# We do nothing to files in the Doxygen source input directories
|
||||
# Just copy back to stdout in this case
|
||||
copyFileToStdout(sys.argv[1])
|
||||
else:
|
||||
processCommentBlock.counter = 0
|
||||
|
||||
# Determine what group the file is
|
||||
group = findGroup(sys.argv[1])
|
||||
|
||||
# And process the file to add the group markup
|
||||
# as well as update from DocOMatric syntax comments to doxygen
|
||||
#sys.stderr.write ("Updating file {0} to group {1}\n".format(sys.argv[1],group));
|
||||
sys.stdout.write ("/*! @addtogroup {0}\n * @{{ */\n".format(group))
|
||||
transformToDoxygen(sys.argv[1])
|
||||
sys.stdout.write("\n/*! @} */\n");
|
||||
|
||||
def transformToDoxygen(file):
|
||||
# Put together a matcher that will help us find comment blocks
|
||||
commentBlockPattern = re.compile('^[ \t]*//')
|
||||
commentTrailerPattern = re.compile('[;,][ \t]*//')
|
||||
|
||||
block=""
|
||||
with open(file,'r') as f:
|
||||
for line in f:
|
||||
# Accumulate a comment block
|
||||
if commentBlockPattern.search(line):
|
||||
block += line
|
||||
else:
|
||||
processCommentBlock(block)
|
||||
block = ""
|
||||
if commentTrailerPattern.search(line):
|
||||
line = re.sub("//","///",line,1)
|
||||
sys.stdout.write(line)
|
||||
|
||||
# output any final comment block
|
||||
processCommentBlock(block)
|
||||
|
||||
|
||||
def processCommentBlock(block):
|
||||
processCommentBlock.counter += 1
|
||||
if block != "":
|
||||
# Avoid changing the file header block into documentation
|
||||
if re.search("//[ /t]*([sS]ummary|[Dd]escription|DOC-IGNORE)",block) and processCommentBlock > 1:
|
||||
# Start out with the simple global changes
|
||||
block = re.sub("//","///",block)
|
||||
|
||||
# Get rid of some comment styles that are inserting lines into the comments
|
||||
# # e.g //-------------
|
||||
# //===========
|
||||
# //****************************
|
||||
# and so forth
|
||||
block = re.sub("///=+[ \t]*\n","///\n",block)
|
||||
block = re.sub("///-+[ \t]*\n","///\n",block)
|
||||
block = re.sub("///_+[ \t]*\n","///\n",block)
|
||||
block = re.sub("///\*+[ \t]*\n","///\n",block)
|
||||
block = re.sub("////+[ \t]*\n","///\n",block)
|
||||
|
||||
# Transform some Docomatic text values into doxygen style comments instead
|
||||
block = re.sub("///[ \t]*[Dd]escription[ \t]*:?","/// @details",block)
|
||||
block = re.sub("///[ \t]*[Ss]ummary[\t ]*:?","/// @brief ",block)
|
||||
block = re.sub("///[ \t]*[Nn]otes[\t ]*:?","/// @note ",block)
|
||||
block = re.sub("///[ \t]*[Rr]emarks[\t ]*:?","/// @remark ",block)
|
||||
block = re.sub("///[ \t]*[Ss]ee [Aa]lso[\t ]*:?","/// @sa ",block)
|
||||
block = re.sub("///[ \t]*[Rr]eturn [Vv]alue[\t ]*:?","/// @returns ",block)
|
||||
block = re.sub("///[ \t]*[Rr]eturns[\t ]*:?","/// @returns ",block)
|
||||
block = re.sub("///[ \t]*[Oo]utputs[\t ]*:?","/// @returns ",block)
|
||||
block = re.sub("///[ \t]*DOC-IGNORE-BEGIN","/// @cond IGNORE ",block);
|
||||
block = re.sub("///[ \t]*DOC-IGNORE-END","/// @endcond ",block);
|
||||
|
||||
# Now iterate and deal with input parameters. A bit trickier.
|
||||
# We want to convert things that look like parameters after one of
|
||||
# the keywords Arugments, Inputs or Parameters, leading up to the next command.
|
||||
block = block.rstrip();
|
||||
list = str.split(block,'\n')
|
||||
# Zero out block, we will rebuild it as we iterate over list
|
||||
block = ""
|
||||
inparams = 0
|
||||
for line in list:
|
||||
if re.search("// @",line):
|
||||
inparams = 0
|
||||
elif re.search("///[ \t]*([Aa]rguments|[Ii]nputs|[Pp]arameters)",line):
|
||||
line = re.sub("///.*","///",line)
|
||||
inparams = 1
|
||||
elif inparams == 1 and re.search("///[ \t]*[A-Za-z0-9_]+[ \t]*[:-]",line):
|
||||
line = re.sub("///[ \t]*","/// @param ",line)
|
||||
line = re.sub("@param[ \t]*([A-Za-z0-9_]+)[ \t]*[-:]","@param \\1 ",line)
|
||||
block += line + "\n"
|
||||
sys.stdout.write(block)
|
||||
|
||||
if __name__ == "__main__":
|
||||
main()
|
||||
|
||||
@@ -1,21 +0,0 @@
|
||||
<!-- HTML footer for doxygen 1.8.8-->
|
||||
<!-- start footer part -->
|
||||
<!--BEGIN GENERATE_TREEVIEW-->
|
||||
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||||
<ul>
|
||||
$navpath
|
||||
<li class="footer">$generatedby
|
||||
<a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/></a> $doxygenversion </li>
|
||||
</ul>
|
||||
</div>
|
||||
<!--END GENERATE_TREEVIEW-->
|
||||
<!--BEGIN !GENERATE_TREEVIEW-->
|
||||
<hr class="footer"/><address class="footer"><small>
|
||||
$generatedby  <a href="http://www.doxygen.org/index.html">
|
||||
<img class="footer" src="$relpath^doxygen.png" alt="doxygen"/>
|
||||
</a> $doxygenversion
|
||||
</small></address>
|
||||
<!--END !GENERATE_TREEVIEW-->
|
||||
</body>
|
||||
</html>
|
||||
@@ -1,55 +0,0 @@
|
||||
<!-- HTML header for doxygen 1.8.8-->
|
||||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||||
<html xmlns="http://www.w3.org/1999/xhtml">
|
||||
<head>
|
||||
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||||
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||||
<meta name="generator" content="Doxygen $doxygenversion"/>
|
||||
<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME-->
|
||||
<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/>
|
||||
<script type="text/javascript" src="$relpath^jquery.js"></script>
|
||||
<script type="text/javascript" src="$relpath^dynsections.js"></script>
|
||||
$treeview
|
||||
$search
|
||||
$mathjax
|
||||
<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
|
||||
$extrastylesheet
|
||||
</head>
|
||||
<body>
|
||||
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||||
|
||||
<!--BEGIN TITLEAREA-->
|
||||
<div id="titlearea">
|
||||
<table cellspacing="0" cellpadding="0">
|
||||
<tbody>
|
||||
<tr style="height: 56px;">
|
||||
<!--BEGIN PROJECT_LOGO-->
|
||||
<td id="projectlogo"><img alt="Logo" src="$relpath^$projectlogo"/></td>
|
||||
<!--END PROJECT_LOGO-->
|
||||
<!--BEGIN PROJECT_NAME-->
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectname">$projectname
|
||||
<!--BEGIN PROJECT_NUMBER--> <span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
|
||||
</div>
|
||||
<!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->
|
||||
</td>
|
||||
<!--END PROJECT_NAME-->
|
||||
<!--BEGIN !PROJECT_NAME-->
|
||||
<!--BEGIN PROJECT_BRIEF-->
|
||||
<td style="padding-left: 0.5em;">
|
||||
<div id="projectbrief">$projectbrief</div>
|
||||
</td>
|
||||
<!--END PROJECT_BRIEF-->
|
||||
<!--END !PROJECT_NAME-->
|
||||
<!--BEGIN DISABLE_INDEX-->
|
||||
<!--BEGIN SEARCHENGINE-->
|
||||
<td>$searchbox</td>
|
||||
<!--END SEARCHENGINE-->
|
||||
<!--END DISABLE_INDEX-->
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
<!--END TITLEAREA-->
|
||||
<!-- end header part -->
|
||||
@@ -1,194 +0,0 @@
|
||||
<doxygenlayout version="1.0">
|
||||
<!-- Generated by doxygen 1.8.8 -->
|
||||
<!-- Navigation index tabs for HTML output -->
|
||||
<navindex>
|
||||
<tab type="mainpage" visible="yes" title=""/>
|
||||
<tab type="pages" visible="yes" title="" intro=""/>
|
||||
<tab type="modules" visible="yes" title="" intro=""/>
|
||||
<tab type="namespaces" visible="yes" title="">
|
||||
<tab type="namespacelist" visible="yes" title="" intro=""/>
|
||||
<tab type="namespacemembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="classes" visible="yes" title="">
|
||||
<tab type="classlist" visible="yes" title="" intro=""/>
|
||||
<tab type="classindex" visible="$ALPHABETICAL_INDEX" title=""/>
|
||||
<tab type="hierarchy" visible="yes" title="" intro=""/>
|
||||
<tab type="classmembers" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="files" visible="yes" title="">
|
||||
<tab type="filelist" visible="yes" title="" intro=""/>
|
||||
<tab type="globals" visible="yes" title="" intro=""/>
|
||||
</tab>
|
||||
<tab type="examples" visible="yes" title="" intro=""/>
|
||||
</navindex>
|
||||
|
||||
<!-- Layout definition for a class page -->
|
||||
<class>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<inheritancegraph visible="$CLASS_GRAPH"/>
|
||||
<collaborationgraph visible="$COLLABORATION_GRAPH"/>
|
||||
<memberdecl>
|
||||
<nestedclasses visible="yes" title=""/>
|
||||
<publictypes title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<publicslots title=""/>
|
||||
<signals title=""/>
|
||||
<publicmethods title=""/>
|
||||
<publicstaticmethods title=""/>
|
||||
<publicattributes title=""/>
|
||||
<publicstaticattributes title=""/>
|
||||
<protectedtypes title=""/>
|
||||
<protectedslots title=""/>
|
||||
<protectedmethods title=""/>
|
||||
<protectedstaticmethods title=""/>
|
||||
<protectedattributes title=""/>
|
||||
<protectedstaticattributes title=""/>
|
||||
<packagetypes title=""/>
|
||||
<packagemethods title=""/>
|
||||
<packagestaticmethods title=""/>
|
||||
<packageattributes title=""/>
|
||||
<packagestaticattributes title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
<privatetypes title=""/>
|
||||
<privateslots title=""/>
|
||||
<privatemethods title=""/>
|
||||
<privatestaticmethods title=""/>
|
||||
<privateattributes title=""/>
|
||||
<privatestaticattributes title=""/>
|
||||
<friends title=""/>
|
||||
<related title="" subtitle=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<services title=""/>
|
||||
<interfaces title=""/>
|
||||
<constructors title=""/>
|
||||
<functions title=""/>
|
||||
<related title=""/>
|
||||
<variables title=""/>
|
||||
<properties title=""/>
|
||||
<events title=""/>
|
||||
</memberdef>
|
||||
<allmemberslink visible="yes"/>
|
||||
<usedfiles visible="$SHOW_USED_FILES"/>
|
||||
<authorsection visible="yes"/>
|
||||
</class>
|
||||
|
||||
<!-- Layout definition for a namespace page -->
|
||||
<namespace>
|
||||
<briefdescription visible="yes"/>
|
||||
<memberdecl>
|
||||
<nestednamespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</namespace>
|
||||
|
||||
<!-- Layout definition for a file page -->
|
||||
<file>
|
||||
<briefdescription visible="yes"/>
|
||||
<includes visible="$SHOW_INCLUDE_FILES"/>
|
||||
<includegraph visible="$INCLUDE_GRAPH"/>
|
||||
<includedbygraph visible="$INCLUDED_BY_GRAPH"/>
|
||||
<sourcelink visible="yes"/>
|
||||
<memberdecl>
|
||||
<classes visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<constantgroups visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
</memberdef>
|
||||
<authorsection/>
|
||||
</file>
|
||||
|
||||
<!-- Layout definition for a group page -->
|
||||
<group>
|
||||
<briefdescription visible="yes"/>
|
||||
<groupgraph visible="$GROUP_GRAPHS"/>
|
||||
<memberdecl>
|
||||
<nestedgroups visible="yes" title=""/>
|
||||
<dirs visible="yes" title=""/>
|
||||
<files visible="yes" title=""/>
|
||||
<namespaces visible="yes" title=""/>
|
||||
<classes visible="yes" title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
<membergroups visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
<memberdef>
|
||||
<pagedocs/>
|
||||
<inlineclasses title=""/>
|
||||
<defines title=""/>
|
||||
<typedefs title=""/>
|
||||
<enums title=""/>
|
||||
<enumvalues title=""/>
|
||||
<functions title=""/>
|
||||
<variables title=""/>
|
||||
<signals title=""/>
|
||||
<publicslots title=""/>
|
||||
<protectedslots title=""/>
|
||||
<privateslots title=""/>
|
||||
<events title=""/>
|
||||
<properties title=""/>
|
||||
<friends title=""/>
|
||||
</memberdef>
|
||||
<authorsection visible="yes"/>
|
||||
</group>
|
||||
|
||||
<!-- Layout definition for a directory page -->
|
||||
<directory>
|
||||
<briefdescription visible="yes"/>
|
||||
<directorygraph visible="yes"/>
|
||||
<memberdecl>
|
||||
<dirs visible="yes"/>
|
||||
<files visible="yes"/>
|
||||
</memberdecl>
|
||||
<detaileddescription title=""/>
|
||||
</directory>
|
||||
</doxygenlayout>
|
||||
@@ -1,35 +0,0 @@
|
||||
#!/bin/sh
|
||||
|
||||
#
|
||||
# All or portions of this file Copyright (c) Amazon.com, Inc. or its affiliates or
|
||||
# its licensors.
|
||||
#
|
||||
# For complete copyright and license terms please see the LICENSE at the root of this
|
||||
# distribution (the "License"). All use of this software is governed by the License,
|
||||
# or, if provided, by the license below or the license accompanying this file. Do not
|
||||
# remove or modify any license notices. This file is distributed on an "AS IS" BASIS,
|
||||
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
#
|
||||
# Original file Copyright Crytek GMBH or its affiliates, used under license.
|
||||
#
|
||||
|
||||
(cd ../../CryEngine; find CryCommon -type d | sort -r) >tmp.dirs
|
||||
(cd ../../CryEngine; find CryAction -type d | sort -r) >>tmp.dirs
|
||||
|
||||
awk '{ group = $1;
|
||||
gsub(/[\.\/]/,"_",group);
|
||||
print $1 ": " group
|
||||
}' tmp.dirs >group-filter.txt
|
||||
|
||||
awk '{ group = $1;
|
||||
gsub(/[\.\/]/,"_",group);
|
||||
M = split($1,parts,"/");
|
||||
parent = parts[1]
|
||||
for (i = 2; i < M; i++) {
|
||||
parent = parent "_" parts[i]
|
||||
}
|
||||
print "/*! @defgroup " group " " parts[M]
|
||||
print " * @ingroup " parent
|
||||
print " */"
|
||||
}' tmp.dirs >doc-inputs/auto-groups.dox
|
||||
rm tmp.dirs
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user