From 70151948ba226ccca701d31aee6704d51a9c44f5 Mon Sep 17 00:00:00 2001 From: Skycoder42 Date: Wed, 20 Jun 2018 00:24:05 +0200 Subject: [PATCH] small doc fixup --- doc/Doxyfile | 4 ++-- doc/makedoc.sh | 2 +- doc/settingsxml.dox | 9 +++++---- 3 files changed, 8 insertions(+), 7 deletions(-) diff --git a/doc/Doxyfile b/doc/Doxyfile index 52c74b8..c0d0951 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -1458,7 +1458,7 @@ QCH_FILE = ../qtmvvm.qch # The default value is: org.doxygen.Project. # 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 # Help Project output. For more information please see Qt Help Project / Virtual @@ -1969,7 +1969,7 @@ RTF_SOURCE_CODE = NO # classes and files. # 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 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of diff --git a/doc/makedoc.sh b/doc/makedoc.sh index 2cedc74..07b92fa 100755 --- a/doc/makedoc.sh +++ b/doc/makedoc.sh @@ -27,7 +27,7 @@ echo "PROJECT_NUMBER = \"$version\"" >> $doxyRes echo "INPUT += \"$readme\"" >> $doxyRes echo "USE_MDFILE_AS_MAINPAGE = \"$readme\"" >> $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_ATTRS = \"qtmvvm $version\"" >> $doxyRes echo "QHG_LOCATION = \"$qtBins/qhelpgenerator\"" >> $doxyRes diff --git a/doc/settingsxml.dox b/doc/settingsxml.dox index 10d2147..3398a87 100644 --- a/doc/settingsxml.dox +++ b/doc/settingsxml.dox @@ -132,7 +132,8 @@ The `` element is mapped to the QtMvvm::SettingsElements::Entry. type | @ref settings_xml_types_type | `"QString"` | no | @copybrief QtMvvm::SettingsElements::Entry::type title | string | Empty | yes | @copybrief QtMvvm::SettingsElements::Entry::title tooltip | string | Empty | yes | @copybrief QtMvvm::SettingsElements::Entry::tooltip - defaultValue | variant | Invalid | yes | @copybrief QtMvvm::SettingsElements::Entry::defaultValue + default | variant | Invalid | `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 | Empty | no | @copybrief QtMvvm::SettingsElements::Entry::frontends selectors | @ref settings_xml_types_descriptor | Empty | no | @copybrief QtMvvm::SettingsElements::Entry::selectors @@ -160,7 +161,7 @@ long as for the last two their type is `object` --------|-------------------------------|-------------------|---------------|------------- key | string | Required | no | The key of the property type | @ref settings_xml_types_type | Required | 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 @@ -183,7 +184,7 @@ same. Name | Type | Default | Translated | Description --------|-------------------------------|-------------------|---------------|------------- type | @ref settings_xml_types_type | Required | 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 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 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 `` element or the contents of a `` element. Typical values would be: - QString or string