Commit 36ab75c4 authored by Michal Policht's avatar Michal Policht

Update documentation related files to reflect new directory structure.

parent 14b57a06
......@@ -793,12 +793,10 @@ WARN_LOGFILE =
INPUT = README.md \
doc/README.md \
external/README.md \
modules/README.md \
QML/README.md \
extensions/README.md \
tools/README.md \
doc/pages/ModulesList.dox \
doc/pages/ToolsList.dox \
doc/pages/QMLList.dox
doc/pages/ExtensionsList.dox \
doc/pages/ToolsList.dox
# 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
......
......@@ -42,30 +42,27 @@ DEPLOY_DIR = $(EXTERNAL_ROOT)/deploy
# Recipes directory.
RECIPES_DIR = $(EXTERNAL_ROOT)/recipes/$(TARGET_MACHINE)
LICENSE_DSLASH_DIRS = QML examples modules qbs tools
LICENSE_DSLASH_DIRS = examples extensions qbs tools
LICENSE_XML_DIRS = examples
INCLUDE_GUARDS_DIRS = QML examples modules tools
INCLUDE_GUARDS_DIRS = examples extensions tools
DOXYGEN_INPUT_DIRS = Doxyfile modules tools QML external/recipes
DOXYGEN_INPUT_DIRS = Doxyfile extensions tools external/recipes
DOXYGEN_OUTPUT_DIRS = doc/Doxygen/docs
DOC_PROJECT_TARGETS = $(DOC_MODULES_LIST_FILE) $(DOC_TOOLS_LIST_FILE) $(DOC_QML_LIST_FILE) \
DOC_PROJECT_TARGETS = $(DOC_EXTENSIONS_LIST_FILE) $(DOC_TOOLS_LIST_FILE) \
doc_project_doxyqml
# Directory for autogenerated files.
MAKEFILE_PROJECT_AUTOGEN_DIR = $(PROJECT_DIR)/doc/_temp/Makefile.project
# File containing list of modules.
DOC_MODULES_LIST_FILE = $(MAKEFILE_PROJECT_AUTOGEN_DIR)/ModulesList.inc.dox
# File containing list of tools.
DOC_TOOLS_LIST_FILE = $(MAKEFILE_PROJECT_AUTOGEN_DIR)/ToolsList.inc.dox
# File containing list of QML modules.
DOC_QML_LIST_FILE = $(MAKEFILE_PROJECT_AUTOGEN_DIR)/QMLList.inc.dox
# File containing list of extensions.
DOC_EXTENSIONS_LIST_FILE = $(MAKEFILE_PROJECT_AUTOGEN_DIR)/ExtensionsList.inc.dox
# Doxyqml wrapper (doxyqml does not have '.py' extension, which is problematic under Windows).
DOXYQML_PY = $(MAKEFILE_PROJECT_AUTOGEN_DIR)/doxyqml.py
......@@ -73,7 +70,7 @@ DOXYQML_PY = $(MAKEFILE_PROJECT_AUTOGEN_DIR)/doxyqml.py
# Product entry print script.
DOCPRODENTRY = awkgward/docprodentry.sh
INCLUDE_GUARDS_EXCLUDE = ! -path 'modules/templates_*'
INCLUDE_GUARDS_EXCLUDE = ! -path 'extensions/templates_*'
# Add directory with doxyqml wrapper to the PATH, so that it can be seen by Doxygen.
PATH := $(PATH):$(MAKEFILE_PROJECT_AUTOGEN_DIR)
......@@ -84,13 +81,6 @@ include $(dir $(abspath $(lastword $(MAKEFILE_LIST))))Makefile.toolchain
.PHONY: doc_project_doxyqml
$(DOC_MODULES_LIST_FILE): modules $(MAKEFILE_PROJECT_AUTOGEN_DIR) $(DOCPRODENTRY) | $(SH) $(FIND) $(XARGS) $(SORT) $(BASENAME) $(DIRNAME) $(ECHO)
@$(ECHO) Generating "$@" file...
@$(ECHO) '<!-- This file has been autogenerated by Makefile.project. -->' > $@
@$(FIND) modules \( -name 'Doxyfile' -o -name '*.Doxyfile' \) \
| $(SORT) | $(XARGS) -I {} $(SH) $(DOCPRODENTRY) {} >> $@
@$(ECHO) '.' >> $@
$(DOC_TOOLS_LIST_FILE): tools $(MAKEFILE_PROJECT_AUTOGEN_DIR) $(DOCPRODENTRY) | $(SH) $(FIND) $(XARGS) $(SORT) $(BASENAME) $(DIRNAME) $(ECHO)
@$(ECHO) Generating "$@" file...
@$(ECHO) '<!-- This file has been autogenerated by Makefile.project. -->' > $@
......@@ -98,10 +88,10 @@ $(DOC_TOOLS_LIST_FILE): tools $(MAKEFILE_PROJECT_AUTOGEN_DIR) $(DOCPRODENTRY) |
| $(SORT) | $(XARGS) -I {} $(SH) $(DOCPRODENTRY) {} >> $@
@$(ECHO) '.' >> $@
$(DOC_QML_LIST_FILE): QML $(MAKEFILE_PROJECT_AUTOGEN_DIR) $(DOCPRODENTRY) | $(SH) $(FIND) $(XARGS) $(SORT) $(BASENAME) $(DIRNAME) $(ECHO)
$(DOC_EXTENSIONS_LIST_FILE): extensions $(MAKEFILE_PROJECT_AUTOGEN_DIR) $(DOCPRODENTRY) | $(SH) $(FIND) $(XARGS) $(SORT) $(BASENAME) $(DIRNAME) $(ECHO)
@$(ECHO) Generating "$@" file...
@$(ECHO) '<!-- This file has been autogenerated by Makefile.project. -->' > $@
@$(FIND) QML \( -name 'Doxyfile' -o -name '*.Doxyfile' \) \
@$(FIND) extensions \( -name 'Doxyfile' -o -name '*.Doxyfile' \) \
| $(SORT) | $(XARGS) -I {} $(SH) $(DOCPRODENTRY) {} >> $@
@$(ECHO) '.' >> $@
......
......@@ -3,9 +3,8 @@
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="user" url="../index.html" title="Main Page"/>
<tab type="user" url="../modules_list.html" title="Modules"/>
<tab type="user" url="../extensions_list.html" title="Extensions"/>
<tab type="user" url="../tools_list.html" title="Tools"/>
<tab type="user" url="../qml_list.html" title="QML extensions"/>
<tab type="mainpage" visible="yes" title="Overview"/>
<tab type="pages" visible="yes" title="" intro=""/>
<tab type="modules" visible="yes" title="" intro=""/>
......
......@@ -4,9 +4,8 @@
<navindex>
<tab type="mainpage" visible="yes" title=""/>
<tab type="pages" visible="no" title="" intro=""/>
<tab type="user" url="@ref modulesList" title="Modules"/>
<tab type="user" url="@ref extensionsList" title="Extensions"/>
<tab type="user" url="@ref toolsList" title="Tools"/>
<tab type="user" url="@ref qmlList" title="QML extensions"/>
<tab type="modules" visible="yes" title="" intro=""/>
<tab type="namespaces" visible="yes" title="">
<tab type="namespacelist" visible="yes" title="" intro=""/>
......
......@@ -3,9 +3,8 @@
<!-- Navigation index tabs for HTML output -->
<navindex>
<tab type="user" url="../index.html" title="Main Page"/>
<tab type="user" url="../modules_list.html" title="Modules"/>
<tab type="user" url="../extensions_list.html" title="Extensions"/>
<tab type="user" url="../tools_list.html" title="Tools"/>
<tab type="user" url="../qml_list.html" title="QML extensions"/>
<tab type="mainpage" visible="yes" title="Overview"/>
<tab type="pages" visible="yes" title="" intro=""/>
<tab type="modules" visible="yes" title="" intro=""/>
......
/**
@page extensionsList List of extensions
Here's a list of documented extensions.
@includedoc Makefile.project/ExtensionsList.inc.dox
*/
/**
@page modulesList List of modules
Here's a list of documented modules.
@includedoc Makefile.project/ModulesList.inc.dox
*/
/**
@page qmlList List of QML extensions
Here's a list of documented QML extensions.
@includedoc Makefile.project/QMLList.inc.dox
*/
......@@ -14,7 +14,7 @@ Module {
/**
Whether to use Doxyqml.
*/
property bool useDoxyqml: product.cutehmiType === "qmlExtension"
property bool useDoxyqml: false
/**
Whether to use input filter. If this property is set to true a _sed_
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment