search

papyros / qml-material

:book: Material Design implemented in QtQuick
GNU Lesser General Public License v2.1
2.57k stars 476 forks source link

Building Documentation fails #339

Open oiaavb opened 8 years ago

oiaavb commented 8 years ago

Hi,

I'm trying to build the documentation but getting this error:

E:\QtProjects\qml-material\documentation>qdoc material.qdocconf -debug START DEBUGGING: "command line" DEBUG: " loading index files" DEBUG: " done loading index files" DEBUG: "Reading excludedirs" DEBUG: "Reading excludefiles" DEBUG: "Reading headerdirs" DEBUG: "Reading sourcedirs" DEBUG: "Reading exampledirs" DEBUG: "Adding doc/image dirs found in exampledirs to imagedirs" DEBUG: "Parsing header files" DEBUG: "Parsing source files" DEBUG: "Parsing E:/QtProjects/qml-material/documentation/material.qdoc" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Action.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ActionBar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ActionButton.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/AppTheme.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ApplicationWindow.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/AwesomeIcon.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/BottomActionSheet.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/BottomSheet.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Button.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Card.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/CheckBox.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Device.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Dialog.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Dropdown.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Icon.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/IconButton.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Ink.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/InputDialog.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Label.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/BaseListItem.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/Divider.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/SectionHeader.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/SimpleMenu.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/Standard.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/Subheader.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/Subtitled.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/MainView.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/MaterialAnimation.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/MenuField.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/NavigationDrawer.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Object.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/OverlayLayer.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/OverlayView.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Page.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/PageSidebar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/PageStack.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Palette.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Popover.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/PopupBase.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ProgressBar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ProgressCircle.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/RadioButton.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Scrollbar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Sidebar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Slider.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Snackbar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Switch.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/TabView.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Tabs.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/TextField.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Theme.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ThemePalette.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ThinDivider.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/TimePicker.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/TimePickerDialog.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Toolbar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Tooltip.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Units.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/View.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Wave.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Window.qml" DEBUG: "Parsing done." DEBUG: "Resolving stuff prior to generating docs" DEBUG: "Generating docs" E:/QtProjects/qml-material/documentation/material.qdocconf:16: error: Unknown output format 'DITAXML' Unknown output format 'DITAXML'

Aborting

Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

neitsa commented 8 years ago

You can use another output format on the command line with --outputformat for example with HTML.

G:\repositories\Qt\qml-material\documentation>qdoc material.qdocconf --debug --outputformat HTML --outputdir .\..\qml-material-doc
oiaavb commented 8 years ago

I would like to integrate the documentation in QtCreator. AFAIK I would need to build in DITAXML format. But why am I getting this error message and what can I do about it?

