[Documentation] Add documentation

Contributes to: https://gitlab.com/omprussia/libraries/amberpdf-qml-plugin/-/issues/17

[Documentation] Add documentation
Contributes to: https://gitlab.com/omprussia/libraries/amberpdf-qml-plugin/-/issues/17
a11eb348 · OMP Education · Alexey Andreyev · 0d8e58a3 · a11eb348 · a11eb348
--- a/doc/amberpdf-qml-plugin.qdocconf
+++ b/doc/amberpdf-qml-plugin.qdocconf
+project         = AmberPDF
+description     = AmberPDF Reference Documentation
+version         = 1.0.0
+language = Cpp
+sourcedirs = ./src \
+             ../plugin 
+headerdirs = ./src \
+             ../plugin
+outputdir = $$PWD/../html
+outputformats = HTML
+qhp.projects            = AmberPDF
+qhp.Amberpdf.file               = amberpdf.qhp
+qhp.Amberpdf.namespace          = ru.omp.amberpdf.100
+qhp.Amberpdf.indexTitle         = AmberPDF
+qhp.Amberpdf.virtualFolder      = amberpdf
+qhp.Amberpdf.indexRoot          = 
+qhp.Amberpdf.subprojects = overview qmltypes
+qhp.Amberpdf.subprojects.overview.title = AmberPDF QML Plugin Overview
+qhp.Amberpdf.subprojects.overview.indexTitle = AmberPDF QML Plugin Overview
+qhp.Amberpdf.subprojects.overview.type = manual
+qhp.Amberpdf.subprojects.qmltypes.title = QML Types
+qhp.Amberpdf.subprojects.qmltypes.indexTitle = AmberPDF QML Types
+qhp.Amberpdf.subprojects.qmltypes.selector = qmlmodule:ru.omp.amberpdf
+qhp.Amberpdf.subprojects.qmltypes.sortpages = true
+navigation.homepage = "AmberPDF QML Plugin Overview"
--- a/doc/src/amberpdf-pdfview.qdoc
+++ b/doc/src/amberpdf-pdfview.qdoc
+/*!
+    \qmltype PdfView
+    \inqmlmodule ru.omp.amberpdf
+    \since amberpdf 1.0
+    \brief The PdfView provides simple in use view
+    to display the PDF documents. Support tile render of a pages,
+    annotations, on document navigations.
+    Here is a simple pdf document view:
+    \qml
+    import QtQuick 2.0
+    import ru.omp.amberpdf 1.0
+    PdfView { 
+      id: pdfView 
+      documentProvider: pdfiumProvider 
+      clip: true 
+      width: parent.width 
+      catchBound: pageHeader.height 
+      annotationsPaint: true 
+      notesPaint: true 
+      anchors.horizontalCenter: parent.horizontalCenter 
+    } 
+    // create provider 
+    PdfDocument { id: pdfiumProvider }
+    \endqml
+*/
+/*!
+  \qmlmodule ru.omp.amberpdf 1.0
+  \title AmberPDF QML Types
+  Описание к модулю.
+*/
+/*!
+    \qmlproperty int PdfView::count
+    The document page count.
+*/
+/*!
+    \qmlproperty PdfDocument PdfView::documentProvider
+    The current installed document provider.
+*/
+/*!
+    \qmlproperty int PdfView::currentIndex
+    Index of the currently displayed page.
+*/
+/*!
+    \qmlproperty int PdfView::catchBound
+    The current value, from a top of the view in pixels,
+    when the current page is changed.
+*/
+/*!
+    \qmlproperty enumeration PdfView::orientation
+    The document scroll orientation.
+*/
+/*!
+    \qmlproperty bool PdfView::annotationsPaint
+    The annotation paint control property.
+*/
+/*!
+    \qmlproperty bool PdfView::notesPaint
+    The notes paint control property.
+*/
+/*!
+    \qmlproperty real PdfView::zoom
+    The content zoom.
+*/
+/*!
+    \qmlproperty real PdfView::contentTopMargin
+    The content top margin, from a top of the view.
+*/
+/*!
+    \qmlproperty string PdfView::pdfPath
+    The document path in the device storage.
+*/
+/*!
+    \qmlproperty PdfDocument.Status PdfView::status
+    The current view status.
+*/
+/*!
+    \qmlsignal PdfView::clicked()
+*/
+/*!
+    \qmlsignal PdfView::clickedUrl(string url)
+    This signal is emitted when the user clicked
+    on annotation with a non-empty \a url.
+*/
+/*!
+    \qmlsignal PdfView::noteActivate(string noteText, string author)
+    This signal emitted when the user clicked
+    on the note. Arguments contain \a noteText and \a author.
+*/
+/*!
+    \qmlsignal PdfView::contentChanged()
+    This signal emitted when view content chahges (load new
+    tile, scroll, etc).
+*/
+/*!
+    \qmlmethod PdfView::correctPosition()  
+    This method make view coordinates corrected.
+*/
+/*!
+    \qmlmethod PdfView::goToPage(pageIndex)
+    View got to top of the page on \a pageIndex.
+*/
--- a/doc/src/amberpdf-qml-plugin-index.qdoc
+++ b/doc/src/amberpdf-qml-plugin-index.qdoc
+/*!
+    \page amberpdf-qml-plugin-index.html
+    \title AmberPDF QML Plugin Overview
+    AmberPDF QML Plugin. This plugin provides PdfView QML type
+    that can be used in applications to display PDF documents.
+    It is using \l {https://os-git.omprussia.ru/os/amberpdf}{AmberPDF}
+    library as a render backend.
+    \list
+        \li \l{PdfView}
+    \endlist
+*/