mirror of
https://github.com/opencv/opencv.git
synced 2024-12-16 02:19:12 +08:00
415668ecf0
1) Document GFrame/MediaFrame (and also other G-API types) - Added doxygen comments for GMat, GScalar, GArray<T>, GOpaque classes; - Documented GFrame and its host-side counterpart MediaFrame; - Added some more notes to the data type classes. 2) Give @brief descriptions to most of the cv::gapi::* namespaces 3) Make some symbols private - These structures are mainly internal and shouldn't be used directly
307 lines
11 KiB
Plaintext
307 lines
11 KiB
Plaintext
DOXYFILE_ENCODING = UTF-8
|
|
PROJECT_NAME = OpenCV
|
|
PROJECT_NUMBER = @OPENCV_VERSION@
|
|
PROJECT_BRIEF = "Open Source Computer Vision"
|
|
PROJECT_LOGO = @CMAKE_CURRENT_SOURCE_DIR@/opencv-logo-small.png
|
|
OUTPUT_DIRECTORY = @CMAKE_DOXYGEN_OUTPUT_PATH@
|
|
CREATE_SUBDIRS = YES
|
|
OUTPUT_LANGUAGE = English
|
|
BRIEF_MEMBER_DESC = YES
|
|
REPEAT_BRIEF = YES
|
|
ABBREVIATE_BRIEF = "The $name class" \
|
|
"The $name widget" \
|
|
"The $name file" \
|
|
is \
|
|
provides \
|
|
specifies \
|
|
contains \
|
|
represents \
|
|
a \
|
|
an \
|
|
the
|
|
ALWAYS_DETAILED_SEC = NO
|
|
INLINE_INHERITED_MEMB = NO
|
|
FULL_PATH_NAMES = YES
|
|
STRIP_FROM_PATH = @CMAKE_SOURCE_DIR@/modules @CMAKE_DOXYGEN_INCLUDE_ROOTS@
|
|
STRIP_FROM_INC_PATH = @CMAKE_DOXYGEN_INCLUDE_ROOTS@
|
|
SHORT_NAMES = NO
|
|
JAVADOC_AUTOBRIEF = NO
|
|
QT_AUTOBRIEF = NO
|
|
MULTILINE_CPP_IS_BRIEF = NO
|
|
INHERIT_DOCS = YES
|
|
SEPARATE_MEMBER_PAGES = NO
|
|
TAB_SIZE = 4
|
|
ALIASES += add_toggle{1}="@htmlonly[block] <div class='newInnerHTML'>\1</div><div> <script type='text/javascript'> addToggle(); </script>@endhtmlonly"
|
|
ALIASES += add_toggle_cpp="@htmlonly[block] <div class='newInnerHTML' title='cpp' style='display: none;'>C++</div><div class='toggleable_div label_cpp' style='display: none;'>@endhtmlonly"
|
|
ALIASES += add_toggle_java="@htmlonly[block] <div class='newInnerHTML' title='java' style='display: none;'>Java</div><div class='toggleable_div label_java' style='display: none;'>@endhtmlonly"
|
|
ALIASES += add_toggle_python="@htmlonly[block] <div class='newInnerHTML' title='python' style='display: none;'>Python</div><div class='toggleable_div label_python' style='display: none;'>@endhtmlonly"
|
|
ALIASES += end_toggle="@htmlonly[block] </div> @endhtmlonly"
|
|
ALIASES += prev_tutorial{1}="**Prev Tutorial:** \ref \1 \n"
|
|
ALIASES += next_tutorial{1}="**Next Tutorial:** \ref \1 \n"
|
|
ALIASES += youtube{1}="@htmlonly[block]<div align='center'><iframe title='Video' width='560' height='349' src='https://www.youtube.com/embed/\1?rel=0' frameborder='0' align='middle' allowfullscreen></iframe></div>@endhtmlonly"
|
|
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 = YES
|
|
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 = YES
|
|
LOOKUP_CACHE_SIZE = 0
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_PRIVATE = NO
|
|
EXTRACT_PACKAGE = NO
|
|
EXTRACT_STATIC = YES
|
|
EXTRACT_LOCAL_CLASSES = NO
|
|
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
|
|
SHOW_GROUPED_MEMB_INC = YES
|
|
FORCE_LOCAL_INCLUDES = NO
|
|
INLINE_INFO = YES
|
|
SORT_MEMBER_DOCS = YES
|
|
SORT_BRIEF_DOCS = YES
|
|
SORT_MEMBERS_CTORS_1ST = YES
|
|
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 = @CMAKE_DOXYGEN_ENABLED_SECTIONS@
|
|
MAX_INITIALIZER_LINES = 30
|
|
SHOW_USED_FILES = YES
|
|
SHOW_FILES = YES
|
|
SHOW_NAMESPACES = YES
|
|
FILE_VERSION_FILTER =
|
|
LAYOUT_FILE = @CMAKE_DOXYGEN_LAYOUT@
|
|
CITE_BIB_FILES = @CMAKE_EXTRA_BIB_FILES@
|
|
QUIET = YES
|
|
WARNINGS = YES
|
|
WARN_IF_UNDOCUMENTED = YES
|
|
WARN_IF_DOC_ERROR = YES
|
|
WARN_NO_PARAMDOC = NO
|
|
WARN_FORMAT = "$file:$line: $text"
|
|
WARN_LOGFILE =
|
|
INPUT = @CMAKE_DOXYGEN_INPUT_LIST@
|
|
INPUT_ENCODING = UTF-8
|
|
FILE_PATTERNS =
|
|
RECURSIVE = YES
|
|
EXCLUDE = @CMAKE_DOXYGEN_EXCLUDE_LIST@
|
|
EXCLUDE_SYMLINKS = NO
|
|
EXCLUDE_PATTERNS = *.inl.hpp *.impl.hpp *_detail.hpp */cudev/**/detail/*.hpp *.m */opencl/runtime/* */legacy/* *_c.h @DOXYGEN_EXCLUDE_PATTERNS@
|
|
EXCLUDE_SYMBOLS = cv::DataType<*> cv::traits::* int void CV__* T __CV* cv::gapi::detail*
|
|
EXAMPLE_PATH = @CMAKE_DOXYGEN_EXAMPLE_PATH@
|
|
EXAMPLE_PATTERNS = *
|
|
EXAMPLE_RECURSIVE = YES
|
|
IMAGE_PATH = @CMAKE_DOXYGEN_IMAGE_PATH@
|
|
INPUT_FILTER =
|
|
FILTER_PATTERNS =
|
|
FILTER_SOURCE_FILES = NO
|
|
FILTER_SOURCE_PATTERNS =
|
|
USE_MDFILE_AS_MAINPAGE =
|
|
SOURCE_BROWSER = NO
|
|
INLINE_SOURCES = NO
|
|
STRIP_CODE_COMMENTS = YES
|
|
REFERENCED_BY_RELATION = NO
|
|
REFERENCES_RELATION = NO
|
|
REFERENCES_LINK_SOURCE = YES
|
|
SOURCE_TOOLTIPS = YES
|
|
USE_HTAGS = NO
|
|
VERBATIM_HEADERS = NO
|
|
ALPHABETICAL_INDEX = YES
|
|
COLS_IN_ALPHA_INDEX = 5
|
|
IGNORE_PREFIX =
|
|
GENERATE_HTML = YES
|
|
HTML_OUTPUT = html
|
|
HTML_FILE_EXTENSION = .html
|
|
HTML_HEADER = @CMAKE_CURRENT_SOURCE_DIR@/header.html
|
|
HTML_FOOTER = @CMAKE_CURRENT_SOURCE_DIR@/footer.html
|
|
HTML_STYLESHEET =
|
|
HTML_EXTRA_STYLESHEET = @CMAKE_CURRENT_SOURCE_DIR@/stylesheet.css
|
|
HTML_EXTRA_FILES = @CMAKE_DOXYGEN_HTML_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 = "Doxygen generated docs"
|
|
DOCSET_BUNDLE_ID = org.doxygen.Project
|
|
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
|
|
DOCSET_PUBLISHER_NAME = Publisher
|
|
GENERATE_HTMLHELP = NO
|
|
CHM_FILE =
|
|
HHC_LOCATION =
|
|
GENERATE_CHI = NO
|
|
CHM_INDEX_ENCODING =
|
|
BINARY_TOC = NO
|
|
TOC_EXPAND = NO
|
|
GENERATE_QHP = @CMAKE_DOXYGEN_GENERATE_QHP@
|
|
QCH_FILE = ../opencv-@OPENCV_VERSION@.qch
|
|
QHP_NAMESPACE = org.opencv.@OPENCV_VERSION@
|
|
QHP_VIRTUAL_FOLDER = opencv
|
|
QHP_CUST_FILTER_NAME =
|
|
QHP_CUST_FILTER_ATTRS =
|
|
QHP_SECT_FILTER_ATTRS =
|
|
QHG_LOCATION =
|
|
GENERATE_ECLIPSEHELP = NO
|
|
ECLIPSE_DOC_ID = org.doxygen.Project
|
|
DISABLE_INDEX = NO
|
|
GENERATE_TREEVIEW = NO
|
|
ENUM_VALUES_PER_LINE = 1
|
|
TREEVIEW_WIDTH = 250
|
|
EXT_LINKS_IN_WINDOW = YES
|
|
FORMULA_FONTSIZE = 14
|
|
FORMULA_TRANSPARENT = YES
|
|
USE_MATHJAX = YES
|
|
MATHJAX_FORMAT = HTML-CSS
|
|
MATHJAX_RELPATH = @OPENCV_MATHJAX_RELPATH@
|
|
MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols
|
|
MATHJAX_CODEFILE = @CMAKE_CURRENT_SOURCE_DIR@/mymath.js
|
|
SEARCHENGINE = YES
|
|
SERVER_BASED_SEARCH = NO
|
|
EXTERNAL_SEARCH = NO
|
|
SEARCHENGINE_URL =
|
|
SEARCHDATA_FILE = searchdata.xml
|
|
EXTERNAL_SEARCH_ID =
|
|
EXTRA_SEARCH_MAPPINGS =
|
|
GENERATE_LATEX = NO
|
|
LATEX_OUTPUT = latex
|
|
LATEX_CMD_NAME = latex
|
|
MAKEINDEX_CMD_NAME = makeindex
|
|
COMPACT_LATEX = NO
|
|
PAPER_TYPE = a4
|
|
EXTRA_PACKAGES = mymath
|
|
LATEX_HEADER =
|
|
LATEX_FOOTER =
|
|
LATEX_EXTRA_FILES =
|
|
PDF_HYPERLINKS = YES
|
|
USE_PDFLATEX = YES
|
|
LATEX_BATCHMODE = NO
|
|
LATEX_HIDE_INDICES = NO
|
|
LATEX_SOURCE_CODE = NO
|
|
LATEX_BIB_STYLE = plain
|
|
GENERATE_RTF = NO
|
|
RTF_OUTPUT = rtf
|
|
COMPACT_RTF = NO
|
|
RTF_HYPERLINKS = NO
|
|
RTF_STYLESHEET_FILE =
|
|
RTF_EXTENSIONS_FILE =
|
|
GENERATE_MAN = NO
|
|
MAN_OUTPUT = man
|
|
MAN_EXTENSION = .3
|
|
MAN_LINKS = NO
|
|
GENERATE_XML = NO
|
|
XML_OUTPUT = xml
|
|
XML_PROGRAMLISTING = YES
|
|
GENERATE_DOCBOOK = NO
|
|
DOCBOOK_OUTPUT = docbook
|
|
GENERATE_AUTOGEN_DEF = NO
|
|
GENERATE_PERLMOD = NO
|
|
PERLMOD_LATEX = NO
|
|
PERLMOD_PRETTY = YES
|
|
PERLMOD_MAKEVAR_PREFIX =
|
|
ENABLE_PREPROCESSING = YES
|
|
MACRO_EXPANSION = YES
|
|
EXPAND_ONLY_PREDEF = NO
|
|
SEARCH_INCLUDES = YES
|
|
INCLUDE_PATH =
|
|
INCLUDE_FILE_PATTERNS =
|
|
PREDEFINED = __cplusplus=1 \
|
|
CVAPI(x)=x \
|
|
CV_API_CALL= \
|
|
CV_DOXYGEN= \
|
|
CV_EXPORTS= \
|
|
CV_EXPORTS_W= \
|
|
CV_EXPORTS_W_SIMPLE= \
|
|
CV_EXPORTS_AS(x)= \
|
|
CV_EXPORTS_W_MAP= \
|
|
GAPI_EXPORTS= \
|
|
GAPI_EXPORTS_W= \
|
|
CV_IN_OUT= \
|
|
CV_OUT= \
|
|
CV_PROP= \
|
|
CV_PROP_RW= \
|
|
CV_WRAP= \
|
|
CV_WRAP_AS(x)= \
|
|
CV_WRAP_MAPPABLE(x)= \
|
|
CV_WRAP_PHANTOM(x)= \
|
|
CV_WRAP_DEFAULT(x)= \
|
|
CV_CDECL= \
|
|
CV_Func= \
|
|
CV_DO_PRAGMA(x)= \
|
|
CV_SUPPRESS_DEPRECATED_START= \
|
|
CV_SUPPRESS_DEPRECATED_END= \
|
|
CV_INLINE= \
|
|
CV_NORETURN= \
|
|
CV_DEFAULT(x)=" = x" \
|
|
CV_NEON=1 \
|
|
CV_SSE2=1 \
|
|
CV_SIMD128=1 \
|
|
CV_SIMD256=1 \
|
|
CV_SIMD512=1 \
|
|
CV_SIMD128_64F=1 \
|
|
CV_SIMD256_64F=1 \
|
|
CV_SIMD512_64F=1 \
|
|
CV__DEBUG_NS_BEGIN= \
|
|
CV__DEBUG_NS_END= \
|
|
CV_DEPRECATED_EXTERNAL= \
|
|
CV_DEPRECATED=
|
|
EXPAND_AS_DEFINED =
|
|
SKIP_FUNCTION_MACROS = YES
|
|
TAGFILES =
|
|
GENERATE_TAGFILE = @CMAKE_DOXYGEN_OUTPUT_PATH@/html/opencv.tag
|
|
ALLEXTERNALS = NO
|
|
EXTERNAL_GROUPS = YES
|
|
EXTERNAL_PAGES = YES
|
|
CLASS_DIAGRAMS = YES
|
|
DIA_PATH =
|
|
HIDE_UNDOC_RELATIONS = NO
|
|
HAVE_DOT = @CMAKECONFIG_HAVE_DOT@
|
|
DOT_NUM_THREADS = 0
|
|
DOT_FONTNAME = Helvetica
|
|
DOT_FONTSIZE = 10
|
|
DOT_FONTPATH =
|
|
CLASS_GRAPH = YES
|
|
COLLABORATION_GRAPH = YES
|
|
GROUP_GRAPHS = YES
|
|
UML_LOOK = YES
|
|
UML_LIMIT_NUM_FIELDS = 10
|
|
TEMPLATE_RELATIONS = YES
|
|
INCLUDE_GRAPH = YES
|
|
INCLUDED_BY_GRAPH = YES
|
|
CALL_GRAPH = YES
|
|
CALLER_GRAPH = NO
|
|
GRAPHICAL_HIERARCHY = YES
|
|
DIRECTORY_GRAPH = YES
|
|
DOT_IMAGE_FORMAT = @CMAKECONFIG_DOT_IMAGE_FORMAT@
|
|
INTERACTIVE_SVG = @CMAKECONFIG_INTERACTIVE_SVG@
|
|
DOT_PATH = @CMAKECONFIG_DOT_PATH@
|
|
DOTFILE_DIRS =
|
|
MSCFILE_DIRS =
|
|
DIAFILE_DIRS =
|
|
DOT_GRAPH_MAX_NODES = 50
|
|
MAX_DOT_GRAPH_DEPTH = 0
|
|
DOT_TRANSPARENT = NO
|
|
DOT_MULTI_TARGETS = NO
|
|
GENERATE_LEGEND = YES
|
|
DOT_CLEANUP = YES
|