hatam
/
QtMvvm
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Browse Source

small doc fixup

pull/2/head
Skycoder42 7 years ago
parent
b84ea3b2a1
commit
70151948ba
No known key found for this signature in database GPG Key ID: 8E01AD9EF0578D2B
3 changed files with 8 additions and 7 deletions
Whitespace
Show all changes Ignore whitespace when comparing lines Ignore changes in amount of whitespace Ignore changes in whitespace at EOL
Unified View
Diff Options
Show Stats Download Patch File Download Diff File
  1. 4
      doc/Doxyfile
  2. 2
      doc/makedoc.sh
  3. 9
      doc/settingsxml.dox

4
doc/Doxyfile
View File

@ -1458,7 +1458,7 @@ QCH_FILE = ../qtmvvm.qch
# The default value is: org.doxygen.Project. # The default value is: org.doxygen.Project.
# This tag requires that the tag GENERATE_QHP is set to YES. # This tag requires that the tag GENERATE_QHP is set to YES.
QHP_NAMESPACE = com.skycoder42.qtmvvm.100 QHP_NAMESPACE = de.skycoder42.qtmvvm.100
# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt # 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 # Help Project output. For more information please see Qt Help Project / Virtual
@ -1969,7 +1969,7 @@ RTF_SOURCE_CODE = NO
# classes and files. # classes and files.
# The default value is: NO. # The default value is: NO.
GENERATE_MAN = NO GENERATE_MAN = YES
# The MAN_OUTPUT tag is used to specify where the man pages will be put. If a # The MAN_OUTPUT tag is used to specify where the man pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

2
doc/makedoc.sh
View File

@ -27,7 +27,7 @@ echo "PROJECT_NUMBER = \"$version\"" >> $doxyRes
echo "INPUT += \"$readme\"" >> $doxyRes echo "INPUT += \"$readme\"" >> $doxyRes
echo "USE_MDFILE_AS_MAINPAGE = \"$readme\"" >> $doxyRes echo "USE_MDFILE_AS_MAINPAGE = \"$readme\"" >> $doxyRes
echo "OUTPUT_DIRECTORY = \"$destDir\"" >> $doxyRes echo "OUTPUT_DIRECTORY = \"$destDir\"" >> $doxyRes
echo "QHP_NAMESPACE = \"com.skycoder42.qtmvvm.$verTag\"" >> $doxyRes echo "QHP_NAMESPACE = \"de.skycoder42.qtmvvm.$verTag\"" >> $doxyRes
echo "QHP_CUST_FILTER_NAME = \"Mvvm $version\"" >> $doxyRes echo "QHP_CUST_FILTER_NAME = \"Mvvm $version\"" >> $doxyRes
echo "QHP_CUST_FILTER_ATTRS = \"qtmvvm $version\"" >> $doxyRes echo "QHP_CUST_FILTER_ATTRS = \"qtmvvm $version\"" >> $doxyRes
echo "QHG_LOCATION = \"$qtBins/qhelpgenerator\"" >> $doxyRes echo "QHG_LOCATION = \"$qtBins/qhelpgenerator\"" >> $doxyRes

9
doc/settingsxml.dox
View File

@ -132,7 +132,8 @@ The `<Entry>` element is mapped to the QtMvvm::SettingsElements::Entry.
type | @ref settings_xml_types_type | `"QString"` | no | @copybrief QtMvvm::SettingsElements::Entry::type type | @ref settings_xml_types_type | `"QString"` | no | @copybrief QtMvvm::SettingsElements::Entry::type
title | string | <i>Empty</i> | yes | @copybrief QtMvvm::SettingsElements::Entry::title title | string | <i>Empty</i> | yes | @copybrief QtMvvm::SettingsElements::Entry::title
tooltip | string | <i>Empty</i> | yes | @copybrief QtMvvm::SettingsElements::Entry::tooltip tooltip | string | <i>Empty</i> | yes | @copybrief QtMvvm::SettingsElements::Entry::tooltip
defaultValue | variant | <i>Invalid</i> | yes | @copybrief QtMvvm::SettingsElements::Entry::defaultValue default | variant | <i>Invalid</i> | `trdefault` | @copybrief QtMvvm::SettingsElements::Entry::defaultValue
trdefault | bool | `false` | no | If set to true, `default` will be translated. If not set or set to false, it will not be
frontends | @ref settings_xml_types_descriptor | <i>Empty</i> | no | @copybrief QtMvvm::SettingsElements::Entry::frontends frontends | @ref settings_xml_types_descriptor | <i>Empty</i> | no | @copybrief QtMvvm::SettingsElements::Entry::frontends
selectors | @ref settings_xml_types_descriptor | <i>Empty</i> | no | @copybrief QtMvvm::SettingsElements::Entry::selectors selectors | @ref settings_xml_types_descriptor | <i>Empty</i> | no | @copybrief QtMvvm::SettingsElements::Entry::selectors
@ -160,7 +161,7 @@ long as for the last two their type is `object`
--------|-------------------------------|-------------------|---------------|------------- --------|-------------------------------|-------------------|---------------|-------------
key | string | <i>Required</i> | no | The key of the property key | string | <i>Required</i> | no | The key of the property
type | @ref settings_xml_types_type | <i>Required</i> | no | The type of the properties value type | @ref settings_xml_types_type | <i>Required</i> | no | The type of the properties value
ts | bool | `false` | no | Specify whether the properties value (content) should be translated. Does not apply to `list` or `object` types tr | bool | `false` | no | Specify whether the properties value (content) should be translated. Does not apply to `list` or `object` types
@subsubsection settings_xml_elements_property_elements Content @subsubsection settings_xml_elements_property_elements Content
@ -183,7 +184,7 @@ same.
Name | Type | Default | Translated | Description Name | Type | Default | Translated | Description
--------|-------------------------------|-------------------|---------------|------------- --------|-------------------------------|-------------------|---------------|-------------
type | @ref settings_xml_types_type | <i>Required</i> | no | The type of the list element type | @ref settings_xml_types_type | <i>Required</i> | no | The type of the list element
ts | bool | `false` | no | Specify whether the element value (content) should be translated. Does not apply to `list` or `object` types tr | bool | `false` | no | Specify whether the element value (content) should be translated. Does not apply to `list` or `object` types
@subsubsection settings_xml_elements_element_elements Content @subsubsection settings_xml_elements_element_elements Content
The content depend on the `type` attribute. The following tables shows which type leads The content depend on the `type` attribute. The following tables shows which type leads
@ -231,7 +232,7 @@ The following table lists all basic types that don't need much explanation:
@subsection settings_xml_types_type type @subsection settings_xml_types_type type
The `type` type must be a simple string that corresponds to a C++ type name (or special ui The `type` type must be a simple string that corresponds to a C++ type name (or special ui
type, for entry elements). It defines the actual type of for example the defaultValue of the type, for entry elements). It defines the actual type of for example the default of the
`<Entry>` element or the contents of a `<Property>` element. Typical values would be: `<Entry>` element or the contents of a `<Property>` element. Typical values would be:
- QString or string - QString or string

Write Preview
Loading…
Cancel
Save