Cross-link types to examples

QuickGraphLib/Axis.qml

@@ -11,6 +11,8 @@ import QuickGraphLib as QuickGraphLib
     \inqmlmodule QuickGraphLib
     \inherits QtQuick::Item
     \brief Displays an Axis.
+
+    \sa {Basic sin graph (without prefabs)}, {Graph with all four axes}
 */
 
 Item {

QuickGraphLib/ColorMaps.cpp

@@ -11,6 +11,8 @@
     \inqmlmodule QuickGraphLib
     \inherits QObject
     \brief Utility functions for color maps.
+
+    \sa {ImageView}, {Builtin color maps}, {Color mapped images}
 */
 
 extern const std::map<ColorMaps::ColorMapName, QList<QRgb>> DEFAULT_COLORMAPS;

QuickGraphLib/GraphArea.qml

@@ -9,6 +9,8 @@ import QtQuick.Shapes as QQS
     \inqmlmodule QuickGraphLib
     \inherits QtQuick::Shapes::Shape
     \brief An area that graphs can be added to.
+
+    \sa {Basic sin graph (without prefabs)}, {Inverted axes}
 */
 
 QQS.Shape {

QuickGraphLib/GraphItems/AxHLine.qml

@@ -9,6 +9,8 @@ import QtQuick.Shapes as QQS
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::Shapes::ShapePath
     \brief Displays a horizontal line.
+
+    \sa {Spans and lines}
 */
 
 QQS.ShapePath {

QuickGraphLib/GraphItems/AxHSpan.qml

@@ -9,6 +9,8 @@ import QtQuick.Shapes as QQS
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::Shapes::ShapePath
     \brief Displays a horizontal span.
+
+    \sa {Spans and lines}
 */
 
 QQS.ShapePath {

QuickGraphLib/GraphItems/AxVLine.qml

@@ -9,6 +9,8 @@ import QtQuick.Shapes as QQS
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::Rectangle
     \brief Displays an vertical line.
+
+    \sa {Spans and lines}, {Draggable region}
 */
 
 QQS.ShapePath {

QuickGraphLib/GraphItems/AxVSpan.qml

@@ -9,6 +9,8 @@ import QtQuick.Shapes as QQS
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::Shapes::ShapePath
     \brief Displays an vertical span.
+
+    \sa {Spans and lines}, {Basic histogram}, {Draggable region}
 */
 
 QQS.ShapePath {

QuickGraphLib/GraphItems/BasicLegend.qml

@@ -10,6 +10,8 @@ import QtQuick
     \brief Displays a simple legend.
 
     \note This graph item does not inherit from ShapePath, unlike other graph items.
+
+    \sa {Basic sin graph}
 */
 
 Rectangle {

QuickGraphLib/GraphItems/BasicLegendItem.qml

@@ -8,6 +8,8 @@ import QtQuick
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::Row
     \brief An single entry in a simple legend.
+
+    \sa {Basic sin graph}
 */
 
 Row {

QuickGraphLib/GraphItems/ColorMesh.qml

@@ -11,6 +11,8 @@ import QuickGraphLib as QuickGraphLib
     \brief Display a colorized image from a 2D array.
 
     \note This graph item does not inherit from ShapePath, unlike other graph items.
+
+    \sa {Color mesh}, {Color mapped images}
 */
 
 QuickGraphLib.ImageView {

QuickGraphLib/GraphItems/Contour.qml

@@ -10,6 +10,8 @@ import QuickGraphLib as QuickGraphLib
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::Shapes::ShapePath
     \brief Draw a contour line or fill.
+
+    \sa {Contours}
 */
 
 QQS.ShapePath {

QuickGraphLib/GraphItems/GraphItemDragHandler.qml

@@ -8,6 +8,8 @@ import QtQuick
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::MouseArea
     \brief Assists converting mouse drags into data positions.
+
+    \sa {Draggable region}
 */
 
 MouseArea {

QuickGraphLib/GraphItems/Grid.qml

@@ -10,6 +10,8 @@ import QuickGraphLib.GraphItems as QGLGraphItems
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::Shapes::ShapePath
     \brief Displays a grid in the background of a graph.
+
+    \sa {Basic sin graph (without prefabs)}
 */
 
 QQS.ShapePath {

QuickGraphLib/GraphItems/Histogram.qml

@@ -10,6 +10,8 @@ import QuickGraphLib.GraphItems as QGLGraphItems
     \inqmlmodule QuickGraphLib.GraphItems
     \inherits QtQuick::Shapes::ShapePath
     \brief Displays a histogram.
+
+    \sa {Basic histogram}
 */
 
 QQS.ShapePath {

QuickGraphLib/GraphItems/Line.qml

@@ -13,19 +13,7 @@ import QuickGraphLib as QuickGraphLib
 
     Graph a line using a list of X,Y points. The style of the line can be adjusted using the \l {ShapePath::strokeColor} {strokeColor} and \l {ShapePath::strokeWidth} {strokeWidth} properties.
 
-    \qml
-        GraphArea {
-            id: grapharea
-            viewRect: Qt.rect(-20, -1.1, 760, 2.2)
-
-            Line {
-                dataTransform: grapharea.dataTransform
-                path: Helpers.linspace(0, 720, 100).map(x => Qt.point(x, Math.sin(x / 180 * Math.PI)))
-                strokeColor: "red"
-                strokeWidth: 2
-            }
-        }
-    \endqml
+    \sa {Basic sin graph}
 */
 
 QQS.ShapePath {

QuickGraphLib/GraphItems/Marker.qml

@@ -10,6 +10,8 @@ import QtQuick
     \brief Displays a circular marker.
 
     \note This graph item does not inherit from ShapePath, unlike other graph items. This is for performance reasons.
+
+    \sa {Scatter graph}
 */
 
 Rectangle {

QuickGraphLib/ImageView.cpp

@@ -13,6 +13,8 @@
     \inqmlmodule QuickGraphLib
     \inherits QtQuick::Item
     \brief Display a colorized image from a 2D array.
+
+    \sa {Builtin color maps}, {Color mapped images}, {Image alignment}
 */
 
 /*!

QuickGraphLib/PreFabs/ImageAxes.qml

@@ -11,6 +11,8 @@ import QuickGraphLib.GraphItems as QGLGraphItems
     \inqmlmodule QuickGraphLib.PreFabs
     \inherits QuickGraphLib::AntialiasingContainer
     \brief Displays an image with axes and a colorbar.
+
+    \sa {Color mesh}
 */
 
 QuickGraphLib.AntialiasingContainer {

QuickGraphLib/PreFabs/XYAxes.qml

@@ -11,6 +11,8 @@ import QuickGraphLib.GraphItems as QGLGraphItems
     \inqmlmodule QuickGraphLib.PreFabs
     \inherits QuickGraphLib::AntialiasingContainer
     \brief Displays an XY axis with a grid.
+
+    \sa {Basic sin graph}, {Dark theme sin graph}, {Subgraphs}
 */
 
 QuickGraphLib.AntialiasingContainer {

QuickGraphLib/ScalingContainer.qml

@@ -10,6 +10,8 @@ import QtQuick
     \brief Scales its contents while preserving the aspect ratio.
 
     This container applies a scaling factor to its content item that preserves its aspect ratio.
+
+    \sa {Scaled graph}
 */
 
 AntialiasingContainer {

QuickGraphLib/ShapeRepeater.qml

@@ -9,6 +9,8 @@ import QtQuick.Shapes as QQS
     \inqmlmodule QuickGraphLib
     \inherits QtQml::Models::Instantiator
     \brief A \l{Repeater}-like component that works with \l{ShapePath}s.
+
+    \sa {Scatter graph}
 */
 
 QQM.Instantiator {

QuickGraphLib/TickLabel.qml

@@ -11,6 +11,8 @@ import QtQuick
 
     This is the default implementation of a tick label. To customise how labels are shown,
     you can subclass this and override the \l Text::text property.
+
+    \sa {Axis}
 */
 
 Text {

QuickGraphLib/ZoomPanHandler.qml

@@ -8,6 +8,8 @@ import QtQuick
     \inqmlmodule QuickGraphLib
     \inherits QtQuick::PinchArea
     \brief Pinch/drag handling for graph or image zoom/pan interactions.
+
+    \sa {Zoomable as image}, {Zoomable axes}
 */
 
 PinchArea {

docs/style.css

@@ -68,7 +68,7 @@ pre {
     background-color: #222;
     padding: 1em;
     color: white;
-    overflow-x: scroll;
+    overflow-x: auto;
     font-size: 0.9em;
 }