diff --git a/.gitignore b/.gitignore index f1e16f51..38245953 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,7 @@ qvg *.swp qskinny.pro.user *.o +*.log +Doxyfile +html +parser diff --git a/doc/Doxyfile b/doc/Doxyfile index e665d573..5ff9b229 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.8.6 +# Doxyfile 1.8.16 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -17,11 +17,11 @@ # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all text -# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv -# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv -# for the list of possible encodings. +# This tag specifies the encoding used for all characters in the configuration +# file that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# https://www.gnu.org/software/libiconv/ for the list of possible encodings. # The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "Qsk Controls User's Guide" +PROJECT_NAME = "QSkinny" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -46,10 +46,10 @@ PROJECT_NUMBER = 0.0.1 PROJECT_BRIEF = -# With the PROJECT_LOGO tag one can specify an logo or icon that is included in -# the documentation. The maximum height of the logo should not exceed 55 pixels -# and the maximum width should not exceed 200 pixels. Doxygen will copy the logo -# to the output directory. +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. PROJECT_LOGO = @@ -60,7 +60,7 @@ PROJECT_LOGO = OUTPUT_DIRECTORY = -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and # will distribute the generated files over these directories. Enabling this # option can be useful when feeding doxygen a huge amount of source files, where @@ -70,6 +70,14 @@ OUTPUT_DIRECTORY = CREATE_SUBDIRS = NO +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. @@ -85,14 +93,22 @@ CREATE_SUBDIRS = NO OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES doxygen will include brief member +# The OUTPUT_TEXT_DIRECTION tag is used to specify the direction in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all generated output in the proper direction. +# Possible values are: None, LTR, RTL and Context. +# The default value is: None. + +OUTPUT_TEXT_DIRECTION = None + +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member # descriptions after the members that are listed in the file and class # documentation (similar to Javadoc). Set to NO to disable this. # The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES doxygen will prepend the brief +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief # description of a member or function before the detailed description # # Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the @@ -127,7 +143,7 @@ ALWAYS_DETAILED_SEC = NO INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES doxygen will prepend the full path +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path # before files name in the file list and in the header files. If set to NO the # shortest path that makes the file name unique will be used # The default value is: YES. @@ -171,6 +187,16 @@ SHORT_NAMES = NO JAVADOC_AUTOBRIEF = NO +# If the JAVADOC_BANNER tag is set to YES then doxygen will interpret a line +# such as +# /*************** +# as being the beginning of a Javadoc-style comment "banner". If set to NO, the +# Javadoc-style will behave just like regular comments and it will not be +# interpreted by doxygen. +# The default value is: NO. + +JAVADOC_BANNER = NO + # If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first # line (until the first dot) of a Qt-style comment as the brief description. If # set to NO, the Qt-style will behave just like regular Qt-style comments (thus @@ -197,9 +223,9 @@ MULTILINE_CPP_IS_BRIEF = NO INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce a -# new page for each member. If set to NO, the documentation of a member will be -# part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. # The default value is: NO. SEPARATE_MEMBER_PAGES = NO @@ -218,7 +244,12 @@ TAB_SIZE = 4 # will allow you to put the command \sideeffect (or @sideeffect) in the # documentation, which will result in a user-defined paragraph with heading # "Side Effects:". You can put \n's in the value part of an alias to insert -# newlines. +# newlines (in the resulting output). You can put ^^ in the value part of an +# alias to insert a newline as if a physical newline was in the original file. +# When you need a literal { or } or , in the value part of an alias you have to +# escape them by means of a backslash (\), this can lead to conflicts with the +# commands \{ and \} for these it is advised to use the version @{ and @} or use +# a double escape (\\{ and \\}) ALIASES = "accessors=\par Access functions:\n" @@ -256,16 +287,28 @@ OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO +# Set the OPTIMIZE_OUTPUT_SLICE tag to YES if your project consists of Slice +# sources only. Doxygen will then generate output that is more tailored for that +# language. For instance, namespaces will be presented as modules, types will be +# separated into more groups, etc. +# The default value is: NO. + +OPTIMIZE_OUTPUT_SLICE = NO + # Doxygen selects the parser to use depending on the extension of the files it # parses. With this tag you can assign which parser to use for a given # extension. Doxygen has a built-in mapping, but you can override or extend it # using this tag. The format is ext=language, where ext is a file extension, and # language is one of the parsers supported by doxygen: IDL, Java, Javascript, -# C#, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL. For instance to make -# doxygen treat .inc files as Fortran files (default is PHP), and .f files as C -# (default is Fortran), use: inc=Fortran f=C. +# Csharp (C#), C, C++, D, PHP, md (Markdown), Objective-C, Python, Slice, +# Fortran (fixed format Fortran: FortranFixed, free formatted Fortran: +# FortranFree, unknown formatted Fortran: Fortran. In the later case the parser +# tries to guess whether the code is fixed or free formatted code, this is the +# default for Fortran type files), VHDL, tcl. For instance to make doxygen treat +# .inc files as Fortran files (default is PHP), and .f files as C (default is +# Fortran), use: inc=Fortran f=C. # -# Note For files without extension you can use no_extension as a placeholder. +# Note: For files without extension you can use no_extension as a placeholder. # # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. @@ -274,7 +317,7 @@ EXTENSION_MAPPING = metadox=C++ # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. +# documentation. See https://daringfireball.net/projects/markdown/ for details. # The output of markdown processing is further processed by doxygen, so you can # mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in # case of backward compatibilities issues. @@ -282,10 +325,19 @@ EXTENSION_MAPPING = metadox=C++ MARKDOWN_SUPPORT = YES +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 5. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 5 + # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can -# be prevented in individual cases by by putting a % sign in front of the word -# or globally by setting AUTOLINK_SUPPORT to NO. +# be prevented in individual cases by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. # The default value is: YES. AUTOLINK_SUPPORT = YES @@ -307,7 +359,7 @@ BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO # Set the SIP_SUPPORT tag to YES if your project consists of sip (see: -# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# https://www.riverbankcomputing.com/software/sip/intro) sources only. Doxygen # will parse them like normal C++ but will assume all classes use public instead # of private inheritance when no explicit protection keyword is present. # The default value is: NO. @@ -325,13 +377,20 @@ SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first +# tag is set to YES then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. # The default value is: NO. DISTRIBUTE_GROUP_DOC = NO +# If one adds a struct or class to a group and this option is enabled, then also +# any nested class or struct is added to the same group. By default this option +# is disabled and one has to add nested compounds explicitly via \ingroup. +# The default value is: NO. + +GROUP_NESTED_COMPOUNDS = NO + # Set the SUBGROUPING tag to YES to allow class member groups of the same type # (for instance a group of public functions) to be put as a subgroup of that # type (e.g. under the Public Functions section). Set it to NO to prevent @@ -390,7 +449,7 @@ LOOKUP_CACHE_SIZE = 0 # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in # documentation are documented, even if no documentation was available. Private # class members and static file members will be hidden unless the # EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. @@ -400,35 +459,41 @@ LOOKUP_CACHE_SIZE = 0 EXTRACT_ALL = NO -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class will +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. # The default value is: NO. EXTRACT_PRIVATE = NO -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# If the EXTRACT_PRIV_VIRTUAL tag is set to YES, documented private virtual +# methods of a class will be included in the documentation. +# The default value is: NO. + +EXTRACT_PRIV_VIRTUAL = NO + +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. # The default value is: NO. EXTRACT_PACKAGE = NO -# If the EXTRACT_STATIC tag is set to YES all static members of a file will be +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be # included in the documentation. # The default value is: NO. EXTRACT_STATIC = NO -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) defined -# locally in source files will be included in the documentation. If set to NO +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, # only classes defined in header files are included. Does not have any effect # for Java sources. # The default value is: YES. EXTRACT_LOCAL_CLASSES = NO -# This flag is only useful for Objective-C code. When set to YES local methods, +# This flag is only useful for Objective-C code. If set to YES, local methods, # which are defined in the implementation section but not in the interface are -# included in the documentation. If set to NO only methods in the interface are +# included in the documentation. If set to NO, only methods in the interface are # included. # The default value is: NO. @@ -453,21 +518,21 @@ HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. If set -# to NO these classes will be included in the various overviews. This option has -# no effect if EXTRACT_ALL is enabled. +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. # The default value is: NO. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend -# (class|struct|union) declarations. If set to NO these declarations will be +# (class|struct|union) declarations. If set to NO, these declarations will be # included in the documentation. # The default value is: NO. HIDE_FRIEND_COMPOUNDS = YES # If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any -# documentation blocks found inside the body of a function. If set to NO these +# documentation blocks found inside the body of a function. If set to NO, these # blocks will be appended to the function's detailed documentation block. # The default value is: NO. @@ -481,21 +546,28 @@ HIDE_IN_BODY_DOCS = NO INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file -# names in lower-case letters. If set to YES upper-case letters are also +# names in lower-case letters. If set to YES, upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows -# and Mac users are advised to set this option to NO. +# (including Cygwin) ands Mac users are advised to set this option to NO. # The default value is: system dependent. CASE_SENSE_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with -# their full class and namespace scopes in the documentation. If set to YES the +# their full class and namespace scopes in the documentation. If set to YES, the # scope will be hidden. # The default value is: NO. HIDE_SCOPE_NAMES = NO +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + # If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of # the files that are included by a file in the documentation of that file. # The default value is: YES. @@ -523,14 +595,14 @@ INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the # (detailed) documentation of file and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. +# name. If set to NO, the members will appear in declaration order. # The default value is: YES. SORT_MEMBER_DOCS = YES # If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief # descriptions of file, namespace and class members alphabetically by member -# name. If set to NO the members will appear in declaration order. Note that +# name. If set to NO, the members will appear in declaration order. Note that # this will also influence the order of the classes in the class list. # The default value is: NO. @@ -575,27 +647,25 @@ SORT_BY_SCOPE_NAME = NO STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable ( YES) or disable ( NO) the -# todo list. This list is created by putting \todo commands in the -# documentation. +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. # The default value is: YES. GENERATE_TODOLIST = NO -# The GENERATE_TESTLIST tag can be used to enable ( YES) or disable ( NO) the -# test list. This list is created by putting \test commands in the -# documentation. +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. # The default value is: YES. GENERATE_TESTLIST = NO -# The GENERATE_BUGLIST tag can be used to enable ( YES) or disable ( NO) the bug +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug # list. This list is created by putting \bug commands in the documentation. # The default value is: YES. GENERATE_BUGLIST = NO -# The GENERATE_DEPRECATEDLIST tag can be used to enable ( YES) or disable ( NO) +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) # the deprecated list. This list is created by putting \deprecated commands in # the documentation. # The default value is: YES. @@ -620,8 +690,8 @@ ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 # Set the SHOW_USED_FILES tag to NO to disable the list of files generated at -# the bottom of the documentation of classes and structs. If set to YES the list -# will mention the files that were used to generate the documentation. +# the bottom of the documentation of classes and structs. If set to YES, the +# list will mention the files that were used to generate the documentation. # The default value is: YES. SHOW_USED_FILES = NO @@ -666,11 +736,10 @@ LAYOUT_FILE = DoxygenLayout.xml # The CITE_BIB_FILES tag can be used to specify one or more bib files containing # the reference definitions. This must be a list of .bib files. The .bib # extension is automatically appended if omitted. This requires the bibtex tool -# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# to be installed. See also https://en.wikipedia.org/wiki/BibTeX for more info. # For LaTeX the style of the bibliography can be controlled using # LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the -# search path. Do not use file names with spaces, bibtex cannot handle them. See -# also \cite for info how to create references. +# search path. See also \cite for info how to create references. CITE_BIB_FILES = @@ -686,7 +755,7 @@ CITE_BIB_FILES = QUIET = YES # The WARNINGS tag can be used to turn on/off the warning messages that are -# generated to standard error ( stderr) by doxygen. If WARNINGS is set to YES +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES # this implies that the warnings are on. # # Tip: Turn warnings on while writing the documentation. @@ -694,7 +763,7 @@ QUIET = YES WARNINGS = YES -# If the WARN_IF_UNDOCUMENTED tag is set to YES, then doxygen will generate +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate # warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag # will automatically be disabled. # The default value is: YES. @@ -711,12 +780,19 @@ WARN_IF_DOC_ERROR = YES # This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that # are documented, but have no documentation for their parameters or return -# value. If set to NO doxygen will only warn about wrong or incomplete parameter -# documentation, but not about the absence of documentation. +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. If +# EXTRACT_ALL is set to YES then this flag will automatically be disabled. # The default value is: NO. WARN_NO_PARAMDOC = YES +# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when +# a warning is encountered. +# The default value is: NO. + +WARN_AS_ERROR = NO + # The WARN_FORMAT tag determines the format of the warning messages that doxygen # can produce. The string should contain the $file, $line, and $text tags, which # will be replaced by the file and line number from which the warning originated @@ -740,7 +816,7 @@ WARN_LOGFILE = Doxygen.log # The INPUT tag is used to specify the files and/or directories that contain # documented source files. You may enter file names like myfile.cpp or # directories like /usr/src/myproject. Separate the files or directories with -# spaces. +# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. INPUT = . \ @@ -749,13 +825,14 @@ INPUT = . \ ../src/controls \ ../src/dialogs \ ../src/graphic \ + ../src/inputpanel \ ../src/layouts \ ../src/nodes # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # libiconv (or the iconv built into libc) for the transcoding. See the libiconv -# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# documentation (see: https://www.gnu.org/software/libiconv/) for the list of # possible encodings. # The default value is: UTF-8. @@ -763,14 +840,22 @@ INPUT_ENCODING = UTF-8 # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and -# *.h) to filter out the source-files in the directories. If left blank the -# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, -# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, -# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, -# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, -# *.qsf, *.as and *.js. +# *.h) to filter out the source-files in the directories. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# read by doxygen. +# +# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, +# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, +# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf and *.ice. -FILE_PATTERNS = *.h *.cpp *.dox *.metadox +FILE_PATTERNS = *.h \ + *.cpp \ + *.dox \ + *.metadox # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -801,7 +886,7 @@ EXCLUDE_SYMLINKS = NO # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories for example use the pattern */test/* -EXCLUDE_PATTERNS = +EXCLUDE_PATTERNS = # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names # (namespaces, classes, functions, etc.) that should be excluded from the @@ -812,10 +897,9 @@ EXCLUDE_PATTERNS = # Note that the wildcards are matched against the file with absolute path, so to # exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = \ - QskPainterCommand::PixmapData \ - QskPainterCommand::ImageData \ - QskPainterCommand::StateData +EXCLUDE_SYMBOLS = QskPainterCommand::PixmapData \ + QskPainterCommand::ImageData \ + QskPainterCommand::StateData # The EXAMPLE_PATH tag can be used to specify one or more files or directories # that contain example code fragments that are included (see the \include @@ -857,6 +941,10 @@ IMAGE_PATH = images # Note that the filter must not add or remove lines; it is applied before the # code is scanned, but not when the output code is generated. If lines are added # or removed, the anchors will not be placed correctly. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. INPUT_FILTER = @@ -866,11 +954,15 @@ INPUT_FILTER = # (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how # filters are used. If the FILTER_PATTERNS tag is empty or if none of the # patterns match the file name, INPUT_FILTER is applied. +# +# Note that for custom extensions or not directly supported extensions you also +# need to set EXTENSION_MAPPING for the extension otherwise the files are not +# properly processed by doxygen. FILTER_PATTERNS = *.metadox=metadoxfilter # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER ) will also be used to filter the input files that are used for +# INPUT_FILTER) will also be used to filter the input files that are used for # producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). # The default value is: NO. @@ -918,7 +1010,7 @@ INLINE_SOURCES = NO STRIP_CODE_COMMENTS = YES # If the REFERENCED_BY_RELATION tag is set to YES then for each documented -# function all documented functions referencing it will be listed. +# entity all documented functions referencing it will be listed. # The default value is: NO. REFERENCED_BY_RELATION = NO @@ -930,7 +1022,7 @@ REFERENCED_BY_RELATION = NO REFERENCES_RELATION = NO # If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set -# to YES, then the hyperlinks from functions in REFERENCES_RELATION and +# to YES then the hyperlinks from functions in REFERENCES_RELATION and # REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will # link to the documentation. # The default value is: YES. @@ -950,12 +1042,12 @@ SOURCE_TOOLTIPS = YES # If the USE_HTAGS tag is set to YES then the references to source code will # point to the HTML generated by the htags(1) tool instead of doxygen built-in # source browser. The htags tool is part of GNU's global source tagging system -# (see http://www.gnu.org/software/global/global.html). You will need version +# (see https://www.gnu.org/software/global/global.html). You will need version # 4.8.6 or higher. # # To use it do the following: # - Install the latest version of global -# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Enable SOURCE_BROWSER and USE_HTAGS in the configuration file # - Make sure the INPUT points to the root of the source tree # - Run doxygen as normal # @@ -1008,7 +1100,7 @@ IGNORE_PREFIX = Qsk \ # Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES doxygen will generate HTML output +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output # The default value is: YES. GENERATE_HTML = YES @@ -1070,13 +1162,15 @@ HTML_FOOTER = HTML_STYLESHEET = -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional user- -# defined cascading style sheet that is included after the standard style sheets +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets # created by doxygen. Using this option one can overrule certain style aspects. # This is preferred over using HTML_STYLESHEET since it does not replace the -# standard style sheet and is therefor more robust against future updates. -# Doxygen will copy the style sheet file to the output directory. For an example -# see the documentation. +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_EXTRA_STYLESHEET = @@ -1092,9 +1186,9 @@ HTML_EXTRA_STYLESHEET = HTML_EXTRA_FILES = # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen -# will adjust the colors in the stylesheet and background images according to +# will adjust the colors in the style sheet and background images according to # this color. Hue is specified as an angle on a colorwheel, see -# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# https://en.wikipedia.org/wiki/Hue for more information. For instance the value # 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 # purple, and 360 is red again. # Minimum value: 0, maximum value: 359, default value: 220. @@ -1123,12 +1217,24 @@ HTML_COLORSTYLE_GAMMA = 80 # If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML # page will contain the date and time when the page was generated. Setting this -# to NO can help when comparing the output of multiple runs. -# The default value is: YES. +# to YES can help to show when doxygen was last run and thus if the +# documentation is up to date. +# The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = NO +# If the HTML_DYNAMIC_MENUS tag is set to YES then the generated HTML +# documentation will contain a main index with vertical navigation menus that +# are dynamically created via Javascript. If disabled, the navigation index will +# consists of multiple levels of tabs that are statically embedded in every HTML +# page. Disable this option to support browsers that do not have Javascript, +# like the Qt help browser. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_DYNAMIC_MENUS = YES + # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML # documentation will contain sections that can be hidden and shown after the # page has loaded. @@ -1152,13 +1258,13 @@ HTML_INDEX_NUM_ENTRIES = 100 # If the GENERATE_DOCSET tag is set to YES, additional index files will be # generated that can be used as input for Apple's Xcode 3 integrated development -# environment (see: http://developer.apple.com/tools/xcode/), introduced with -# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# environment (see: https://developer.apple.com/xcode/), introduced with OSX +# 10.5 (Leopard). To create a documentation set, doxygen will generate a # Makefile in the HTML output directory. Running make will produce the docset in # that directory and running make install will install the docset in # ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at -# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html -# for more information. +# startup. See https://developer.apple.com/library/archive/featuredarticles/Doxy +# genXcode/_index.html for more information. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1197,7 +1303,7 @@ DOCSET_PUBLISHER_NAME = Publisher # If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three # additional HTML index files: index.hhp, index.hhc, and index.hhk. The # index.hhp is a project file that can be read by Microsoft's HTML Help Workshop -# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# (see: https://www.microsoft.com/en-us/download/details.aspx?id=21138) on # Windows. # # The HTML Help Workshop contains a compiler that can convert all HTML output @@ -1220,28 +1326,29 @@ GENERATE_HTMLHELP = NO CHM_FILE = # The HHC_LOCATION tag can be used to specify the location (absolute path -# including file name) of the HTML help compiler ( hhc.exe). If non-empty +# including file name) of the HTML help compiler (hhc.exe). If non-empty, # doxygen will try to run the HTML help compiler on the generated index.hhp. # The file has to be specified with full path. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. HHC_LOCATION = -# The GENERATE_CHI flag controls if a separate .chi index file is generated ( -# YES) or that it should be included in the master .chm file ( NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# The CHM_INDEX_ENCODING is used to encode HtmlHelp index ( hhk), content ( hhc) +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) # and project file content. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. CHM_INDEX_ENCODING = -# The BINARY_TOC flag controls whether a binary table of contents is generated ( -# YES) or a normal table of contents ( NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. # The default value is: NO. # This tag requires that the tag GENERATE_HTMLHELP is set to YES. @@ -1272,7 +1379,7 @@ QCH_FILE = qskdoc.qch # The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help # Project output. For more information please see Qt Help Project / Namespace -# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#namespace). # The default value is: org.doxygen.Project. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1280,7 +1387,7 @@ QHP_NAMESPACE = qsk.0.0 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # Help Project output. For more information please see Qt Help Project / Virtual -# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# Folders (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#virtual- # folders). # The default value is: doc. # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1289,7 +1396,7 @@ QHP_VIRTUAL_FOLDER = qsk # If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom # filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1297,7 +1404,7 @@ QHP_CUST_FILTER_NAME = # The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the # custom filter to add. For more information please see Qt Help Project / Custom -# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# Filters (see: https://doc.qt.io/archives/qt-4.8/qthelpproject.html#custom- # filters). # This tag requires that the tag GENERATE_QHP is set to YES. @@ -1305,7 +1412,7 @@ QHP_CUST_FILTER_ATTRS = # The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this # project's filter section matches. Qt Help Project / Filter Attributes (see: -# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# https://doc.qt.io/archives/qt-4.8/qthelpproject.html#filter-attributes). # This tag requires that the tag GENERATE_QHP is set to YES. QHP_SECT_FILTER_ATTRS = @@ -1354,7 +1461,7 @@ DISABLE_INDEX = NO # index structure (just like the one that is generated for HTML Help). For this # to work a browser that supports JavaScript, DHTML, CSS and frames is required # (i.e. any modern browser). Windows users are probably better off using the -# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# HTML help feature. Via custom style sheets (see HTML_EXTRA_STYLESHEET) one can # further fine-tune the look of the index. As an example, the default style # sheet generated by doxygen has an example that shows how to put an image at # the root of the tree instead of the PROJECT_NAME. Since the tree basically has @@ -1382,7 +1489,7 @@ ENUM_VALUES_PER_LINE = 4 TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open links to +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to # external symbols imported via tag files in a separate window. # The default value is: NO. # This tag requires that the tag GENERATE_HTML is set to YES. @@ -1398,7 +1505,7 @@ EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# Use the FORMULA_TRANSPARENT tag to determine whether or not the images # generated for formulas are transparent PNGs. Transparent PNGs are not # supported properly for IE 6.0, but are supported on all modern browsers. # @@ -1410,8 +1517,8 @@ FORMULA_FONTSIZE = 10 FORMULA_TRANSPARENT = YES # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see -# http://www.mathjax.org) which uses client side Javascript for the rendering -# instead of using prerendered bitmaps. Use this if you do not have LaTeX +# https://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX # installed or if you want to formulas look prettier in the HTML output. When # enabled you may also need to install MathJax separately and configure the path # to it using the MATHJAX_RELPATH option. @@ -1437,8 +1544,8 @@ MATHJAX_FORMAT = HTML-CSS # MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax # Content Delivery Network so you can quickly see the result without installing # MathJax. However, it is strongly recommended to install a local copy of -# MathJax from http://www.mathjax.org before deployment. -# The default value is: http://cdn.mathjax.org/mathjax/latest. +# MathJax from https://www.mathjax.org before deployment. +# The default value is: https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/. # This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest @@ -1481,11 +1588,11 @@ SEARCHENGINE = YES # When the SERVER_BASED_SEARCH tag is enabled the search engine will be # implemented using a web server instead of a web client using Javascript. There -# are two flavours of web server based searching depending on the -# EXTERNAL_SEARCH setting. When disabled, doxygen will generate a PHP script for -# searching and an index file used by the script. When EXTERNAL_SEARCH is -# enabled the indexing and searching needs to be provided by external tools. See -# the section "External Indexing and Searching" for details. +# are two flavors of web server based searching depending on the EXTERNAL_SEARCH +# setting. When disabled, doxygen will generate a PHP script for searching and +# an index file used by the script. When EXTERNAL_SEARCH is enabled the indexing +# and searching needs to be provided by external tools. See the section +# "External Indexing and Searching" for details. # The default value is: NO. # This tag requires that the tag SEARCHENGINE is set to YES. @@ -1497,9 +1604,9 @@ SERVER_BASED_SEARCH = NO # external search engine pointed to by the SEARCHENGINE_URL option to obtain the # search results. # -# Doxygen ships with an example indexer ( doxyindexer) and search engine +# Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). +# Xapian (see: https://xapian.org/). # # See the section "External Indexing and Searching" for details. # The default value is: NO. @@ -1510,9 +1617,9 @@ EXTERNAL_SEARCH = NO # The SEARCHENGINE_URL should point to a search engine hosted by a web server # which will return the search results when EXTERNAL_SEARCH is enabled. # -# Doxygen ships with an example indexer ( doxyindexer) and search engine +# Doxygen ships with an example indexer (doxyindexer) and search engine # (doxysearch.cgi) which are based on the open source search engine library -# Xapian (see: http://xapian.org/). See the section "External Indexing and +# Xapian (see: https://xapian.org/). See the section "External Indexing and # Searching" for details. # This tag requires that the tag SEARCHENGINE is set to YES. @@ -1548,7 +1655,7 @@ EXTRA_SEARCH_MAPPINGS = # Configuration options related to the LaTeX output #--------------------------------------------------------------------------- -# If the GENERATE_LATEX tag is set to YES doxygen will generate LaTeX output. +# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output. # The default value is: YES. GENERATE_LATEX = NO @@ -1564,22 +1671,36 @@ LATEX_OUTPUT = latex # The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be # invoked. # -# Note that when enabling USE_PDFLATEX this option is only used for generating -# bitmaps for formulas in the HTML output, but not in the Makefile that is -# written to the output directory. -# The default file is: latex. +# Note that when not enabling USE_PDFLATEX the default is latex when enabling +# USE_PDFLATEX the default is pdflatex and when in the later case latex is +# chosen this is overwritten by pdflatex. For specific output languages the +# default can have been set differently, this depends on the implementation of +# the output language. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_CMD_NAME = latex # The MAKEINDEX_CMD_NAME tag can be used to specify the command name to generate # index for LaTeX. +# Note: This tag is used in the Makefile / make.bat. +# See also: LATEX_MAKEINDEX_CMD for the part in the generated output file +# (.tex). # The default file is: makeindex. # This tag requires that the tag GENERATE_LATEX is set to YES. MAKEINDEX_CMD_NAME = makeindex -# If the COMPACT_LATEX tag is set to YES doxygen generates more compact LaTeX +# The LATEX_MAKEINDEX_CMD tag can be used to specify the command name to +# generate index for LaTeX. In case there is no backslash (\) as first character +# it will be automatically added in the LaTeX code. +# Note: This tag is used in the generated output file (.tex). +# See also: MAKEINDEX_CMD_NAME for the part in the Makefile / make.bat. +# The default value is: makeindex. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_MAKEINDEX_CMD = makeindex + +# If the COMPACT_LATEX tag is set to YES, doxygen generates more compact LaTeX # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1597,9 +1718,12 @@ COMPACT_LATEX = YES PAPER_TYPE = a4wide # The EXTRA_PACKAGES tag can be used to specify one or more LaTeX package names -# that should be included in the LaTeX output. To get the times font for -# instance you can specify -# EXTRA_PACKAGES=times +# that should be included in the LaTeX output. The package can be specified just +# by its name or with the correct syntax as to be used with the LaTeX +# \usepackage command. To get the times font for instance you can specify : +# EXTRA_PACKAGES=times or EXTRA_PACKAGES={times} +# To use the option intlimits with the amsmath package you can specify: +# EXTRA_PACKAGES=[intlimits]{amsmath} # If left blank no extra packages will be included. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1613,23 +1737,36 @@ EXTRA_PACKAGES = # # Note: Only use a user-defined header if you know what you are doing! The # following commands have a special meaning inside the header: $title, -# $datetime, $date, $doxygenversion, $projectname, $projectnumber. Doxygen will -# replace them by respectively the title of the page, the current date and time, -# only the current date, the version number of doxygen, the project name (see -# PROJECT_NAME), or the project number (see PROJECT_NUMBER). +# $datetime, $date, $doxygenversion, $projectname, $projectnumber, +# $projectbrief, $projectlogo. Doxygen will replace $title with the empty +# string, for the replacement values of the other commands the user is referred +# to HTML_HEADER. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_HEADER = # The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for the # generated LaTeX document. The footer should contain everything after the last -# chapter. If it is left blank doxygen will generate a standard footer. +# chapter. If it is left blank doxygen will generate a standard footer. See +# LATEX_HEADER for more information on how to generate a default footer and what +# special commands can be used inside the footer. # # Note: Only use a user-defined footer if you know what you are doing! # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_FOOTER = +# The LATEX_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# LaTeX style sheets that are included after the standard style sheets created +# by doxygen. Using this option one can overrule certain style aspects. Doxygen +# will copy the style sheet files to the output directory. +# Note: The order of the extra style sheet files is of importance (e.g. the last +# style sheet in the list overrules the setting of the previous ones in the +# list). +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EXTRA_STYLESHEET = + # The LATEX_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the LATEX_OUTPUT output # directory. Note that the files will be copied as-is; there are no commands or @@ -1647,8 +1784,8 @@ LATEX_EXTRA_FILES = PDF_HYPERLINKS = YES -# If the LATEX_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate -# the PDF file directly from the LaTeX files. Set this option to YES to get a +# If the USE_PDFLATEX tag is set to YES, doxygen will use pdflatex to generate +# the PDF file directly from the LaTeX files. Set this option to YES, to get a # higher quality PDF documentation. # The default value is: YES. # This tag requires that the tag GENERATE_LATEX is set to YES. @@ -1683,17 +1820,33 @@ LATEX_SOURCE_CODE = NO # The LATEX_BIB_STYLE tag can be used to specify the style to use for the # bibliography, e.g. plainnat, or ieeetr. See -# http://en.wikipedia.org/wiki/BibTeX and \cite for more info. +# https://en.wikipedia.org/wiki/BibTeX and \cite for more info. # The default value is: plain. # This tag requires that the tag GENERATE_LATEX is set to YES. LATEX_BIB_STYLE = plain +# If the LATEX_TIMESTAMP tag is set to YES then the footer of each generated +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: NO. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_TIMESTAMP = NO + +# The LATEX_EMOJI_DIRECTORY tag is used to specify the (relative or absolute) +# path from which the emoji images will be read. If a relative path is entered, +# it will be relative to the LATEX_OUTPUT directory. If left blank the +# LATEX_OUTPUT directory will be used. +# This tag requires that the tag GENERATE_LATEX is set to YES. + +LATEX_EMOJI_DIRECTORY = + #--------------------------------------------------------------------------- # Configuration options related to the RTF output #--------------------------------------------------------------------------- -# If the GENERATE_RTF tag is set to YES doxygen will generate RTF output. The +# If the GENERATE_RTF tag is set to YES, doxygen will generate RTF output. The # RTF output is optimized for Word 97 and may not look too pretty with other RTF # readers/editors. # The default value is: NO. @@ -1708,7 +1861,7 @@ GENERATE_RTF = NO RTF_OUTPUT = rtf -# If the COMPACT_RTF tag is set to YES doxygen generates more compact RTF +# If the COMPACT_RTF tag is set to YES, doxygen generates more compact RTF # documents. This may be useful for small projects and may help to save some # trees in general. # The default value is: NO. @@ -1728,9 +1881,9 @@ COMPACT_RTF = NO RTF_HYPERLINKS = NO -# Load stylesheet definitions from file. Syntax is similar to doxygen's config -# file, i.e. a series of assignments. You only have to provide replacements, -# missing definitions are set to their default value. +# Load stylesheet definitions from file. Syntax is similar to doxygen's +# configuration file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. # # See also section "Doxygen usage" for information on how to generate the # default style sheet that doxygen normally uses. @@ -1739,17 +1892,27 @@ RTF_HYPERLINKS = NO RTF_STYLESHEET_FILE = # Set optional variables used in the generation of an RTF document. Syntax is -# similar to doxygen's config file. A template extensions file can be generated -# using doxygen -e rtf extensionFile. +# similar to doxygen's configuration file. A template extensions file can be +# generated using doxygen -e rtf extensionFile. # This tag requires that the tag GENERATE_RTF is set to YES. RTF_EXTENSIONS_FILE = +# If the RTF_SOURCE_CODE tag is set to YES then doxygen will include source code +# with syntax highlighting in the RTF output. +# +# Note that which sources are shown also depends on other settings such as +# SOURCE_BROWSER. +# The default value is: NO. +# This tag requires that the tag GENERATE_RTF is set to YES. + +RTF_SOURCE_CODE = NO + #--------------------------------------------------------------------------- # Configuration options related to the man page output #--------------------------------------------------------------------------- -# If the GENERATE_MAN tag is set to YES doxygen will generate man pages for +# If the GENERATE_MAN tag is set to YES, doxygen will generate man pages for # classes and files. # The default value is: NO. @@ -1773,6 +1936,13 @@ MAN_OUTPUT = man MAN_EXTENSION = .3 +# The MAN_SUBDIR tag determines the name of the directory created within +# MAN_OUTPUT in which the man pages are placed. If defaults to man followed by +# MAN_EXTENSION with the initial . removed. +# This tag requires that the tag GENERATE_MAN is set to YES. + +MAN_SUBDIR = + # If the MAN_LINKS tag is set to YES and doxygen generates man output, then it # will generate one additional man file for each entity documented in the real # man page(s). These additional files only source the real man page, but without @@ -1786,7 +1956,7 @@ MAN_LINKS = NO # Configuration options related to the XML output #--------------------------------------------------------------------------- -# If the GENERATE_XML tag is set to YES doxygen will generate an XML file that +# If the GENERATE_XML tag is set to YES, doxygen will generate an XML file that # captures the structure of the code including all documentation. # The default value is: NO. @@ -1800,7 +1970,7 @@ GENERATE_XML = NO XML_OUTPUT = xml -# If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program +# If the XML_PROGRAMLISTING tag is set to YES, doxygen will dump the program # listings (including syntax highlighting and cross-referencing information) to # the XML output. Note that enabling this will significantly increase the size # of the XML output. @@ -1809,11 +1979,18 @@ XML_OUTPUT = xml XML_PROGRAMLISTING = YES +# If the XML_NS_MEMB_FILE_SCOPE tag is set to YES, doxygen will include +# namespace members in file scope as well, matching the HTML output. +# The default value is: NO. +# This tag requires that the tag GENERATE_XML is set to YES. + +XML_NS_MEMB_FILE_SCOPE = NO + #--------------------------------------------------------------------------- # Configuration options related to the DOCBOOK output #--------------------------------------------------------------------------- -# If the GENERATE_DOCBOOK tag is set to YES doxygen will generate Docbook files +# If the GENERATE_DOCBOOK tag is set to YES, doxygen will generate Docbook files # that can be used to generate PDF. # The default value is: NO. @@ -1827,14 +2004,23 @@ GENERATE_DOCBOOK = NO DOCBOOK_OUTPUT = docbook +# If the DOCBOOK_PROGRAMLISTING tag is set to YES, doxygen will include the +# program listings (including syntax highlighting and cross-referencing +# information) to the DOCBOOK output. Note that enabling this will significantly +# increase the size of the DOCBOOK output. +# The default value is: NO. +# This tag requires that the tag GENERATE_DOCBOOK is set to YES. + +DOCBOOK_PROGRAMLISTING = NO + #--------------------------------------------------------------------------- # Configuration options for the AutoGen Definitions output #--------------------------------------------------------------------------- -# If the GENERATE_AUTOGEN_DEF tag is set to YES doxygen will generate an AutoGen -# Definitions (see http://autogen.sf.net) file that captures the structure of -# the code including all documentation. Note that this feature is still -# experimental and incomplete at the moment. +# If the GENERATE_AUTOGEN_DEF tag is set to YES, doxygen will generate an +# AutoGen Definitions (see http://autogen.sourceforge.net/) file that captures +# the structure of the code including all documentation. Note that this feature +# is still experimental and incomplete at the moment. # The default value is: NO. GENERATE_AUTOGEN_DEF = NO @@ -1843,7 +2029,7 @@ GENERATE_AUTOGEN_DEF = NO # Configuration options related to the Perl module output #--------------------------------------------------------------------------- -# If the GENERATE_PERLMOD tag is set to YES doxygen will generate a Perl module +# If the GENERATE_PERLMOD tag is set to YES, doxygen will generate a Perl module # file that captures the structure of the code including all documentation. # # Note that this feature is still experimental and incomplete at the moment. @@ -1851,7 +2037,7 @@ GENERATE_AUTOGEN_DEF = NO GENERATE_PERLMOD = NO -# If the PERLMOD_LATEX tag is set to YES doxygen will generate the necessary +# If the PERLMOD_LATEX tag is set to YES, doxygen will generate the necessary # Makefile rules, Perl scripts and LaTeX code to be able to generate PDF and DVI # output from the Perl module output. # The default value is: NO. @@ -1859,9 +2045,9 @@ GENERATE_PERLMOD = NO PERLMOD_LATEX = NO -# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be nicely +# If the PERLMOD_PRETTY tag is set to YES, the Perl module output will be nicely # formatted so it can be parsed by a human reader. This is useful if you want to -# understand what is going on. On the other hand, if this tag is set to NO the +# understand what is going on. On the other hand, if this tag is set to NO, the # size of the Perl module output will be much smaller and Perl will parse it # just the same. # The default value is: YES. @@ -1881,14 +2067,14 @@ PERLMOD_MAKEVAR_PREFIX = # Configuration options related to the preprocessor #--------------------------------------------------------------------------- -# If the ENABLE_PREPROCESSING tag is set to YES doxygen will evaluate all +# If the ENABLE_PREPROCESSING tag is set to YES, doxygen will evaluate all # C-preprocessor directives found in the sources and include files. # The default value is: YES. ENABLE_PREPROCESSING = YES -# If the MACRO_EXPANSION tag is set to YES doxygen will expand all macro names -# in the source code. If set to NO only conditional compilation will be +# If the MACRO_EXPANSION tag is set to YES, doxygen will expand all macro names +# in the source code. If set to NO, only conditional compilation will be # performed. Macro expansion can be done in a controlled way by setting # EXPAND_ONLY_PREDEF to YES. # The default value is: NO. @@ -1904,7 +2090,7 @@ MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES -# If the SEARCH_INCLUDES tag is set to YES the includes files in the +# If the SEARCH_INCLUDES tag is set to YES, the include files in the # INCLUDE_PATH will be searched if a #include is found. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. @@ -1946,9 +2132,9 @@ PREDEFINED = EXPAND_AS_DEFINED = QSK_DECLARE_DELEGATE # If the SKIP_FUNCTION_MACROS tag is set to YES then doxygen's preprocessor will -# remove all refrences to function-like macros that are alone on a line, have an -# all uppercase name, and do not end with a semicolon. Such function macros are -# typically used for boiler-plate code, and will confuse the parser if not +# remove all references to function-like macros that are alone on a line, have +# an all uppercase name, and do not end with a semicolon. Such function macros +# are typically used for boiler-plate code, and will confuse the parser if not # removed. # The default value is: YES. # This tag requires that the tag ENABLE_PREPROCESSING is set to YES. @@ -1968,18 +2154,17 @@ SKIP_FUNCTION_MACROS = YES # where loc1 and loc2 can be relative or absolute paths or URLs. See the # section "Linking to external documentation" for more information about the use # of tag files. -# Note: Each tag file must have an unique name (where the name does NOT include +# Note: Each tag file must have a unique name (where the name does NOT include # the path). If a tag file is not located in the directory in which doxygen is # run, you must also specify the path to the tagfile here. -TAGFILES = \ - /usr/share/doc/qt/qtcore/qtcore.tags=https://doc.qt.io/qt-5/ \ - /usr/share/doc/qt/qdoc/qdoc.tags=https://doc.qt.io/qt-5/ \ - /usr/share/doc/qt/qtgui/qtgui.tags=https://doc.qt.io/qt-5/ \ - /usr/share/doc/qt/qtqml/qtqml.tags=https://doc.qt.io/qt-5/ \ - /usr/share/doc/qt/qtquick/qtquick.tags=https://doc.qt.io/qt-5/ \ - /usr/share/doc/qt/qtsvg/qtsvg.tags=https://doc.qt.io/qt-5/ \ - /usr/share/doc/qt/qtwidgets/qtwidgets.tags=https://doc.qt.io/qt-5/ +TAGFILES = /usr/share/doc/qt/qtcore/qtcore.tags=https://doc.qt.io/qt-5/ \ + /usr/share/doc/qt/qdoc/qdoc.tags=https://doc.qt.io/qt-5/ \ + /usr/share/doc/qt/qtgui/qtgui.tags=https://doc.qt.io/qt-5/ \ + /usr/share/doc/qt/qtqml/qtqml.tags=https://doc.qt.io/qt-5/ \ + /usr/share/doc/qt/qtquick/qtquick.tags=https://doc.qt.io/qt-5/ \ + /usr/share/doc/qt/qtsvg/qtsvg.tags=https://doc.qt.io/qt-5/ \ + /usr/share/doc/qt/qtwidgets/qtwidgets.tags=https://doc.qt.io/qt-5/ # When a file name is specified after GENERATE_TAGFILE, doxygen will create a # tag file that is based on the input files it reads. See section "Linking to @@ -1987,37 +2172,32 @@ TAGFILES = \ GENERATE_TAGFILE = -# If the ALLEXTERNALS tag is set to YES all external class will be listed in the -# class index. If set to NO only the inherited external classes will be listed. +# If the ALLEXTERNALS tag is set to YES, all external class will be listed in +# the class index. If set to NO, only the inherited external classes will be +# listed. # The default value is: NO. ALLEXTERNALS = NO -# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed in -# the modules index. If set to NO, only the current project's groups will be +# If the EXTERNAL_GROUPS tag is set to YES, all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will be # listed. # The default value is: YES. EXTERNAL_GROUPS = YES -# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in +# If the EXTERNAL_PAGES tag is set to YES, all external pages will be listed in # the related pages index. If set to NO, only the current project's pages will # be listed. # The default value is: YES. EXTERNAL_PAGES = YES -# The PERL_PATH should be the absolute path and name of the perl script -# interpreter (i.e. the result of 'which perl'). -# The default file (with absolute path) is: /usr/bin/perl. - -PERL_PATH = /usr/bin/perl - #--------------------------------------------------------------------------- # Configuration options related to the dot tool #--------------------------------------------------------------------------- -# If the CLASS_DIAGRAMS tag is set to YES doxygen will generate a class diagram +# If the CLASS_DIAGRAMS tag is set to YES, doxygen will generate a class diagram # (in HTML and LaTeX) for classes with base or super classes. Setting the tag to # NO turns the diagrams off. Note that this option also works with HAVE_DOT # disabled, but it is recommended to install and use dot, since it yields more @@ -2026,15 +2206,6 @@ PERL_PATH = /usr/bin/perl CLASS_DIAGRAMS = YES -# You can define message sequence charts within doxygen comments using the \msc -# command. Doxygen will then run the mscgen tool (see: -# http://www.mcternan.me.uk/mscgen/)) to produce the chart and insert it in the -# documentation. The MSCGEN_PATH tag allows you to specify the directory where -# the mscgen tool resides. If left empty the tool is assumed to be found in the -# default search path. - -MSCGEN_PATH = - # You can include diagrams made with dia in doxygen documentation. Doxygen will # then run dia to produce the diagram and insert it in the documentation. The # DIA_PATH tag allows you to specify the directory where the dia binary resides. @@ -2042,7 +2213,7 @@ MSCGEN_PATH = DIA_PATH = -# If set to YES, the inheritance and collaboration graphs will hide inheritance +# If set to YES the inheritance and collaboration graphs will hide inheritance # and usage relations if the target is undocumented or is not a class. # The default value is: YES. @@ -2067,7 +2238,7 @@ HAVE_DOT = YES DOT_NUM_THREADS = 0 -# When you want a differently looking font n the dot files that doxygen +# When you want a differently looking font in the dot files that doxygen # generates you can specify the font name using DOT_FONTNAME. You need to make # sure dot is able to find the font, which can be done by putting it in a # standard location or by setting the DOTFONTPATH environment variable or by @@ -2075,7 +2246,7 @@ DOT_NUM_THREADS = 0 # The default value is: Helvetica. # This tag requires that the tag HAVE_DOT is set to YES. -DOT_FONTNAME = +DOT_FONTNAME = # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of # dot graphs. @@ -2113,9 +2284,9 @@ COLLABORATION_GRAPH = NO # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. -GROUP_GRAPHS = YES +GROUP_GRAPHS = NO -# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# If the UML_LOOK tag is set to YES, doxygen will generate inheritance and # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. # The default value is: NO. @@ -2167,7 +2338,8 @@ INCLUDED_BY_GRAPH = NO # # Note that enabling this option will significantly increase the time of a run. # So in most cases it will be better to enable call graphs for selected -# functions only using the \callgraph command. +# functions only using the \callgraph command. Disabling a call graph can be +# accomplished by means of the command \hidecallgraph. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2178,7 +2350,8 @@ CALL_GRAPH = NO # # Note that enabling this option will significantly increase the time of a run. # So in most cases it will be better to enable caller graphs for selected -# functions only using the \callergraph command. +# functions only using the \callergraph command. Disabling a caller graph can be +# accomplished by means of the command \hidecallergraph. # The default value is: NO. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2201,11 +2374,15 @@ GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES # The DOT_IMAGE_FORMAT tag can be used to set the image format of the images -# generated by dot. +# generated by dot. For an explanation of the image formats see the section +# output formats in the documentation of the dot tool (Graphviz (see: +# http://www.graphviz.org/)). # Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order # to make the SVG files visible in IE 9+ (other browsers do not have this # requirement). -# Possible values are: png, jpg, gif and svg. +# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo, +# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and +# png:gdiplus:gdiplus. # The default value is: png. # This tag requires that the tag HAVE_DOT is set to YES. @@ -2248,6 +2425,24 @@ MSCFILE_DIRS = DIAFILE_DIRS = +# When using plantuml, the PLANTUML_JAR_PATH tag should be used to specify the +# path where java can find the plantuml.jar file. If left blank, it is assumed +# PlantUML is not used or called during a preprocessing step. Doxygen will +# generate a warning when it encounters a \startuml command in this case and +# will not generate output for the diagram. + +PLANTUML_JAR_PATH = + +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + +# When using plantuml, the specified paths are searched for files specified by +# the !include statement in a plantuml block. + +PLANTUML_INCLUDE_PATH = + # The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of nodes # that will be shown in the graph. If the number of nodes in a graph becomes # larger than this value, doxygen will truncate the graph, which is visualized @@ -2284,7 +2479,7 @@ MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = NO -# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# Set the DOT_MULTI_TARGETS tag to YES to allow dot to generate multiple output # files in one run (i.e. multiple -o and -T options on the command line). This # makes dot run faster, but since only newer versions of dot (>1.8.10) support # this, this feature is disabled by default. @@ -2301,7 +2496,7 @@ DOT_MULTI_TARGETS = NO GENERATE_LEGEND = YES -# If the DOT_CLEANUP tag is set to YES doxygen will remove the intermediate dot +# If the DOT_CLEANUP tag is set to YES, doxygen will remove the intermediate dot # files that are used to generate the various graphs. # The default value is: YES. # This tag requires that the tag HAVE_DOT is set to YES. diff --git a/doc/DoxygenLayout.xml b/doc/DoxygenLayout.xml index 2189d0af..7c0a17ed 100644 --- a/doc/DoxygenLayout.xml +++ b/doc/DoxygenLayout.xml @@ -1,22 +1,36 @@ - + - - - - - + + + + + - - - - - + + + + + + + + + + + + + + + + + + + - + @@ -33,11 +47,10 @@ - + - @@ -51,6 +64,7 @@ + @@ -87,8 +101,13 @@ + + + + + @@ -98,6 +117,8 @@ + + @@ -113,11 +134,16 @@ + + + + + @@ -128,6 +154,8 @@ + + @@ -147,6 +175,8 @@ + + @@ -166,6 +196,8 @@ + + diff --git a/doc/automotive-screenshot.jpg b/doc/automotive-screenshot.jpg deleted file mode 100644 index 56f8651d..00000000 Binary files a/doc/automotive-screenshot.jpg and /dev/null differ diff --git a/doc/classes/QskAbstractButton.metadox b/doc/classes/QskAbstractButton.metadox index b219d3ab..5acef355 100644 --- a/doc/classes/QskAbstractButton.metadox +++ b/doc/classes/QskAbstractButton.metadox @@ -8,6 +8,6 @@ INTERFACE HEADER: QskAbstractButton.h DESCRIPTION - \brief Base class of all Qsk buttons + \brief Base class of all buttons END END diff --git a/doc/classes/QskAnimation.dox b/doc/classes/QskAnimation.dox deleted file mode 100644 index 134225d0..00000000 --- a/doc/classes/QskAnimation.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskAnimation.h - \brief Yet another system for animations - */ - -class QskAnimation -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskAnimationHint.metadox b/doc/classes/QskAnimationHint.metadox new file mode 100644 index 00000000..2a985968 --- /dev/null +++ b/doc/classes/QskAnimationHint.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskAnimationHint + + HEADER: QskAnimationHint.h + + DESCRIPTION + \brief QskAnimationHint + END +END diff --git a/doc/classes/QskAnimator.metadox b/doc/classes/QskAnimator.metadox new file mode 100644 index 00000000..eb89fb87 --- /dev/null +++ b/doc/classes/QskAnimator.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskAnimator + + HEADER: QskAnimator.h + + DESCRIPTION + \brief QskAnimator + END +END diff --git a/doc/classes/QskArcIterator.dox b/doc/classes/QskArcIterator.dox deleted file mode 100644 index cdb42fcc..00000000 --- a/doc/classes/QskArcIterator.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskArcIterator.h - \brief A helper class for interpolating an arc with lines - */ - -class QskArcIterator -{ -/*! - -*/ -}; diff --git a/doc/classes/QskAspect.dox b/doc/classes/QskAspect.metadox similarity index 100% rename from doc/classes/QskAspect.dox rename to doc/classes/QskAspect.metadox diff --git a/doc/classes/QskBorder.dox b/doc/classes/QskBorder.dox deleted file mode 100644 index c7bdec21..00000000 --- a/doc/classes/QskBorder.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskBorder.h - \brief Border attributes that can be used from QML - */ - -class QskBorder -{ -/*! - -*/ -}; diff --git a/doc/classes/QskBox.metadox b/doc/classes/QskBox.metadox new file mode 100644 index 00000000..5b7f7a08 --- /dev/null +++ b/doc/classes/QskBox.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskBox + BASE: QskControl + + QMLCLASS: Box + QMLBASE: Control + + HEADER: QskBox.h + + DESCRIPTION + \brief QskBox + END +END diff --git a/doc/classes/QskBoxBorderColors.metadox b/doc/classes/QskBoxBorderColors.metadox new file mode 100644 index 00000000..6f2d3b5a --- /dev/null +++ b/doc/classes/QskBoxBorderColors.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskBoxBorderColors + + HEADER: QskBoxBorderColors.h + + DESCRIPTION + \brief QskBoxBorderColors + END +END diff --git a/doc/classes/QskBoxBorderMetrics.metadox b/doc/classes/QskBoxBorderMetrics.metadox new file mode 100644 index 00000000..67a32f81 --- /dev/null +++ b/doc/classes/QskBoxBorderMetrics.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskBoxBorderMetrics + BASE: QskBoxBorderMetrics + + HEADER: QskBoxBorderMetrics.h + + DESCRIPTION + \brief Something + END +END diff --git a/doc/classes/QskBoxClipNode.metadox b/doc/classes/QskBoxClipNode.metadox new file mode 100644 index 00000000..18a33d27 --- /dev/null +++ b/doc/classes/QskBoxClipNode.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskBoxClipNode + BASE: QSGClipNode + + HEADER: QskBoxClipNode.h + + DESCRIPTION + \brief QskBoxClipNode + END +END diff --git a/doc/classes/QskBoxNode.metadox b/doc/classes/QskBoxNode.metadox new file mode 100644 index 00000000..7b2c7a36 --- /dev/null +++ b/doc/classes/QskBoxNode.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskBoxNode + BASE: QSGGeometryNode + + HEADER: QskBoxNode.h + + DESCRIPTION + \brief QskBoxNode + END +END diff --git a/doc/classes/QskBoxShapeMetrics.metadox b/doc/classes/QskBoxShapeMetrics.metadox new file mode 100644 index 00000000..a24f4eca --- /dev/null +++ b/doc/classes/QskBoxShapeMetrics.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskBoxShapeMetrics + + HEADER: QskBoxShapeMetrics.h + + DESCRIPTION + \brief QskBoxShapeMetrics + END +END diff --git a/doc/classes/QskBoxSkinlet.metadox b/doc/classes/QskBoxSkinlet.metadox new file mode 100644 index 00000000..11585657 --- /dev/null +++ b/doc/classes/QskBoxSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskBoxSkinlet + BASE: QskSkinlet + + HEADER: QskBoxSkinlet.h + + DESCRIPTION + \brief QskBoxSkinlet + END +END diff --git a/doc/classes/QskClipNode.dox b/doc/classes/QskClipNode.dox deleted file mode 100644 index 4adc3198..00000000 --- a/doc/classes/QskClipNode.dox +++ /dev/null @@ -1,13 +0,0 @@ -/*! - \headerfile QskClipNode.h - \brief A clip node for rectangles with rounded borders - - \sa QskVertexRenderer -*/ - -class QskClipNode -{ -/*! - -*/ -}; diff --git a/doc/classes/QskColorFilter.metadox b/doc/classes/QskColorFilter.metadox new file mode 100644 index 00000000..6905b630 --- /dev/null +++ b/doc/classes/QskColorFilter.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskColorFilter + + HEADER: QskColorFilter.h + + DESCRIPTION + \brief QskColorFilter + END +END diff --git a/doc/classes/QskControl.metadox b/doc/classes/QskControl.metadox index f3278e60..0ee354e7 100644 --- a/doc/classes/QskControl.metadox +++ b/doc/classes/QskControl.metadox @@ -1,6 +1,6 @@ INTERFACE CLASS: QskControl - BASE: QQuickItem + BASE: QskQuickItem QMLCLASS: Control QMLBASE: Item diff --git a/doc/classes/QskCorner.dox b/doc/classes/QskCorner.dox deleted file mode 100644 index 5e48e366..00000000 --- a/doc/classes/QskCorner.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskCorner.h - \brief Attributes of a rounded corner that can be used from QML - */ - -class QskCorner -{ -/*! - -*/ -}; diff --git a/doc/classes/QskDialogButton.metadox b/doc/classes/QskDialogButton.metadox new file mode 100644 index 00000000..01382141 --- /dev/null +++ b/doc/classes/QskDialogButton.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskDialogButton + BASE: QskPushButton + + QMLCLASS: DialogButton + QMLBASE: Button + + HEADER: QskDialogButton.h + + DESCRIPTION + \brief QskDialogButton + END +END diff --git a/doc/classes/QskDialogButtonBox.metadox b/doc/classes/QskDialogButtonBox.metadox index c1e4a5e3..3226b870 100644 --- a/doc/classes/QskDialogButtonBox.metadox +++ b/doc/classes/QskDialogButtonBox.metadox @@ -1,6 +1,6 @@ INTERFACE CLASS: QskDialogButtonBox - BASE: QskControl + BASE: QskBox QMLCLASS: DialogButtonBox QMLBASE: Control diff --git a/doc/classes/QskDialogSubWindow.metadox b/doc/classes/QskDialogSubWindow.metadox new file mode 100644 index 00000000..1abf4d79 --- /dev/null +++ b/doc/classes/QskDialogSubWindow.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskDialogSubWindow + BASE: QskSubWindow + + QMLCLASS: DialogSubWindow + QMLBASE: SubWindow + + HEADER: QskDialogSubWindow.h + + DESCRIPTION + \brief QskDialogSubWindow + END +END diff --git a/doc/classes/QskDialogWindow.metadox b/doc/classes/QskDialogWindow.metadox new file mode 100644 index 00000000..4c4576a5 --- /dev/null +++ b/doc/classes/QskDialogWindow.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskDialogWindow + BASE: QskWindow + + QMLCLASS: DialogWindow + QMLBASE: Window + + HEADER: QskDialogWindow.h + + DESCRIPTION + \brief QskDialogWindow + END +END diff --git a/doc/classes/QskFlickAnimator.metadox b/doc/classes/QskFlickAnimator.metadox new file mode 100644 index 00000000..5f3e4ea3 --- /dev/null +++ b/doc/classes/QskFlickAnimator.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskFlickAnimator + BASE: QskAnimator + + HEADER: QskFlickAnimator.h + + DESCRIPTION + \brief QskFlickAnimator + END +END diff --git a/doc/classes/QskFocusIndicatorSkinlet.dox b/doc/classes/QskFocusIndicatorSkinlet.dox deleted file mode 100644 index 84114e60..00000000 --- a/doc/classes/QskFocusIndicatorSkinlet.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskFocusIndicatorSkinlet.h - \brief Base class of all skinlets for QskFocusIndicator - */ - -class QskFocusIndicatorSkinlet -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskFocusIndicatorSkinlet.metadox b/doc/classes/QskFocusIndicatorSkinlet.metadox new file mode 100644 index 00000000..ee181c31 --- /dev/null +++ b/doc/classes/QskFocusIndicatorSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskFocusIndicatorSkinlet + BASE: QskSkinlet + + HEADER: QskFocusIndicatorSkinlet.h + + DESCRIPTION + \brief QskFocusIndicatorSkinlet + END +END diff --git a/doc/classes/QskFrame.metadox b/doc/classes/QskFrame.metadox deleted file mode 100644 index 93f91276..00000000 --- a/doc/classes/QskFrame.metadox +++ /dev/null @@ -1,13 +0,0 @@ -INTERFACE - CLASS: QskFrame - BASE: QskControl - - QMLCLASS: Frame - QMLBASE: Control - - HEADER: QskFrame.h - - DESCRIPTION - \brief A container with a frame - END -END diff --git a/doc/classes/QskFrameNode.dox b/doc/classes/QskFrameNode.dox deleted file mode 100644 index 839fd47d..00000000 --- a/doc/classes/QskFrameNode.dox +++ /dev/null @@ -1,13 +0,0 @@ -/*! - \headerfile QskFrameNode.h - \brief A geometry node for displaying a frame - - \sa QskVertexRendererColored -*/ - -class QskFrameNode -{ -/*! - -*/ -}; diff --git a/doc/classes/QskFrameSkinlet.dox b/doc/classes/QskFrameSkinlet.dox deleted file mode 100644 index f3ce4649..00000000 --- a/doc/classes/QskFrameSkinlet.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskFrameSkinlet.h - \brief Base class of all skinlets for QskFrame - */ - -class QskFrameSkinlet -{ -/*! - -*/ -}; diff --git a/doc/classes/QskGeometry.dox b/doc/classes/QskGeometry.dox deleted file mode 100644 index 33cac2c2..00000000 --- a/doc/classes/QskGeometry.dox +++ /dev/null @@ -1,19 +0,0 @@ -/*! \namespace QskGeometry - - \brief A collection of utility classes for manipulating Scene Graph geometry. - */ - -/*! \class QskSimpleBorderGeometry - - \brief A convenience class for managing nine-patch images. To be used with - materials rendering textured vertices, such as QSGTextureMaterial or - QskFlatColorSymbolMaterial. To combine per-vertex colors with textured - materials, use QskColoredBorderGeometry. - */ - -/*! \class QskColoredBorderGeometry - - \brief A convenience class for managing nine-patch images. To be used with - materials providing per-vertex colored textured vertices, such as - QskVertexColoredSymbolMaterial. - */ diff --git a/doc/classes/QskGesture.metadox b/doc/classes/QskGesture.metadox new file mode 100644 index 00000000..e87e464e --- /dev/null +++ b/doc/classes/QskGesture.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskGesture + + HEADER: QskGesture.h + + DESCRIPTION + \brief QskGesture + END +END diff --git a/doc/classes/QskGestureRecognizer.metadox b/doc/classes/QskGestureRecognizer.metadox new file mode 100644 index 00000000..f65f6836 --- /dev/null +++ b/doc/classes/QskGestureRecognizer.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskGestureRecognizer + + HEADER: QskGestureRecognizer.h + + DESCRIPTION + \brief QskGestureRecognizer + END +END diff --git a/doc/classes/QskGradient.dox b/doc/classes/QskGradient.dox deleted file mode 100644 index d28cfe94..00000000 --- a/doc/classes/QskGradient.dox +++ /dev/null @@ -1,9 +0,0 @@ -/*! \class QskGradientStop - - \brief A color stop of a QskGradient - */ - -/*! \class QskGradient - - \brief Attributes of a linear gradient that can be set from QML - */ diff --git a/doc/classes/QskGradient.metadox b/doc/classes/QskGradient.metadox new file mode 100644 index 00000000..99a6a209 --- /dev/null +++ b/doc/classes/QskGradient.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS : QskGradientStop + QMLCLASS: GradientStop + + HEADER: QskGradient.h + + DESCRIPTION + \brief A color stop of a gradient + END +END diff --git a/doc/classes/QskGraphic.dox b/doc/classes/QskGraphic.dox deleted file mode 100644 index c4a1ce0a..00000000 --- a/doc/classes/QskGraphic.dox +++ /dev/null @@ -1,51 +0,0 @@ -/*! - \headerfile QskGraphic.h - \brief A paint device for scalable graphics - - QskGraphic is the representation of a graphic that is tailored for - scalability. Like QPicture it will be initialized by QPainter - operations and can be replayed later to any target paint device. - It can be stored and loaded from disk using the operators - from QskGraphicIO. Together with QSvgRenderer it can be used to - implement a simple SVG compiler. - - QskGraphic maps all scalable drawing primitives to a QPainterPath - and stores them together with the painter state changes - ( pen, brush, transformation ... ) in a list of QskPainterCommand. - For being a complete QPaintDevice it also stores pixmaps or images, - what is somehow against the idea of the class, because these objects - can't be scaled without a loss in quality. - - The main issue about scaling a QskGraphic object are the pens used for - drawing the outlines of the painter paths. While non cosmetic pens - ( QPen::isCosmetic() ) are scaled with the same ratio as the path, - cosmetic pens have a fixed width. A graphic might have paths with - different pens - cosmetic and non-cosmetic. - - QskGraphic caches 2 different rectangles: - - - control point rectangle\n - The control point rectangle is the bounding rectangle of all - control point rectangles of the painter paths, or the target - rectangle of the pixmaps/images. - - - bounding rectangle\n - The bounding rectangle extends the control point rectangle by - what is needed for rendering the outline with an unscaled pen. - - Because the offset for drawing the outline depends on the shape - of the painter path ( the peak of a triangle is different than the flat side ) - scaling with a fixed aspect ratio always needs to be calculated from the - control point rectangle. - - \sa QskGraphicIO, QskPainterCommand - \note This class is a clone of QwtGraphic ( http://qwt.sf.net/class_qwt_graphic.html ) -*/ - -class QskGraphic -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskGraphic.metadox b/doc/classes/QskGraphic.metadox new file mode 100644 index 00000000..020a5883 --- /dev/null +++ b/doc/classes/QskGraphic.metadox @@ -0,0 +1,48 @@ +INTERFACE + CLASS: QskGraphic + BASE: QPaintDevice + + HEADER: QskGraphic.h + + DESCRIPTION + \brief A paint device for scalable graphics + + QskGraphic is the representation of a graphic that is tailored for + scalability. Like QPicture it will be initialized by QPainter + operations and can be replayed later to any target paint device. + It can be stored and loaded from disk using the operators + from QskGraphicIO. Together with QSvgRenderer it can be used to + implement a simple SVG compiler. + + QskGraphic maps all scalable drawing primitives to a QPainterPath + and stores them together with the painter state changes + ( pen, brush, transformation ... ) in a list of QskPainterCommand. + For being a complete QPaintDevice it also stores pixmaps or images, + what is somehow against the idea of the class, because these objects + can't be scaled without a loss in quality. + + The main issue about scaling a QskGraphic object are the pens used for + drawing the outlines of the painter paths. While non cosmetic pens + ( QPen::isCosmetic() ) are scaled with the same ratio as the path, + cosmetic pens have a fixed width. A graphic might have paths with + different pens - cosmetic and non-cosmetic. + + QskGraphic caches 2 different rectangles: + + - control point rectangle\n + The control point rectangle is the bounding rectangle of all + control point rectangles of the painter paths, or the target + rectangle of the pixmaps/images. + + - bounding rectangle\n + The bounding rectangle extends the control point rectangle by + what is needed for rendering the outline with an unscaled pen. + + Because the offset for drawing the outline depends on the shape + of the painter path ( the peak of a triangle is different than the flat side ) + scaling with a fixed aspect ratio always needs to be calculated from the + control point rectangle. + + \sa QskGraphicIO, QskPainterCommand + END +END diff --git a/doc/classes/QskGraphicIO.dox b/doc/classes/QskGraphicIO.metadox similarity index 100% rename from doc/classes/QskGraphicIO.dox rename to doc/classes/QskGraphicIO.metadox diff --git a/doc/classes/QskGraphicImageProvider.dox b/doc/classes/QskGraphicImageProvider.dox deleted file mode 100644 index c8ff0bf3..00000000 --- a/doc/classes/QskGraphicImageProvider.dox +++ /dev/null @@ -1,18 +0,0 @@ -/*! - \headerfile QskGraphicImageProvider.h - \brief A QQuickImageProvider making QskGraphicProvider available - for QQuickImage items. - - QskGraphicImageProvider supports images, pixmaps or textures, but only - when requesting a QQuickTextureFactory the item will be able to - scale the image without a loss in quality. - - \sa QskGraphicTextureFactory, QskGraphicProvider, Qsk::addGraphicProvider - */ - -class QskGraphicImageProvider -{ -/*! - -*/ -}; diff --git a/doc/classes/QskGraphicImageProvider.metadox b/doc/classes/QskGraphicImageProvider.metadox new file mode 100644 index 00000000..a2bbddc5 --- /dev/null +++ b/doc/classes/QskGraphicImageProvider.metadox @@ -0,0 +1,17 @@ +INTERFACE + CLASS: QskGraphicImageProvider + BASE: QQuickImageProvider + + HEADER QskGraphicImageProvider.h + + DESCRIPTION + \brief A QQuickImageProvider making QskGraphicProvider available + for QQuickImage items. + + QskGraphicImageProvider supports images, pixmaps or textures, but only + when requesting a QQuickTextureFactory the item will be able to + scale the image without a loss in quality. + + \sa QskGraphicTextureFactory, QskGraphicProvider, Qsk::addGraphicProvider + END +END diff --git a/doc/classes/QskGraphicLabelSkinlet.metadox b/doc/classes/QskGraphicLabelSkinlet.metadox new file mode 100644 index 00000000..b6a5db06 --- /dev/null +++ b/doc/classes/QskGraphicLabelSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskGraphicLabelSkinlet + BASE: QskSkinlet + + HEADER: QskGraphicLabelSkinlet.h + + DESCRIPTION + \brief QskGraphicLabelSkinlet + END +END diff --git a/doc/classes/QskGraphicNode.metadox b/doc/classes/QskGraphicNode.metadox new file mode 100644 index 00000000..eab277f6 --- /dev/null +++ b/doc/classes/QskGraphicNode.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskGraphicNode + BASE: QskTextureNode + + HEADER: QskGraphicNode.h + + DESCRIPTION + \brief QskGraphicNode + END +END diff --git a/doc/classes/QskGraphicPaintEngine.dox b/doc/classes/QskGraphicPaintEngine.dox deleted file mode 100644 index 4a90d122..00000000 --- a/doc/classes/QskGraphicPaintEngine.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskGraphicPaintEngine.h - \brief The paint engine for QskGraphic -*/ - -class QskGraphicPaintEngine -{ -/*! - -*/ -}; diff --git a/doc/classes/QskGraphicPaintFilter.dox b/doc/classes/QskGraphicPaintFilter.dox deleted file mode 100644 index 87283b24..00000000 --- a/doc/classes/QskGraphicPaintFilter.dox +++ /dev/null @@ -1,18 +0,0 @@ -/*! - \headerfile QskGraphicPaintFilter.h - - \brief A filter for substituting colors of a QskGraphic - - A color filter can be used to avoid having to create - variations of an image for different color themes. - - \sa QskGraphic::render(), QskGraphicLabel::setGraphicFilter(), - QskGraphicTextureFactory::setGraphicFilter() - */ - -class QskGraphicPaintFilter -{ -/*! - -*/ -}; diff --git a/doc/classes/QskGraphicProvider.dox b/doc/classes/QskGraphicProvider.dox deleted file mode 100644 index 8936b62e..00000000 --- a/doc/classes/QskGraphicProvider.dox +++ /dev/null @@ -1,13 +0,0 @@ -/*! - \headerfile QskGraphicProvider.h - - \brief QskGraphicProvider loads QskGraphic from a source URL. - \sa QskGraphicImageProvider, Qsk::addGraphicProvider - */ - -class QskGraphicProvider -{ -/*! - -*/ -}; diff --git a/doc/classes/QskGraphicProvider.metadox b/doc/classes/QskGraphicProvider.metadox new file mode 100644 index 00000000..8e5bfddd --- /dev/null +++ b/doc/classes/QskGraphicProvider.metadox @@ -0,0 +1,11 @@ +INTERFACE + CLASS: QskGraphicProvider + BASE: QObject + + HEADER: QskGraphicProvider.h + + DESCRIPTION + \brief QskGraphicProvider loads QskGraphic from a source URL. + \sa QskGraphicImageProvider, Qsk::addGraphicProvider + END +END diff --git a/doc/classes/QskGraphicProviderMap.metadox b/doc/classes/QskGraphicProviderMap.metadox new file mode 100644 index 00000000..304d00d1 --- /dev/null +++ b/doc/classes/QskGraphicProviderMap.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskGraphicProviderMap + + HEADER: QskGraphicProviderMap.h + + DESCRIPTION + \brief QskGraphicProviderMap + END +END diff --git a/doc/classes/QskGraphicTextureFactory.dox b/doc/classes/QskGraphicTextureFactory.dox deleted file mode 100644 index f7141cc0..00000000 --- a/doc/classes/QskGraphicTextureFactory.dox +++ /dev/null @@ -1,16 +0,0 @@ -/*! - \headerfile QskGraphicTextureFactory.h - \brief A QQuickTextureFactory creating a QSGTexture from a QskGraphic. - - QskGraphicTextureFactory is a helper class to forward the creation - of textures for QQuickImage to the scene graph thread. - - \sa QskGraphicImageProvider - */ - -class QskGraphicTextureFactory -{ -/*! - -*/ -}; diff --git a/doc/classes/QskGraphicTextureFactory.metadox b/doc/classes/QskGraphicTextureFactory.metadox new file mode 100644 index 00000000..181d0c60 --- /dev/null +++ b/doc/classes/QskGraphicTextureFactory.metadox @@ -0,0 +1,15 @@ +INTERFACE + CLASS: QskGraphicTextureFactory + BASE: QQuickTextureFactory + + HEADER: QskGraphicTextureFactory.h + + DESCRIPTION + \brief A QQuickTextureFactory creating a QSGTexture from a QskGraphic. + + QskGraphicTextureFactory is a helper class to forward the creation + of textures for QQuickImage to the scene graph thread. + + \sa QskGraphicImageProvider + END +END diff --git a/doc/classes/QskHintAnimator.metadox b/doc/classes/QskHintAnimator.metadox new file mode 100644 index 00000000..626ba8a0 --- /dev/null +++ b/doc/classes/QskHintAnimator.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskHintAnimator + BASE: QskVariantAnimator + + HEADER: QskHintAnimator.h + + DESCRIPTION + \brief QskHintAnimator + END +END diff --git a/doc/classes/QskImage.metadox b/doc/classes/QskImage.metadox deleted file mode 100644 index c2df4835..00000000 --- a/doc/classes/QskImage.metadox +++ /dev/null @@ -1,16 +0,0 @@ -INTERFACE - CLASS: QskImage - BASE: QQuickImage - - QMLCLASS: Image - - # Not true as we inherit from QQuickImage ( = Image ) - # how to solve this ??? - QMLBASE: Item - - HEADER: QskImage.h - - DESCRIPTION - \brief An extended version of QQuickImage - END -END diff --git a/doc/classes/QskLayout.metadox b/doc/classes/QskLayout.metadox deleted file mode 100644 index 045e1fa9..00000000 --- a/doc/classes/QskLayout.metadox +++ /dev/null @@ -1,92 +0,0 @@ -INTERFACE - CLASS: QskLayout - BASE: QskControl - - QMLCLASS: Layout - QMLBASE: Control - - HEADER: QskLayout.h - - DESCRIPTION - \brief Base class of all Qsk layouts using a QGridLayoutEngine workhorse - END - - INVOKABLE - SIGNATURE: bool isEmpty() const; - DESCRIPTION - END - END - - INVOKABLE - SIGNATURE: int itemCount() const; - DESCRIPTION - END - END - - INVOKABLE - SIGNATURE: QUICKITEM itemAtIndex( int index ) const; - DESCRIPTION - END - END - - INVOKABLE - SIGNATURE: int indexOf( const QUICKITEM item ) const; - DESCRIPTION - END - END - - INVOKABLE - SIGNATURE: removeItem( const QUICKITEM item ); - DESCRIPTION - END - END - - INVOKABLE - SIGNATURE: void removeAt( int index ); - DESCRIPTION - END - END - - INVOKABLE - SIGNATURE: void clear(); - DESCRIPTION - END - END - - INVOKABLE - SIGNATURE: void setActive( bool on ); - DESCRIPTION - END - END - - INVOKABLE - SIGNATURE: bool isActive() const; - DESCRIPTION - END - END - - SLOT - SIGNATURE: void activate(); - DESCRIPTION - END - END - - SLOT - SIGNATURE: void invalidate(); - DESCRIPTION - END - END - - FUNCTION - SIGNATURE: void adjustItem( const QUICKITEM item ); - DESCRIPTION - END - END - - FUNCTION - SIGNATURE: void adjustItemAt( const QUICKITEM item ); - DESCRIPTION - END - END - -END diff --git a/doc/classes/QskLayoutEngine.dox b/doc/classes/QskLayoutEngine.dox deleted file mode 100644 index 75863bff..00000000 --- a/doc/classes/QskLayoutEngine.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskLayoutEngine.h - \brief A QGridLayoutEngine tailored for Qsk layouts - */ - -class QskLayoutEngine -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskLayoutItem.dox b/doc/classes/QskLayoutItem.dox deleted file mode 100644 index 4eb2accd..00000000 --- a/doc/classes/QskLayoutItem.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskLayoutItem.h - \brief A QGridLayoutItem tailored for Qsk layouts - */ - -class QskLayoutItem -{ -/*! - -*/ -}; diff --git a/doc/classes/QskListViewSkinlet.metadox b/doc/classes/QskListViewSkinlet.metadox new file mode 100644 index 00000000..5d7021b1 --- /dev/null +++ b/doc/classes/QskListViewSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskListViewSkinlet + BASE: QskSkinlet + + HEADER: QskListViewSkinlet.h + + DESCRIPTION + \brief QskListViewSkinlet + END +END diff --git a/doc/classes/QskMargins.metadox b/doc/classes/QskMargins.metadox new file mode 100644 index 00000000..3c6235a0 --- /dev/null +++ b/doc/classes/QskMargins.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskMargins + BASE: QMarginsF + + HEADER: QskMargins.h + + DESCRIPTION + \brief A stupid wrapper around QMarginsF + END +END diff --git a/doc/classes/QskMessageSubWindow.metadox b/doc/classes/QskMessageSubWindow.metadox new file mode 100644 index 00000000..fe5f7d47 --- /dev/null +++ b/doc/classes/QskMessageSubWindow.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskMessageSubWindow + BASE: QskDialogSubWindow + + QMLCLASS: MessageSubWindow + QMLBASE: DialogSubWindow + + HEADER: QskMessageSubWindow.h + + DESCRIPTION + \brief QskMessageSubWindow + END +END diff --git a/doc/classes/QskMessageWindow.metadox b/doc/classes/QskMessageWindow.metadox new file mode 100644 index 00000000..749f1873 --- /dev/null +++ b/doc/classes/QskMessageWindow.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskMessageWindow + BASE: QskDialogWindow + + QMLCLASS: MessageWindow + QMLBASE: DialogWindow + + HEADER: QskDialogWindow.h + + DESCRIPTION + \brief QskDialogWindow + END +END diff --git a/doc/classes/QskModule.dox b/doc/classes/QskModule.dox deleted file mode 100644 index a338c1c3..00000000 --- a/doc/classes/QskModule.dox +++ /dev/null @@ -1,10 +0,0 @@ -/*! - \headerfile QskModule.h - \brief A collection of global methods of the Qsk module. - */ - -namespace QskModule -{ -/*! -*/ -} diff --git a/doc/classes/QskObjectCounter.dox b/doc/classes/QskObjectCounter.dox deleted file mode 100644 index eab2f2f6..00000000 --- a/doc/classes/QskObjectCounter.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskAbstractButton.h - \brief An object counter using Qt hooks to create statistics - about QObject and QQuickItem instantiations - */ - -class QskAbstractButton -{ -/*! - -*/ -}; diff --git a/doc/classes/QskObjectCounter.metadox b/doc/classes/QskObjectCounter.metadox new file mode 100644 index 00000000..2c5a93b1 --- /dev/null +++ b/doc/classes/QskObjectCounter.metadox @@ -0,0 +1,11 @@ +INTERFACE + CLASS: QskAbstractButton + BASE: QskControl + + HEADER: QskAbstractButton.h + + DESCRIPTION + \brief An object counter using Qt hooks to create statistics + about QObject and QQuickItem instantiations + END +END diff --git a/doc/classes/QskObjectResolver.dox b/doc/classes/QskObjectResolver.dox deleted file mode 100644 index 3958b6bb..00000000 --- a/doc/classes/QskObjectResolver.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskObjectResolver.h - \brief A helper class for resolving properties on the window/item tree - */ - -class QskObjectResolver -{ -/*! - -*/ -}; diff --git a/doc/classes/QskObjectWalker.dox b/doc/classes/QskObjectWalker.dox deleted file mode 100644 index a4ac25e4..00000000 --- a/doc/classes/QskObjectWalker.dox +++ /dev/null @@ -1,7 +0,0 @@ -/*! \class QskObjectAttributes - \brief A helper class for resolving properties on the window/item tree - */ - -/*! \class QskObjectWalker - \brief A helper class for resolving properties on the window/item tree - */ diff --git a/doc/classes/QskPageIndicator.metadox b/doc/classes/QskPageIndicator.metadox new file mode 100644 index 00000000..4fca75d7 --- /dev/null +++ b/doc/classes/QskPageIndicator.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskPageIndicator + BASE: QskControl + + QMLCLASS: PageIndicator + QMLBASE: Control + + HEADER: QskPageIndicator.h + + DESCRIPTION + \brief A page indicator + END +END diff --git a/doc/classes/QskPageIndicatorSkinlet.metadox b/doc/classes/QskPageIndicatorSkinlet.metadox new file mode 100644 index 00000000..c5d2b4f4 --- /dev/null +++ b/doc/classes/QskPageIndicatorSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskPageIndicatorSkinlet + BASE: QskSkinlet + + HEADER: QskPageIndicatorSkinlet.h + + DESCRIPTION + \brief QskPageIndicatorSkinlet + END +END diff --git a/doc/classes/QskPaintedNode.metadox b/doc/classes/QskPaintedNode.metadox new file mode 100644 index 00000000..0db8b0e2 --- /dev/null +++ b/doc/classes/QskPaintedNode.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskPaintedNode + BASE: QskTextureNode + + HEADER: QskPaintedNode.h + + DESCRIPTION + \brief QskPaintedNode + END +END diff --git a/doc/classes/QskPainterCommand.dox b/doc/classes/QskPainterCommand.dox deleted file mode 100644 index 16a89119..00000000 --- a/doc/classes/QskPainterCommand.dox +++ /dev/null @@ -1,77 +0,0 @@ -/*! - \headerfile QskPainterCommand.h - \brief Attributes of a QPainter operation. - - It is used by QskGraphic to record and replay paint operations - - \sa QskGraphic::commands() -*/ - -class QskPainterCommand -{ -/*! - \fn QskPainterCommand() - - Construct an invalid command - - \fn QskPainterCommand( const QPainterPath &path ) - Constructor for path paint operation - - \fn QskPainterCommand( const QRectF &rect, - const QPixmap &pixmap, const QRectF& subRect ) - - Constructor for Pixmap paint operation - - \param rect Target rectangle - \param pixmap Pixmap - \param subRect Rectangle inside the pixmap - - \sa QPainter::drawPixmap() - - \fn QskPainterCommand( const QRectF &rect, const QImage &image, - const QRectF& subRect, Qt::ImageConversionFlags flags ) - - Constructor for Image paint operation - - \param rect Target rectangle - \param image Image - \param subRect Rectangle inside the image - \param flags Conversion flags - - \sa QPainter::drawImage() - - \fn QskPainterCommand( const QPaintEngineState &state ) - - Constructor for State paint operation - - \param state Paint engine state - - \fn QskPainterCommand( const QskPainterCommand &other ) - - Copy constructor - - \param other Command to be copied - - \fn ~QskPainterCommand() - Destructor - - \fn QskPainterCommand &operator=( const QskPainterCommand &other ) - - Assignment operator - - \param other Command to be copied - \return Modified command - - \fn QPainterPath *path() - \return Painter path to be painted - - \fn PixmapData* pixmapData() - \return Attributes how to paint a QPixmap - - \fn ImageData* imageData() - \return Attributes how to paint a QImage - - \fn StateData* stateData() - \return Attributes of a state change -*/ -}; diff --git a/doc/classes/QskPanGestureRecognizer.metadox b/doc/classes/QskPanGestureRecognizer.metadox new file mode 100644 index 00000000..79da96d6 --- /dev/null +++ b/doc/classes/QskPanGestureRecognizer.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskPanGestureRecognizer + BASE: QskGestureRecognizer + + HEADER: QskPanGestureRecognizer.h + + DESCRIPTION + \brief QskPanGestureRecognizer + END +END diff --git a/doc/classes/QskPlainTextRenderer.dox b/doc/classes/QskPlainTextRenderer.dox deleted file mode 100644 index d5893715..00000000 --- a/doc/classes/QskPlainTextRenderer.dox +++ /dev/null @@ -1,14 +0,0 @@ -/*! - \headerfile QskPlainTextRenderer.h - \brief A renderer for creating a scene graph subtree from plain text content - \sa QskTextRenderer - */ - -class QskPlainTextRenderer -{ -/*! - -*/ -}; - - diff --git a/doc/classes/QskPopup.metadox b/doc/classes/QskPopup.metadox new file mode 100644 index 00000000..b8c11ba9 --- /dev/null +++ b/doc/classes/QskPopup.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskPopup + BASE: QskControl + + QMLCLASS: QskPopup + QMLBASE: Control + + HEADER: QskPopup.h + + DESCRIPTION + \brief Something + END +END diff --git a/doc/classes/QskPopupSkinlet.metadox b/doc/classes/QskPopupSkinlet.metadox new file mode 100644 index 00000000..42a59e8b --- /dev/null +++ b/doc/classes/QskPopupSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskPopupSkinlet + BASE: QskSkinlet + + HEADER: QskPopupSkinlet.h + + DESCRIPTION + \brief QskPopupSkinlet + END +END diff --git a/doc/classes/QskPushButtonSkinlet.dox b/doc/classes/QskPushButtonSkinlet.dox deleted file mode 100644 index 79570708..00000000 --- a/doc/classes/QskPushButtonSkinlet.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskPushButtonSkinlet.h - \brief Base class of all skinlets for QskPushButton - */ - -class QskPushButtonSkinlet -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskPushButtonSkinlet.metadox b/doc/classes/QskPushButtonSkinlet.metadox new file mode 100644 index 00000000..6a4631f0 --- /dev/null +++ b/doc/classes/QskPushButtonSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskPushButtonSkinlet + BASE: QskSkinlet + + HEADER: QskPushButtonSkinlet.h + + DESCRIPTION + \brief QskPushButtonSkinlet + END +END diff --git a/doc/classes/QskQuickItem.metadox b/doc/classes/QskQuickItem.metadox new file mode 100644 index 00000000..813ad0c4 --- /dev/null +++ b/doc/classes/QskQuickItem.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskQuickItem + BASE: QQuickItem + + HEADER: QskQuickItem.h + + DESCRIPTION + \brief QskQuickItem + END +END diff --git a/doc/classes/QskRangeControl.metadox b/doc/classes/QskRangeControl.metadox index 867589d4..d685e398 100644 --- a/doc/classes/QskRangeControl.metadox +++ b/doc/classes/QskRangeControl.metadox @@ -8,6 +8,6 @@ INTERFACE HEADER: QskRangeControl.h DESCRIPTION - \brief A push button + \brief QskRangeControl END END diff --git a/doc/classes/QskRectNode.dox b/doc/classes/QskRectNode.dox deleted file mode 100644 index 1974a2f1..00000000 --- a/doc/classes/QskRectNode.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskRectNode.h - \brief A scene graph node for rounded rectangles with an optional border - */ - -class QskRectNode -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskRectangle.metadox b/doc/classes/QskRectangle.metadox deleted file mode 100644 index 0c5508e5..00000000 --- a/doc/classes/QskRectangle.metadox +++ /dev/null @@ -1,13 +0,0 @@ -INTERFACE - CLASS: QskRectangle - BASE: QskControl - - QMLCLASS: Rectangle - QMLBASE: Control - - HEADER: QskRectangle.h - - DESCRIPTION - \brief An item displaying a filled rectangle with optional borders - END -END diff --git a/doc/classes/QskResizable.dox b/doc/classes/QskResizable.dox deleted file mode 100644 index 95f071f6..00000000 --- a/doc/classes/QskResizable.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskResizable.h -*/ - -class QskResizable -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskScrollArea.metadox b/doc/classes/QskScrollArea.metadox new file mode 100644 index 00000000..3f5bd8cf --- /dev/null +++ b/doc/classes/QskScrollArea.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskScrollArea + BASE: QskScrollView + + QMLCLASS: ScrollArea + QMLBASE: ScrollView + + HEADER: QskScrollArea.h + + DESCRIPTION + \brief QskScrollArea + END +END diff --git a/doc/classes/QskScrollViewSkinlet.metadox b/doc/classes/QskScrollViewSkinlet.metadox new file mode 100644 index 00000000..5f6e96fd --- /dev/null +++ b/doc/classes/QskScrollViewSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskScrollViewSkinlet + BASE: QskSkinlet + + HEADER: QskScrollViewSkinlet.h + + DESCRIPTION + \brief QskScrollViewSkinlet + END +END diff --git a/doc/classes/QskSelectionSubWindow.metadox b/doc/classes/QskSelectionSubWindow.metadox new file mode 100644 index 00000000..f5de343d --- /dev/null +++ b/doc/classes/QskSelectionSubWindow.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskSelectionSubWindow + BASE: QskDialogSubWindow + + QMLCLASS: SelectionSubWindow + QMLBASE: DialogSubWindow + + HEADER: QskSelectionSubWindow.h + + DESCRIPTION + \brief QskSelectionSubWindow + END +END diff --git a/doc/classes/QskSelectionWindow.metadox b/doc/classes/QskSelectionWindow.metadox new file mode 100644 index 00000000..76d68348 --- /dev/null +++ b/doc/classes/QskSelectionWindow.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskSelectionWindow + BASE: QskDialogWindow + + QMLCLASS: SelectionWindow + QMLBASE: DialogWindow + + HEADER: QskSelectionWindow.h + + DESCRIPTION + \brief QskSelectionWindow + END +END diff --git a/doc/classes/QskSeparatorSkinlet.metadox b/doc/classes/QskSeparatorSkinlet.metadox new file mode 100644 index 00000000..efc57ee2 --- /dev/null +++ b/doc/classes/QskSeparatorSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskSeparatorSkinlet + BASE: QskSkinlet + + HEADER: QskSeparatorSkinlet.h + + DESCRIPTION + \brief QskSeparatorSkinlet + END +END diff --git a/doc/classes/QskShortcutMap.metadox b/doc/classes/QskShortcutMap.metadox new file mode 100644 index 00000000..6d6467af --- /dev/null +++ b/doc/classes/QskShortcutMap.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskShortcutMap + + HEADER: QskShortcutMap.h + + DESCRIPTION + \brief QskShortcutMap + END +END diff --git a/doc/classes/QskSizePolicy.dox b/doc/classes/QskSizePolicy.dox deleted file mode 100644 index 550b0898..00000000 --- a/doc/classes/QskSizePolicy.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskSizePolicy.h - \brief A size policy ( similar to QSizePolicy ) - */ - -class QskSizePolicy -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskSizePolicy.metadox b/doc/classes/QskSizePolicy.metadox new file mode 100644 index 00000000..3df2aca0 --- /dev/null +++ b/doc/classes/QskSizePolicy.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskSizePolicy + QMLCLASS: SizePolicy + + HEADER QskSizePolicy.h + + DESCRIPTION + \brief A size policy ( similar to QSizePolicy ) + END +END diff --git a/doc/classes/QskSkin.dox b/doc/classes/QskSkin.metadox similarity index 93% rename from doc/classes/QskSkin.dox rename to doc/classes/QskSkin.metadox index 39d5ff14..b45976d9 100644 --- a/doc/classes/QskSkin.dox +++ b/doc/classes/QskSkin.metadox @@ -1,3 +1,14 @@ +INTERFACE + CLASS: QskSkin + BASE: QObject + + HEADER: QskSkin.h + + DESCRIPTION + \brief QskSkin + END +END + /*! \fn void QskSkin::setColor( QskAspect::Aspect aspect, QRgb color ) diff --git a/doc/classes/QskSkinAnimator.dox b/doc/classes/QskSkinAnimator.dox deleted file mode 100644 index adc59ded..00000000 --- a/doc/classes/QskSkinAnimator.dox +++ /dev/null @@ -1,35 +0,0 @@ -/*! - \headerfile QskSkinAnimator.h - - \brief A helper class for delegating transitions between skin states. For - example, if you wish to smoothly transition from one color to another, you - should use QskControl::skinAnimator. - - QskSkinAnimator is a low-level API which allows for smooth transitions - between values stored by QskSkinHint. Depending on the QskControl::skinState(), - a different value may be returned by a call to QskControl::skinHint(). - By specifying an animator for the same QskAspect, an automatic transition - can occur between those two values. - - In the simple case, you can create a hint animator by calling - QskSkinlet::animator() to get a default animator for that skin aspect. - Then, set the duration value: - - \code - control->skinAnimator( QskSkinHint::Background ).setDuration<500>(); // Set the color transition to 500ms. - \endcode - - To animate using an easing curve, you can replace the progress functor with - one utilizing a QEasingCurve: - \code - control->skinAnimator( QskSkinHint::Background ).progress = &QskSkinHint::easingProgress; - \endcode -*/ - -class QskSkinAnimator -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskSkinFactory.metadox b/doc/classes/QskSkinFactory.metadox new file mode 100644 index 00000000..35da9ad8 --- /dev/null +++ b/doc/classes/QskSkinFactory.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskSkinFactory + BASE: QObject + + HEADER: QskSkinFactory.h + + DESCRIPTION + \brief QskSkinFactory + END +END diff --git a/doc/classes/QskSkinHint.dox b/doc/classes/QskSkinHint.dox deleted file mode 100644 index 234a0c81..00000000 --- a/doc/classes/QskSkinHint.dox +++ /dev/null @@ -1,6 +0,0 @@ -/*! \struct QskSkinHint - This struct acts as a union between option types used by the framework. - Skin hints are attributes of a given control which affect the visual - representation of the control. They can also be animated using - QskSkinHintAnimator. - */ diff --git a/doc/classes/QskSkinHintTable.metadox b/doc/classes/QskSkinHintTable.metadox new file mode 100644 index 00000000..d2bc9dd7 --- /dev/null +++ b/doc/classes/QskSkinHintTable.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskSkinHintTable + + HEADER: QskSkinHintTable.h + + DESCRIPTION + \brief QskSkinHintTable + END +END diff --git a/doc/classes/QskSkinManager.metadox b/doc/classes/QskSkinManager.metadox new file mode 100644 index 00000000..3b077245 --- /dev/null +++ b/doc/classes/QskSkinManager.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskSkinManager + BASE: QObject + + HEADER: QskSkinManager.h + + DESCRIPTION + \brief QskSkinManager + END +END diff --git a/doc/classes/QskSkinTransition.metadox b/doc/classes/QskSkinTransition.metadox new file mode 100644 index 00000000..589da732 --- /dev/null +++ b/doc/classes/QskSkinTransition.metadox @@ -0,0 +1,9 @@ +INTERFACE + CLASS: QskSkinTransition + + HEADER: QskSkinTransition.h + + DESCRIPTION + \brief QskSkinTransition + END +END diff --git a/doc/classes/QskSkinlet.dox b/doc/classes/QskSkinlet.dox deleted file mode 100644 index 8ff85688..00000000 --- a/doc/classes/QskSkinlet.dox +++ /dev/null @@ -1,27 +0,0 @@ -/*! - \headerfile QskSkinlet.h - - \brief Describes the rendering interface of a QskControl. Change the - skinlet to change the appearance of the control using the low-level scene - graph API. - - \sa QskControl::setSkinlet() - \sa QskSkin - \sa setMetric() - \sa setColor() - */ - -class QskSkinlet -{ -/*! - \fn QSGNode* findNode( QSGNode *parent, quint8 nodeRole ) - - A convenience method for finding the first top level child node - with the given nodeRole. - - \param parent Parent node - \param nodeRole Unique identifier - - \return the node, if found, or nullptr if not found. -*/ -}; diff --git a/doc/classes/QskSkinlet.metadox b/doc/classes/QskSkinlet.metadox new file mode 100644 index 00000000..a2e7e8b5 --- /dev/null +++ b/doc/classes/QskSkinlet.metadox @@ -0,0 +1,16 @@ +INTERFACE + CLASS: QskSkinlet + + HEADER: QskSkinlet.h + + DESCRIPTION + \brief Describes the rendering interface of a QskControl. Change the + skinlet to change the appearance of the control using the low-level scene + graph API. + + \sa QskControl::setSkinlet() + \sa QskSkin + \sa setMetric() + \sa setColor() + END +END diff --git a/doc/classes/QskSkinnable.dox b/doc/classes/QskSkinnable.metadox similarity index 85% rename from doc/classes/QskSkinnable.dox rename to doc/classes/QskSkinnable.metadox index c6bd57f0..d90ee6bc 100644 --- a/doc/classes/QskSkinnable.dox +++ b/doc/classes/QskSkinnable.metadox @@ -1,3 +1,13 @@ +INTERFACE + CLASS: QskSkinnable + + HEADER: QskSkinnable.h + + DESCRIPTION + \brief QskSkinnable + END +END + /*! \fn void QskSkinnable::markDirty( QskAspect::Aspect aspect ) diff --git a/doc/classes/QskSliderSkinlet.dox b/doc/classes/QskSliderSkinlet.dox deleted file mode 100644 index 23a93fb7..00000000 --- a/doc/classes/QskSliderSkinlet.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskSliderSkinlet.h - \brief Base class of all skinlets for QskSlider - */ - -class QskSliderSkinlet -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskSliderSkinlet.metadox b/doc/classes/QskSliderSkinlet.metadox new file mode 100644 index 00000000..441b576d --- /dev/null +++ b/doc/classes/QskSliderSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskSliderSkinlet + BASE: QskSkinlet + + HEADER: QskSliderSkinlet.h + + DESCRIPTION + \brief QskSliderSkinlet + END +END diff --git a/doc/classes/QskStackBoxAnimation.dox b/doc/classes/QskStackBoxAnimation.dox deleted file mode 100644 index e69de29b..00000000 diff --git a/doc/classes/QskStandardIcons.dox b/doc/classes/QskStandardIcons.dox deleted file mode 100644 index 24ae11fc..00000000 --- a/doc/classes/QskStandardIcons.dox +++ /dev/null @@ -1,6 +0,0 @@ -/*! \namespace QskStandardIcons - - \brief A image provider for standard dialog icons - - \note Will be replaced by a QskGraphicProvider - */ diff --git a/doc/classes/QskStandardSymbol.metadox b/doc/classes/QskStandardSymbol.metadox new file mode 100644 index 00000000..fb281937 --- /dev/null +++ b/doc/classes/QskStandardSymbol.metadox @@ -0,0 +1,8 @@ +INTERFACE + CLASS: QskStandardSymbol + HEADER: QskStandardSymbol.h + + DESCRIPTION + \brief QskStandardSymbol + END +END diff --git a/doc/classes/QskStatusIndicator.metadox b/doc/classes/QskStatusIndicator.metadox new file mode 100644 index 00000000..f4848c3e --- /dev/null +++ b/doc/classes/QskStatusIndicator.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskStatusIndicator + BASE: QskControl + + QMLCLASS: StatusIndicator + QMLBASE: Control + + HEADER: QskStatusIndicator.h + + DESCRIPTION + \brief QskStatusIndicator + END +END diff --git a/doc/classes/QskStatusIndicatorSkinlet.metadox b/doc/classes/QskStatusIndicatorSkinlet.metadox new file mode 100644 index 00000000..59bc7b6e --- /dev/null +++ b/doc/classes/QskStatusIndicatorSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskStatusIndicatorSkinlet + BASE: QskSkinlet + + HEADER: QskStatusIndicatorSkinlet.h + + DESCRIPTION + \brief QskStatusIndicatorSkinlet + END +END diff --git a/doc/classes/QskSubWindow.metadox b/doc/classes/QskSubWindow.metadox new file mode 100644 index 00000000..be4e6e71 --- /dev/null +++ b/doc/classes/QskSubWindow.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskSubWindow + BASE: QskPopup + + QMLCLASS: SubWindow + QMLBASE: Popup + + HEADER: QskSubWindow.h + + DESCRIPTION + \brief QskSubWindow + END +END diff --git a/doc/classes/QskSubWindowArea.metadox b/doc/classes/QskSubWindowArea.metadox new file mode 100644 index 00000000..53a24c8e --- /dev/null +++ b/doc/classes/QskSubWindowArea.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskSubWindowArea + BASE: QskControl + + QMLCLASS: QskSubWindowArea + QMLBASE: QskControl + + HEADER: QskSubWindowArea.h + + DESCRIPTION + \brief QskSubWindowArea + END +END diff --git a/doc/classes/QskSubWindowAreaSkinlet.metadox b/doc/classes/QskSubWindowAreaSkinlet.metadox new file mode 100644 index 00000000..56de8e07 --- /dev/null +++ b/doc/classes/QskSubWindowAreaSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskSubWindowAreaSkinlet + BASE: QskSkinlet + + HEADER: QskSubWindowAreaSkinlet.h + + DESCRIPTION + \brief QskSubWindowAreaSkinlet + END +END diff --git a/doc/classes/QskSubWindowSkinlet.metadox b/doc/classes/QskSubWindowSkinlet.metadox new file mode 100644 index 00000000..5b19597a --- /dev/null +++ b/doc/classes/QskSubWindowSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskSubWindowSkinlet + BASE: QskSkinlet + + HEADER: QskSubWindowSkinlet.h + + DESCRIPTION + \brief QskSubWindowSkinlet + END +END diff --git a/doc/classes/QskSymbolMaterial.dox b/doc/classes/QskSymbolMaterial.dox deleted file mode 100644 index 8b2ee085..00000000 --- a/doc/classes/QskSymbolMaterial.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskSymbolMaterial.h -*/ - -class QskSymbolMaterial -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskTabButtonSkinlet.dox b/doc/classes/QskTabButtonSkinlet.dox deleted file mode 100644 index 73e431ad..00000000 --- a/doc/classes/QskTabButtonSkinlet.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskTabButtonSkinlet.h - \brief Base class of all skinlets for QskTabButton - */ - -class QskTabButtonSkinlet -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskTabButtonSkinlet.metadox b/doc/classes/QskTabButtonSkinlet.metadox new file mode 100644 index 00000000..439bbac9 --- /dev/null +++ b/doc/classes/QskTabButtonSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskTabButtonSkinlet + BASE: QskSkinlet + + HEADER: QskTabButtonSkinlet.h + + DESCRIPTION + \brief QskTabButtonSkinlet + END +END diff --git a/doc/classes/QskTabViewSkinlet.metadox b/doc/classes/QskTabViewSkinlet.metadox new file mode 100644 index 00000000..fcec0d66 --- /dev/null +++ b/doc/classes/QskTabViewSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskTabViewSkinlet + BASE: QskSkinlet + + HEADER: QskTabViewSkinlet.h + + DESCRIPTION + \brief QskTabViewSkinlet + END +END diff --git a/doc/classes/QskTextColors.metadox b/doc/classes/QskTextColors.metadox new file mode 100644 index 00000000..963d3263 --- /dev/null +++ b/doc/classes/QskTextColors.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskTextColors + QMLCLASS: TextColors + + HEADER: QskTextColors.h + + DESCRIPTION + \brief QskTextColors + END +END diff --git a/doc/classes/QskTextInput.metadox b/doc/classes/QskTextInput.metadox new file mode 100644 index 00000000..e5f46fd1 --- /dev/null +++ b/doc/classes/QskTextInput.metadox @@ -0,0 +1,13 @@ +INTERFACE + CLASS: QskTextInput + BASE: QskControl + + QMLCLASS: QskTextInput + QMLBASE: Control + + HEADER: QskTextInput.h + + DESCRIPTION + \brief QskTextInput + END +END diff --git a/doc/classes/QskTextInputSkinlet.metadox b/doc/classes/QskTextInputSkinlet.metadox new file mode 100644 index 00000000..a422dff7 --- /dev/null +++ b/doc/classes/QskTextInputSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskTextInputSkinlet + BASE: QskSkinlet + + HEADER: QskTextInputSkinlet.h + + DESCRIPTION + \brief QskTextInputSkinlet + END +END diff --git a/doc/classes/QskTextLabelSkinlet.dox b/doc/classes/QskTextLabelSkinlet.dox deleted file mode 100644 index c8f8264d..00000000 --- a/doc/classes/QskTextLabelSkinlet.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskTextLabelSkinlet.h - \brief Base class of all skinlets for QskTextLabel - */ - -class QskTextLabelSkinlet -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskTextLabelSkinlet.metadox b/doc/classes/QskTextLabelSkinlet.metadox new file mode 100644 index 00000000..e8104e97 --- /dev/null +++ b/doc/classes/QskTextLabelSkinlet.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskTextLabelSkinlet + BASE: QskSkinlet + + HEADER: QskTextLabelSkinlet.h + + DESCRIPTION + \brief QskTextLabelSkinlet + END +END diff --git a/doc/classes/QskTextNode.metadox b/doc/classes/QskTextNode.metadox new file mode 100644 index 00000000..0c46e1b9 --- /dev/null +++ b/doc/classes/QskTextNode.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskTextNode + BASE: QSGTransformNode + + HEADER: QskTextNode.h + + DESCRIPTION + \brief QskTextNode + END +END diff --git a/doc/classes/QskTextOptions.dox b/doc/classes/QskTextOptions.dox deleted file mode 100644 index 4785087e..00000000 --- a/doc/classes/QskTextOptions.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskTextOptions.h - \brief Text attributes that can be set from QML - */ - -class QskTextOptions -{ -/*! - -*/ -}; diff --git a/doc/classes/QskTextOptions.metadox b/doc/classes/QskTextOptions.metadox new file mode 100644 index 00000000..50241c50 --- /dev/null +++ b/doc/classes/QskTextOptions.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskTextOptions + QMLCLASS: TextOptions + + HEADER: QskTextOptions.h + + DESCRIPTION + \brief Text attributes that can be set from QML + END +END diff --git a/doc/classes/QskTextRenderer.dox b/doc/classes/QskTextRenderer.dox deleted file mode 100644 index cd246997..00000000 --- a/doc/classes/QskTextRenderer.dox +++ /dev/null @@ -1,15 +0,0 @@ -/*! - \headerfile QskTextRenderer.h - \brief A renderer creating a scene graph subtree from a text - - \note The current implementation relies on QQuickText item - using one global instance for the application. - */ - -class QskTextRenderer -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskTextureNode.dox b/doc/classes/QskTextureNode.dox deleted file mode 100644 index 0c7afee2..00000000 --- a/doc/classes/QskTextureNode.dox +++ /dev/null @@ -1,11 +0,0 @@ -/*! - \headerfile QskTextureNode.h - \brief QSGSimpleTextureNode under control of a QSGTransformNode - */ - -class QskTextureNode -{ -/*! - -*/ -}; diff --git a/doc/classes/QskTextureNode.metadox b/doc/classes/QskTextureNode.metadox new file mode 100644 index 00000000..df24bf9a --- /dev/null +++ b/doc/classes/QskTextureNode.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskTextureNode + BASE: QSGGeometryNode + + HEADER: QskTextureNode.h + + DESCRIPTION + \brief QskTextureNode + END +END diff --git a/doc/classes/QskTextureRenderer.dox b/doc/classes/QskTextureRenderer.dox deleted file mode 100644 index 07bf5b9b..00000000 --- a/doc/classes/QskTextureRenderer.dox +++ /dev/null @@ -1,13 +0,0 @@ -/*! - \headerfile QskTextureRenderer.h - \brief A renderer creating a QSGSimpleTextureNode from a QskGraphic - \sa QskGraphicTextureFactory::createTexture() - */ - -class QskTextureRenderer -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskVariantAnimator.metadox b/doc/classes/QskVariantAnimator.metadox new file mode 100644 index 00000000..738d1b60 --- /dev/null +++ b/doc/classes/QskVariantAnimator.metadox @@ -0,0 +1,10 @@ +INTERFACE + CLASS: QskVariantAnimator + BASE: QskAnimator + + HEADER: QskVariantAnimator.h + + DESCRIPTION + \brief QskVariantAnimator + END +END diff --git a/doc/classes/QskVertexColor.dox b/doc/classes/QskVertexColor.dox deleted file mode 100644 index dd61b885..00000000 --- a/doc/classes/QskVertexColor.dox +++ /dev/null @@ -1,9 +0,0 @@ -/*! \class QskVertexColor - - \brief An RGBA color that can be used for vertex lists of QSGGeometryNode - */ - -/*! \class QskVertexColorMap - - \brief An color map interpolating between QskVertexColor colors. - */ diff --git a/doc/classes/QskVertexPen.dox b/doc/classes/QskVertexPen.dox deleted file mode 100644 index e69de29b..00000000 diff --git a/doc/classes/QskVertexRenderer.dox b/doc/classes/QskVertexRenderer.dox deleted file mode 100644 index 28236fa9..00000000 --- a/doc/classes/QskVertexRenderer.dox +++ /dev/null @@ -1,12 +0,0 @@ -/*! - \headerfile QskVertexRenderer.h - \brief A vertex renderer for creating vertex lists for monochrome shapes - */ - -class QskVertexRenderer -{ -/*! - -*/ -}; - diff --git a/doc/classes/QskVertexRendererColored.dox b/doc/classes/QskVertexRendererColored.dox deleted file mode 100644 index c1a42cc7..00000000 --- a/doc/classes/QskVertexRendererColored.dox +++ /dev/null @@ -1,5 +0,0 @@ -/*! \class QskVertexRendererColored - - \brief A vertex renderer for creating vertex lists for multicolored shapes - */ - diff --git a/doc/qskmodules.dox b/doc/qskmodules.dox index 95fa3042..87f26d6e 100644 --- a/doc/qskmodules.dox +++ b/doc/qskmodules.dox @@ -1,131 +1,124 @@ /*! - \defgroup Classes C++ Classes + \defgroup Core Core \{ - \defgroup Controls Controls - \{ - \class QskSetup - \class QskControl - \class QskAbstractButton - \class QskRangeControl - \class QskPushButton - \class QskFocusIndicator - \class QskFrame - \class QskGraphicLabel - \class QskImage - \class QskRectangle - \class QskResizable - \class QskScrollView - \class QskListView - \class QskSeparator - \class QskSimpleListBox - \class QskSlider - \class QskTabBar - \class QskTabButton - \class QskTabView - \class QskTextLabel - \class QskWindow - \class QskDialogButtonBox - \class QskDialog - \class QskMessageBox - \class QskStandardIcons - \} + \namespace QskNamespace - \defgroup Layouts - \{ - \class QskLayout - \class QskGridBox - \class QskIndexedLayoutBox - \class QskLayoutEngine - \class QskLayoutItem - \class QskStackLayoutAnimation - \class QskStackBox - \class QskLinearBox - \} - - \defgroup Graphic - \{ - \class QskGraphic - \class QskGraphicImageProvider - \class QskGraphicPaintEngine - \class QskGraphicPaintFilter - \class QskGraphicProvider - \class QskGraphicTextureFactory - \class QskPainterCommand - - \namespace QskGraphicIO - \} - - \defgroup Skins - \{ - \namespace QskAspect - \struct QskSkinHint - \class QskSkin - \class QskSkinnable - \class QskSkinlet - \class QskPushButtonSkinlet - \class QskFocusIndicatorSkinlet - \class QskFrameSkinlet - \class QskGraphicLabelSkinlet - \class QskSliderSkinlet - \class QskTabButtonSkinlet - \class QskTextLabelSkinlet - \} - - \defgroup Nodes - \{ - \class QskArcIterator - \class QskClipNode - \class QskFrameNode - \class QskGeometry - \class QskPlainTextRenderer - \class QskRectNode - \class QskSymbolMaterial - \class QskTextRenderer - \class QskTextureNode - \class QskTextureRenderer - \class QskVertexColor - \class QskVertexPen - \class QskVertexRendererColored - \class QskVertexRenderer - \} + \class QskColorFilter + \class QskGraphic + \class QskGraphicImageProvider + \class QskGraphicIO + \class QskGraphicProvider + \class QskGraphicProviderMap + \class QskGraphicTextureFactory + \class QskGradient + \class QskMargins + \class QskObjectCounter + \class QskSetup + \class QskSkinManager + \class QskVariantAnimator + \class QskAnimator + \class QskHintAnimator + \class QskFlickAnimator + \class QskQuickItem + \class QskControl + \class QskShortcutMap + \class QskSizePolicy + \class QskGesture + \class QskGestureRecognizer + \class QskPanGestureRecognizer + \class QskSkinHintTable + \class QskSkinlet + \class QskAnimationHint + \class QskAspect + \class QskSkinFactory + \class QskSkin + \class QskSkinnable + \class QskSkinTransition + \class QskWindow + \class QskBoxShapeMetrics + \class QskBoxBorderColors + \class QskBoxBorderMetrics + \class QskTextColors + \class QskTextOptions \} - \defgroup QMLTypes QML Types + \defgroup Controls Controls \{ - \defgroup QMLControls Controls - \{ - \class Control - - \class AbstractButton - \class RangeControl - \class PushButton - \class FocusIndicator - \class Frame - \class GraphicLabel - \class Image - \class ListView - \class Rectangle - \class SimpleListBox - \class ScrollView - \class Separator - \class Slider - \class TabBar - \class TabButton - \class TabView - \class TextLabel - \class Window - \class DialogButtonBox - \class Dialog - \class MessageBox - \} - - \defgroup QMLLayouts Layouts - \{ - \class Layout - \class GridBox - \class IndexedLayoutBox - \class StackBox - \class LinearBox - \} + \class QskAbstractButton + \class QskBox + \class QskFocusIndicator + \class QskGraphicLabel + \class QskListView + \class QskPageIndicator + \class QskPopup + \class QskPushButton + \class QskRangeControl + \class QskScrollArea + \class QskScrollView + \class QskSlider + \class QskStatusIndicator + \class QskSubWindowArea + \class QskSubWindow + \class QskTabBar + \class QskTabButton + \class QskTabView + \class QskTextInput + \class QskTextLabel \} + + \defgroup Layouts + \{ + \class QskGridBox + \class QskIndexedLayoutBox + \class QskLinearBox + \class QskStackBox + \} + + \defgroup Dialogs + \{ + \class QskDialogButtonBox + \class QskDialogButton + \class QskDialog + \class QskDialogSubWindow + \class QskDialogWindow + \class QskMessageSubWindow + \class QskMessageWindow + \class QskSelectionSubWindow + \class QskSelectionWindow + \class QskSeparator + \class QskSimpleListBox + \} + + \defgroup Skins + \{ + \class QskBoxSkinlet + \class QskFocusIndicatorSkinlet + \class QskGraphicLabelSkinlet + \class QskListViewSkinlet + \class QskPageIndicatorSkinlet + \class QskPopupSkinlet + \class QskPushButtonSkinlet + \class QskScrollViewSkinlet + \class QskSeparatorSkinlet + \class QskSliderSkinlet + \class QskStatusIndicatorSkinlet + \class QskSubWindowAreaSkinlet + \class QskSubWindowSkinlet + \class QskTabButtonSkinlet + \class QskTabViewSkinlet + \class QskTextInputSkinlet + \class QskTextLabelSkinlet + \class QskStandardSymbol + \} + + \defgroup Nodes + \{ + \class QskBoxClipNode + \class QskBoxNode + \class QskGraphicNode + \class QskPaintedNode + \class QskTextNode + \class QskTextureNode + \} + */