Building html works a little bit better. It builds a little bit but then freezes for some time before crashing. This is the output: E:\QtProjects\qml-material\documentation>e:\Qt\Qt5Enterprise\5.5\msvc2013\bin\qdoc.exe material.qdocconf --debug --outputformat HTML --outputdir ...\qml-material-doc START DEBUGGING: "command line" DEBUG: " loading index files" DEBUG: " done loading index files" DEBUG: "Reading excludedirs" DEBUG: "Reading excludefiles" DEBUG: "Reading headerdirs" DEBUG: "Reading sourcedirs" DEBUG: "Reading exampledirs" DEBUG: "Adding doc/image dirs found in exampledirs to imagedirs" DEBUG: "Parsing header files" DEBUG: "Parsing source files" DEBUG: "Parsing E:/QtProjects/qml-material/documentation/material.qdoc" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Action.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ActionBar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ActionButton.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/AppTheme.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ApplicationWindow.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/AwesomeIcon.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/BottomActionSheet.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/BottomSheet.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Button.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Card.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/CheckBox.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Device.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Dialog.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Dropdown.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Icon.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/IconButton.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Ink.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/InputDialog.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Label.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/BaseListItem.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/Divider.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/SectionHeader.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/SimpleMenu.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/Standard.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/Subheader.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ListItems/Subtitled.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/MainView.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/MaterialAnimation.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/MenuField.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/NavigationDrawer.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Object.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/OverlayLayer.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/OverlayView.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Page.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/PageSidebar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/PageStack.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Palette.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Popover.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/PopupBase.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ProgressBar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ProgressCircle.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/RadioButton.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Scrollbar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Sidebar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Slider.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Snackbar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Switch.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/TabView.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Tabs.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/TextField.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Theme.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ThemePalette.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/ThinDivider.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/TimePicker.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/TimePickerDialog.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Toolbar.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Tooltip.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Units.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/View.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Wave.qml" DEBUG: "Parsing E:/QtProjects/qml-material/modules/Material/Window.qml" DEBUG: "Parsing done." DEBUG: "Resolving stuff prior to generating docs" DEBUG: "Generating docs" DEBUG: "Writing: ...\qml-material-doc/material-qmlmodule.html" DEBUG: "Writing: ...\qml-material-doc/qml-material-action.html" DEBUG: "Writing: ...\qml-material-doc/qml-material-action-members.html" E:/QtProjects/qml-material/modules/Material/Action.qml:49: warning: Can't link to 'color' DEBUG: "Writing: ...\qml-material-doc/qml-material-actionbar.html" DEBUG: "Writing: ...\qml-material-doc/qml-material-actionbar-members.html" DEBUG: "Writing: ...\qml-material-doc/qml-material-actionbutton.html"

ukoehler commented 8 years ago

Confirmed behaviour on Linux:

qdoc material.qdocconf --debug --outputformat HTML --outputdir ./html
START DEBUGGING:    "command line"
DEBUG: "  loading index files"
DEBUG: "  done loading index files"
DEBUG: "Reading excludedirs"
DEBUG: "Reading excludefiles"
DEBUG: "Reading headerdirs"
DEBUG: "Reading sourcedirs"
DEBUG: "Reading exampledirs"
DEBUG: "Adding doc/image dirs found in exampledirs to imagedirs"
DEBUG: "Parsing header files"
DEBUG: "Parsing source files"
DEBUG: "Parsing /home/ukoehler/devel/C++/qt/qml/qml-material-develop/documentation/material.qdoc"
...
DEBUG: "Generating docs"
DEBUG: "Writing: ./html/material-qmlmodule.html"
DEBUG: "Writing: ./html/qml-material-action.html"
DEBUG: "Writing: ./html/qml-material-action-members.html"
/home/ukoehler/devel/C++/qt/qml/qml-material-develop/modules/Material/Action.qml:38: warning: Can't link to 'iconName'
/home/ukoehler/devel/C++/qt/qml/qml-material-develop/modules/Material/Action.qml:38: warning: Can't link to 'color'
/home/ukoehler/devel/C++/qt/qml/qml-material-develop/modules/Material/Action.qml:38: warning: Can't link to 'iconName'
/home/ukoehler/devel/C++/qt/qml/qml-material-develop/modules/Material/Action.qml:71: warning: No documentation for 'Action::text'
/home/ukoehler/devel/C++/qt/qml/qml-material-develop/modules/Material/Action.qml:72: warning: No documentation for 'Action::tooltip'
DEBUG: "Writing: ./html/qml-material-actionbar.html"
DEBUG: "Writing: ./html/qml-material-actionbar-members.html"
 /home/ukoehler/devel/C++/qt/qml/qml-material-develop/modules/Material/ActionBar.qml:162: warning: No documentation for 'ActionBar::leftKeyline'
DEBUG: "Writing: ./html/qml-material-actionbutton.html"
Getötet

Where Getötet means killed

timsueberkrueb commented 8 years ago

This is an upstream bug in Qt that has already been fixed (fix will be included in Qt 5.6). See https://bugreports.qt.io/browse/QTBUG-50163. Looks like DITAXML is no longer available as output format?